|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jgroups.stack.Protocol
org.jgroups.protocols.SFC
public class SFC
Simple flow control protocol. After max_credits bytes sent to the group (or an individual member), the sender blocks
until it receives an ack from all members that they indeed received max_credits bytes.
Design in doc/design/SimpleFlowControl.txt
Note that SFC supports only flow control for multicast messages; unicast flow control is not supported ! Use FC if
unicast flow control is required.
Nested Class Summary | |
---|---|
static class |
SFC.Header
|
Field Summary |
---|
Fields inherited from class org.jgroups.stack.Protocol |
---|
down_prot, log, props, stack, stats, up_prot |
Constructor Summary | |
---|---|
SFC()
|
Method Summary | |
---|---|
java.lang.Object |
down(Event evt)
An event is to be sent down the stack. |
java.util.Map<java.lang.String,java.lang.Object> |
dumpStats()
|
double |
getAverageBlockingTime()
|
long |
getBlockings()
|
long |
getBytesSent()
|
long |
getCreditRequestsReceived()
|
long |
getCreditRequestsSent()
|
long |
getCredits()
|
long |
getMaxCredits()
|
java.lang.String |
getName()
|
long |
getReplenishmentsReceived()
|
long |
getReplenishmentsSent()
|
long |
getTotalBlockingTime()
|
java.lang.String |
printBlockingTimes()
|
java.lang.String |
printPendingCreditors()
|
java.lang.String |
printPendingRequesters()
|
java.lang.String |
printReceived()
|
void |
resetStats()
|
boolean |
setProperties(java.util.Properties props)
Configures the protocol initially. |
void |
start()
This method is called on a Channel.connect(String) . |
void |
stop()
This method is called on a Channel.disconnect() . |
void |
unblock()
|
java.lang.Object |
up(Event evt)
An event was received from the layer below. |
Methods inherited from class org.jgroups.stack.Protocol |
---|
destroy, downThreadEnabled, enableStats, getDownProtocol, getProperties, getProtocolStack, getThreadFactory, getTransport, getUpProtocol, init, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, setDownProtocol, setPropertiesInternal, setProtocolStack, setUpProtocol, statsEnabled, upThreadEnabled |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SFC()
Method Detail |
---|
public void resetStats()
resetStats
in class Protocol
public long getMaxCredits()
public long getCredits()
public long getBytesSent()
public long getBlockings()
public long getCreditRequestsSent()
public long getCreditRequestsReceived()
public long getReplenishmentsReceived()
public long getReplenishmentsSent()
public long getTotalBlockingTime()
public double getAverageBlockingTime()
public java.util.Map<java.lang.String,java.lang.Object> dumpStats()
dumpStats
in class Protocol
public java.lang.String printBlockingTimes()
public java.lang.String printReceived()
public java.lang.String printPendingCreditors()
public java.lang.String printPendingRequesters()
public void unblock()
public final java.lang.String getName()
getName
in class Protocol
public boolean setProperties(java.util.Properties props)
Protocol
"loopback=false;unicast_inport=4444"
setProperties
in class Protocol
public java.lang.Object down(Event evt)
Protocol
down_prot.down()
. 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 up_prot.up()
.
down
in class Protocol
public java.lang.Object up(Event evt)
Protocol
down_prot.down()
or c) the event (or another event) is sent up
the stack using up_prot.up()
.
up
in class Protocol
public void start() throws java.lang.Exception
Protocol
Channel.connect(String)
. Starts work.
Protocols are connected and queues are ready to receive events.
Will be called from bottom to top. This call will replace
the START and START_OK events.
start
in class Protocol
java.lang.Exception
- Thrown if protocol cannot be started successfully. This will cause the ProtocolStack
to fail, so Channel.connect(String)
will throw an exceptionpublic void stop()
Protocol
Channel.disconnect()
. Stops work (e.g. by closing multicast socket).
Will be called from top to bottom. This means that at the time of the method invocation the
neighbor protocol below is still working. This method will replace the
STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that
when this method is called all messages in the down queue will have been flushed
stop
in class Protocol
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |