JavaGroups.JavaStack.Protocols
Class FLUSH

java.lang.Object
  |
  +--JavaGroups.JavaStack.Protocol
        |
        +--JavaGroups.JavaStack.MessageProtocol
              |
              +--JavaGroups.JavaStack.RpcProtocol
                    |
                    +--JavaGroups.JavaStack.Protocols.FLUSH

public class FLUSH

extends RpcProtocol

The task of the FLUSH protocol is to flush all pending messages out of the system. This is done before a view change by stopping all senders and then agreeing on what messages should be delivered in the current view (before switching to the new view). A coordinator broadcasts a FLUSH message. The message contains an array of the highest sequence number for each member as seen by the coordinator so far. Each member responds with its highest sequence numbers seen so far (for each member): if its sequence number for a member P is higher than the one sent by the coordinator, it will append the messages apparently not received by the coordinator to its reply. The coordinator (when all replies have been received), computes for each member the lowest and highest sequence number and re-broadcasts messages accordingly (using ACKs rather then NAKs to ensure reliable delivery).

Example:

FLUSH  ---> (p=10, q=22, r=7)

<-- (p=10, q=20, r=7)    (did not receive 2 messages from q)
<-- (p=12, q=23, r=7)    (attached are messages p11, p12, and q23)
<-- (p=10, q=22, r=8)    (attached is message r8)
---------------------
min:   11    21    8
max:   12    23    8

The coordinator now computes the range for each member and re-broadcasts messages p11, p12, q21, q22, q23 and r8. This is essentially the exclusive min and inclusive max of all replies. Note that messages p11, p12 and q23 were not received by the coordinator itself before. They were only returned as result of the FLUSH replies and the coordinator now re-broadcasts them.

Constructor Summary

FLUSH()

Method Summary

java.lang.String	GetName()
boolean	HandleDownEvent(Event evt) Callback.
Digest	HandleFlush(long[] highest_seqnos) Called by coordinator running the FLUSH protocol.
boolean	HandleUpEvent(Event evt) Callback.
java.util.Vector	ProvidedUpServices() List of events that are provided to layers above (they will be handled when sent down from above).
void	ReceiveDownEvent(Event evt) The default handling adds the event to the down-queue where events are handled in order of addition by a thread.
java.util.Vector	RequiredDownServices() List of events that are required to be answered by some layer below.
boolean	SetProperties(java.util.Properties props) Configures the protocol initially.

Methods inherited from class JavaGroups.JavaStack.RpcProtocol

CallRemoteMethod, CallRemoteMethod, CallRemoteMethod, CallRemoteMethod, CallRemoteMethod, CallRemoteMethod, CallRemoteMethod, CallRemoteMethods, CallRemoteMethods, CallRemoteMethods, CallRemoteMethods, CallRemoteMethods, CallRemoteMethods, CallRemoteMethods, Handle

Methods inherited from class JavaGroups.JavaStack.MessageProtocol

CastMessage, Down, SendMessage, Up

Methods inherited from class JavaGroups.JavaStack.Protocol

GetDownProtocol, GetProperties, GetUpProtocol, PassDown, PassUp, ProvidedDownServices, RequiredUpServices, Reset, SetDownProtocol, SetProtocolStack, SetUpProtocol, StartDownHandler, StartUpHandler, StopInternal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FLUSH

public FLUSH()

Method Detail

GetName

public java.lang.String GetName()

Overrides:

GetName in class RpcProtocol

ProvidedUpServices

public java.util.Vector ProvidedUpServices()

Description copied from class: Protocol

List of events that are provided to layers above (they will be handled when sent down from above).

Overrides:

ProvidedUpServices in class Protocol

Tags copied from class: Protocol

Returns:

Vector (of Integers)

RequiredDownServices

public java.util.Vector RequiredDownServices()

Description copied from class: Protocol

List of events that are required to be answered by some layer below.

Overrides:

RequiredDownServices in class Protocol

Tags copied from class: Protocol

Returns:

Vector (of Integers)

HandleFlush

public Digest HandleFlush(long[] highest_seqnos)

Called by coordinator running the FLUSH protocol. Argument is an array of the highest seqnos as seen by the coordinator (for each member). HandleFlush() checks for each member its own highest seqno seen for that member. If it is higher than the one seen by the coordinator, all higher messages are attached to the return value (a message digest).

Parameters:

highest_seqnos - The highest sequence numbers (order corresponding to membership) as seen by coordinator.

Returns:

Digest An array of the highest seqnos for each member, as seen by this member. If this member's seqno for a member P is higher than the one in highest_seqnos, the missing messages are added to the message digest as well. This allows the coordinator to re-broadcast missing messages.

HandleUpEvent

public boolean HandleUpEvent(Event evt)

Callback. Called by superclass when event may be handled.

Do not use PassUp in this method as the event is passed up by default by the superclass after this method returns !

Overrides:

HandleUpEvent in class RpcProtocol

Returns:

boolean Defaults to true. If false, event will not be passed up the stack.

HandleDownEvent

public boolean HandleDownEvent(Event evt)

Callback. Called by superclass when event may be handled.

Do not use PassDown in this method as the event is passed down by default by the superclass after this method returns !

Overrides:

HandleDownEvent in class RpcProtocol

Returns:

boolean Defaults to true. If false, event will not be passed down the stack.

ReceiveDownEvent

public void ReceiveDownEvent(Event evt)

The default handling adds the event to the down-queue where events are handled in order of addition by a thread. However, there exists a deadlock between the FLUSH and BLOCK_OK down events: when a FLUSH event is received, a BLOCK is sent up, which triggers a BLOCK_OK event to be sent down to be handled by the FLUSH layer. However, the FLUSH layer's thread is still processing the FLUSH down event and is therefore blocked, waiting for a BLOCK_OK event. Therefore, the BLOCK_OK event has to 'preempt' the FLUSH event processing. This is done by overriding this method: when a BLOCK_OK event is received, it is processed immediately (in parallel to the FLUSH event), which causes the FLUSH event processing to return.

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