Package org.jgroups.blocks

Class MessageDispatcher.ProtocolAdapter

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.blocks.MessageDispatcher.ProtocolAdapter

All Implemented Interfaces:

Lifecycle, UpHandler

Enclosing class:

MessageDispatcher

protected class MessageDispatcher.ProtocolAdapter
extends Protocol
implements UpHandler

Field Summary

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProtocolAdapter()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	down(Event evt)	An event is to be sent down the stack.
java.lang.Object	down(Message msg)	A message is sent down the stack.
java.lang.String	getName()
<T extends Protocol> T	setAddress(Address addr)
<T extends Protocol> T	setDownProt(Protocol d)
UpHandler	setLocalAddress(Address a)
java.lang.Object	up(Event evt)	Called by channel (we registered before) when event is received.
java.lang.Object	up(Message msg)	A single message was received.
void	up(MessageBatch batch)	Sends up a multiple messages in a MessageBatch.

Methods inherited from class org.jgroups.stack.Protocol

accept, addPolicy, addr, addr, afterCreationHook, destroy, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, init, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, start, statsEnabled, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolAdapter

protected ProtocolAdapter()

Method Detail

getName

public java.lang.String getName()

Overrides:

getName in class Protocol

setDownProt

public <T extends Protocol> T setDownProt(Protocol d)

setAddress

public <T extends Protocol> T setAddress(Address addr)

Overrides:

setAddress in class Protocol

setLocalAddress

public UpHandler setLocalAddress(Address a)

Specified by:

setLocalAddress in interface UpHandler

up

public java.lang.Object up(Event evt)

Called by channel (we registered before) when event is received. This is the UpHandler interface.

Specified by:

up in interface UpHandler

Overrides:

up in class Protocol

up

public java.lang.Object up(Message msg)

Description copied from class: Protocol

A single message was received. Protocols may examine the message and do something (e.g. add a header) with it before passing it up.

Specified by:

up in interface UpHandler

Overrides:

up in class Protocol

up

public void up(MessageBatch batch)

Description copied from class: Protocol

Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.

The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(Message)), and - if true - calls Protocol.up(org.jgroups.Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.

Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.iterator(Predicate)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.

Specified by:

up in interface UpHandler

Overrides:

up in class Protocol

Parameters:

batch - The message batch

down

public java.lang.Object down(Event evt)

Description copied from class: Protocol

An event is to be sent down the stack. A protocol 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 protocol may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down().

Overrides:

down in class Protocol

down

public java.lang.Object down(Message msg)

Description copied from class: Protocol

A message is sent down the stack. Protocols may examine the message and do something (e.g. add a header) with it, before passing it down.

Overrides:

down in class Protocol