|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jgroups.stack.Protocol
org.jgroups.stack.ProtocolStack
public class ProtocolStack
A ProtocolStack manages a number of protocols layered above each other. It creates all protocol classes, initializes them and, when ready, starts all of them, beginning with the bottom most protocol. It also dispatches messages received from the stack to registered objects (e.g. channel, GMP) and sends messages sent by those objects down the stack.
The ProtocolStack makes use of the Configurator to setup and initialize stacks, and to destroy them again when not needed anymore
Field Summary | |
---|---|
static int |
ABOVE
|
static int |
BELOW
|
Fields inherited from class org.jgroups.stack.Protocol |
---|
down_prot, log, props, stack, stats, up_prot |
Constructor Summary | |
---|---|
ProtocolStack()
Only used by Simulator; don't use |
|
ProtocolStack(JChannel channel,
java.lang.String setup_string)
|
Method Summary | |
---|---|
Protocol |
createProtocol(java.lang.String prot_spec)
Creates a new protocol given the protocol specification. |
void |
destroy()
This method is called on a Channel.close() . |
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()
|
java.util.Map<java.lang.String,java.lang.Object> |
dumpStats(java.lang.String protocol_name)
|
java.lang.String |
dumpTimerQueue()
Deprecated. Use TP.getTimer() instead to fetch the timer from the
transport and then invoke the method on it |
Protocol |
findProtocol(java.lang.Class<?> clazz)
|
Protocol |
findProtocol(java.lang.String name)
Returns a given protocol or null if not found |
void |
flushEvents()
Deprecated. |
Channel |
getChannel()
|
java.util.Map<java.lang.Thread,java.util.concurrent.locks.ReentrantLock> |
getLocks()
|
java.lang.String |
getName()
|
java.util.Vector<Protocol> |
getProtocols()
Returns all protocols in a list, from top to bottom. |
static java.util.concurrent.ConcurrentMap<java.lang.String,Tuple<TP,java.lang.Short>> |
getSingletonTransports()
|
ThreadFactory |
getThreadFactory()
Deprecated. Use Protocol.getThreadFactory() instead |
static ThreadFactory |
getTimerThreadFactory()
Deprecated. |
int |
getTimerThreads()
Deprecated. Use TP.getTimer() to fetch the timer and call getCorePoolSize() directly |
TP |
getTransport()
Returns the bottom most protocol |
void |
insertProtocol(Protocol prot,
int position,
java.lang.Class<? extends Protocol> neighbor_prot)
|
void |
insertProtocol(Protocol prot,
int position,
java.lang.String neighbor_prot)
Inserts an already created (and initialized) protocol into the protocol list. |
java.lang.String |
printProtocolSpec(boolean include_properties)
Prints the names of the protocols, from the bottom to top. |
java.lang.String |
printProtocolSpecAsPlainString()
|
java.lang.String |
printProtocolSpecAsXML()
|
java.lang.Object |
receive(long timeout)
|
Protocol |
removeProtocol(java.lang.String prot_name)
Removes a protocol from the stack. |
void |
send(Message msg)
|
void |
setThreadFactory(ThreadFactory f)
Deprecated. Use Protocol.getThreadFactory() instead |
static void |
setTimerThreadFactory(ThreadFactory f)
Deprecated. Use TP.setTimerThreadFactory(org.jgroups.util.ThreadFactory) instead |
void |
setup()
|
void |
startStack(java.lang.String cluster_name)
Start all layers. |
void |
stopStack(java.lang.String cluster_name)
Iterates through all the protocols from top to bottom and does the following: Waits until all messages in the down queue have been flushed (ie., size is 0) Calls stop() on the protocol |
java.lang.Object |
up(Event evt)
An event was received from the layer below. |
Methods inherited from class org.jgroups.stack.Protocol |
---|
downThreadEnabled, enableStats, getDownProtocol, getProperties, getProtocolStack, getUpProtocol, init, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStats, setDownProtocol, setProperties, 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 |
Field Detail |
---|
public static final int ABOVE
public static final int BELOW
Constructor Detail |
---|
public ProtocolStack(JChannel channel, java.lang.String setup_string) throws ChannelException
ChannelException
public ProtocolStack() throws ChannelException
ChannelException
Method Detail |
---|
public ThreadFactory getThreadFactory()
Protocol.getThreadFactory()
instead
Protocol
getThreadFactory
in class Protocol
@Deprecated public static ThreadFactory getTimerThreadFactory()
public void setThreadFactory(ThreadFactory f)
Protocol.getThreadFactory()
instead
f
- public static void setTimerThreadFactory(ThreadFactory f)
TP.setTimerThreadFactory(org.jgroups.util.ThreadFactory)
instead
f
- public java.util.Map<java.lang.Thread,java.util.concurrent.locks.ReentrantLock> getLocks()
public Channel getChannel()
public int getTimerThreads()
TP.getTimer()
to fetch the timer and call getCorePoolSize() directly
public java.util.Vector<Protocol> getProtocols()
public TP getTransport()
getTransport
in class Protocol
public static java.util.concurrent.ConcurrentMap<java.lang.String,Tuple<TP,java.lang.Short>> getSingletonTransports()
public java.util.Map<java.lang.String,java.lang.Object> dumpStats()
dumpStats
in class Protocol
public java.util.Map<java.lang.String,java.lang.Object> dumpStats(java.lang.String protocol_name)
public java.lang.String dumpTimerQueue()
TP.getTimer()
instead to fetch the timer from the
transport and then invoke the method on it
public java.lang.String printProtocolSpec(boolean include_properties)
public java.lang.String printProtocolSpecAsXML()
public java.lang.String printProtocolSpecAsPlainString()
public void setup() throws java.lang.Exception
java.lang.Exception
public Protocol createProtocol(java.lang.String prot_spec) throws java.lang.Exception
prot_spec
- The specification of the protocol. Same convention as for specifying a protocol stack.
An exception will be thrown if the class cannot be created. Example:
"VERIFY_SUSPECT(timeout=1500)"Note that no colons (:) have to be specified
java.lang.Exception
- Will be thrown when the new protocol cannot be createdpublic void insertProtocol(Protocol prot, int position, java.lang.String neighbor_prot) throws java.lang.Exception
prot
- The protocol to be inserted. Before insertion, a sanity check will ensure that none
of the existing protocols have the same name as the new protocol.position
- Where to place the protocol with respect to the neighbor_prot (ABOVE, BELOW)neighbor_prot
- The name of the neighbor protocol. An exception will be thrown if this name
is not found
java.lang.Exception
- Will be thrown when the new protocol cannot be created, or inserted.public void insertProtocol(Protocol prot, int position, java.lang.Class<? extends Protocol> neighbor_prot) throws java.lang.Exception
java.lang.Exception
public Protocol removeProtocol(java.lang.String prot_name) throws java.lang.Exception
prot_name
- The name of the protocol. Since all protocol names in a stack have to be unique
(otherwise the stack won't be created), the name refers to just 1 protocol.
java.lang.Exception
- Thrown if the protocol cannot be stopped correctly.public Protocol findProtocol(java.lang.String name)
public Protocol findProtocol(java.lang.Class<?> clazz)
public void destroy()
Protocol
Channel.close()
.
Does some cleanup; after the call the VM will terminate
destroy
in class Protocol
public void startStack(java.lang.String cluster_name) throws java.lang.Exception
Protocol.start()
method is called in each protocol,
from top to bottom.
Each layer can perform some initialization, e.g. create a multicast socket
java.lang.Exception
public void stopStack(java.lang.String cluster_name)
public void flushEvents()
public void send(Message msg) throws java.lang.Exception
send
in interface Transport
java.lang.Exception
public java.lang.Object receive(long timeout) throws java.lang.Exception
receive
in interface Transport
java.lang.Exception
public java.lang.String getName()
getName
in class Protocol
public java.lang.Object up(Event evt)
Protocol
down_prot.down()
or c) the event (or another event) is sent up
the stack using up_prot.up()
.
up
in class Protocol
public java.lang.Object down(Event evt)
Protocol
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()
.
down
in class Protocol
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |