org.jgroups.protocols
Class FC
java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.FC
- public class FC
- extends Protocol
Simple flow control protocol based on a credit system. Each sender has a number of credits (bytes
to send). When the credits have been exhausted, the sender blocks. Each receiver also keeps track of
how many credits it has received from a sender. When credits for a sender fall below a threshold,
the receiver sends more credits to the sender. Works for both unicast and multicast messages.
Note that this protocol must be located towards the top of the stack, or all down_threads from JChannel to this
protocol must be set to false ! This is in order to block JChannel.send()/JChannel.down().
- Version:
- $Revision: 1.12 $
- Author:
- Bela Ban
Fields inherited from class org.jgroups.stack.Protocol |
down_handler, down_prot, down_queue, down_thread, down_thread_prio, log, observer, props, stack, up_handler, up_prot, up_queue, up_thread, up_thread_prio |
Method Summary |
void |
down(Event evt)
An event is to be sent down the stack. |
java.lang.String |
getName()
|
boolean |
setProperties(java.util.Properties props)
Configures the protocol initially. |
void |
up(Event evt)
An event was received from the layer below. |
Methods inherited from class org.jgroups.stack.Protocol |
destroy, getDownProtocol, getDownQueue, getProperties, getUpProtocol, getUpQueue, handleSpecialDownEvent, init, passDown, passUp, providedDownServices, providedUpServices, receiveDownEvent, receiveUpEvent, requiredDownServices, requiredUpServices, setDownProtocol, setObserver, setPropertiesInternal, setProtocolStack, setUpProtocol, start, startDownHandler, startUpHandler, stop, stopInternal |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FC
public FC()
getName
public java.lang.String getName()
- Specified by:
getName
in class Protocol
setProperties
public boolean setProperties(java.util.Properties props)
- Description copied from class:
Protocol
- Configures the protocol initially. A configuration string consists of name=value
items, separated by a ';' (semicolon), e.g.:
"loopback=false;unicast_inport=4444"
- Overrides:
setProperties
in class Protocol
down
public void down(Event evt)
- Description copied from class:
Protocol
- An event is to be sent down the stack. The layer may want to examine its type and perform
some action on it, depending on the event's type. If the event is a message MSG, then
the layer may need to add a header to it (or do nothing at all) before sending it down
the stack using
passDown()
. In case of a GET_ADDRESS event (which tries to
retrieve the stack's address from one of the bottom layers), the layer may need to send
a new response event back up the stack using passUp()
.
- Overrides:
down
in class Protocol
up
public void up(Event evt)
- Description copied from class:
Protocol
- An event was received from the layer below. Usually the current layer will want to examine
the event type and - depending on its type - perform some computation
(e.g. removing headers from a MSG event type, or updating the internal membership list
when receiving a VIEW_CHANGE event).
Finally the event is either a) discarded, or b) an event is sent down
the stack using
passDown()
or c) the event (or another event) is sent up
the stack using passUp()
.
- Overrides:
up
in class Protocol
Copyright ? 2001,2002 www.jgroups.com . All Rights Reserved.