org.jgroups.protocols

Class SEQUENCER

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.SEQUENCER

public class SEQUENCER
extends Protocol

Implementation of total order protocol using a sequencer. Consult doc/design/SEQUENCER.txt for details

Version:

$Id: SEQUENCER.java,v 1.20 2007/10/24 09:01:11 belaban Exp $

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SEQUENCER.SequencerHeader

Field Summary

Fields inherited from class org.jgroups.stack.Protocol

down_prot, log, props, stack, stats, up_prot

Constructor Summary

Constructors

Constructor and Description
SEQUENCER()

Method Summary

Methods

Modifier and Type	Method and Description
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()
long	getBroadcast()
Address	getCoordinator()
long	getForwarded()
Address	getLocalAddress()
java.lang.String	getName()
long	getReceivedBroadcasts()
long	getReceivedForwards()
boolean	isCoordinator()
java.lang.String	printStats()
void	resetStats()
boolean	setProperties(java.util.Properties props) Configures the protocol initially.
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, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, setDownProtocol, setPropertiesInternal, setProtocolStack, setUpProtocol, start, statsEnabled, stop, upThreadEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

SEQUENCER

public SEQUENCER()

Method Detail

isCoordinator

public boolean isCoordinator()

getCoordinator

public Address getCoordinator()

getLocalAddress

public Address getLocalAddress()

getName

public java.lang.String getName()

Specified by:

getName in class Protocol

getForwarded

public long getForwarded()

getBroadcast

public long getBroadcast()

getReceivedForwards

public long getReceivedForwards()

getReceivedBroadcasts

public long getReceivedBroadcasts()

resetStats

public void resetStats()

Overrides:

resetStats in class Protocol

dumpStats

public java.util.Map<java.lang.String,java.lang.Object> dumpStats()

Overrides:

dumpStats in class Protocol

printStats

public java.lang.String printStats()

Overrides:

printStats 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 java.lang.Object 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 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().

Overrides:

down in class Protocol

up

public java.lang.Object 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 down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().

Overrides:

up in class Protocol