Package org.jgroups.protocols.pbcast
Class FLUSH
java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.pbcast.FLUSH
Flush, as it name implies, forces group members to flush their pending
messages while blocking them to send any additional messages. The process of
flushing acquiesces the group so that state transfer or a join can be done.
It is also called stop-the-world model as nobody will be able to send
messages while a flush is in process.
Flush is needed for:
(1) State transfer. When a member requests state transfer, the coordinator tells everyone to stop sending messages and waits for everyone's ack. Then it asks the application for its state and ships it back to the requester. After the requester has received and set the state successfully, the coordinator tells everyone to resume sending messages.
(2) View changes (e.g.a join). Before installing a new view V2, flushing would ensure that all messages *sent* in the current view V1 are indeed *delivered* in V1, rather than in V2 (in all non-faulty members). This is essentially Virtual Synchrony.
- Since:
- 2.4
- Version:
- $Id$
- Author:
- Vladimir Blagojevic
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAn event is to be sent down the stack.double
getName()
int
long
long
List of events that are provided to layers below (they will be handled when sent down from below).boolean
setProperties
(Properties props) Configures the protocol initially.void
setStartFlushTimeout
(long start_flush_timeout) void
start()
This method is called on aChannel.connect(String)
.boolean
void
stop()
This method is called on aChannel.disconnect()
.void
An event was received from the layer below.Methods inherited from class org.jgroups.stack.Protocol
destroy, downThreadEnabled, dumpStats, enableStats, getDownProtocol, getProperties, getProtocolStack, getThreadFactory, getTransport, getUpProtocol, init, printStats, providedUpServices, requiredDownServices, requiredUpServices, resetStats, setDownProtocol, setPropertiesInternal, setProtocolStack, setUpProtocol, statsEnabled, upThreadEnabled
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
FLUSH
public FLUSH()
-
-
Method Details
-
getName
-
getStartFlushTimeout
public long getStartFlushTimeout() -
setStartFlushTimeout
public void setStartFlushTimeout(long start_flush_timeout) -
setProperties
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 classProtocol
-
start
Description copied from class:Protocol
This method is called on aChannel.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.- Overrides:
start
in classProtocol
- Throws:
Exception
- Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, soChannel.connect(String)
will throw an exception
-
stop
public void stop()Description copied from class:Protocol
This method is called on aChannel.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 -
getAverageFlushDuration
public double getAverageFlushDuration() -
getTotalTimeInFlush
public long getTotalTimeInFlush() -
getNumberOfFlushes
public int getNumberOfFlushes() -
startFlush
public boolean startFlush() -
stopFlush
public void stopFlush() -
down
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 usingdown_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 usingup_prot.up()
. -
up
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 usingdown_prot.down()
or c) the event (or another event) is sent up the stack usingup_prot.up()
. -
providedDownServices
Description copied from class:Protocol
List of events that are provided to layers below (they will be handled when sent down from below).- Overrides:
providedDownServices
in classProtocol
- Returns:
- Vectorinvalid input: '<'Integer (of Integers)
-