org.jgroups.protocols

Class EXAMPLE

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.EXAMPLE

public class EXAMPLE
extends Protocol

Example of a protocol layer. Contains no real functionality, can be used as a template.

Field Summary

Fields inherited from class org.jgroups.stack.Protocol

down_handler, down_prot, down_queue, down_thread, down_thread_prio, log, observer, props, stack, stats, up_handler, up_prot, up_queue, up_thread, up_thread_prio

Constructor Summary

Constructors

Constructor and Description
EXAMPLE()

Method Summary

Methods

Modifier and Type	Method and Description
void	down(Event evt) An event is to be sent down the stack.
java.lang.String	getName() All protocol names have to be unique !
static void	reset() Just remove if you don't need to reset any state
void	up(Event evt) An event was received from the layer below.

Methods inherited from class org.jgroups.stack.Protocol

destroy, downThreadEnabled, dumpStats, enableStats, getDownProtocol, getDownQueue, getProperties, getUpProtocol, getUpQueue, handleSpecialDownEvent, init, passDown, passUp, printStats, providedDownServices, providedUpServices, receiveDownEvent, receiveUpEvent, requiredDownServices, requiredUpServices, resetStats, setDownProtocol, setObserver, setProperties, setPropertiesInternal, setProtocolStack, setUpProtocol, start, startDownHandler, startUpHandler, statsEnabled, stop, stopInternal, upThreadEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

EXAMPLE

public EXAMPLE()

Method Detail

getName

public java.lang.String getName()

All protocol names have to be unique !

Specified by:

getName in class Protocol

reset

public static void reset()

Just remove if you don't need to reset any state

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

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