com.fr.third.jgroups.protocols

类 FORK

java.lang.Object

com.fr.third.jgroups.stack.Protocol

com.fr.third.jgroups.protocols.FORK

public class FORK
extends Protocol

The FORK protocol; multiplexes messages to different forks in a stack (https://issues.jboss.org/browse/JGRP-1613). See doc/design/FORK.txt for details

从以下版本开始:

3.4

作者:

Bela Ban

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	FORK.ForkHeader

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	config
protected java.util.concurrent.ConcurrentMap<java.lang.String,Protocol>	fork_stacks
static short	ID

从类继承的字段 com.fr.third.jgroups.stack.Protocol

down_prot, ergonomics, id, log, name, stack, stats, up_prot

构造器概要

构造器

构造器和说明
FORK()

方法概要

方法

限定符和类型	方法和说明
Protocol	createForkStack(java.lang.String fork_stack_id, ProtocolStack stack, boolean replace_existing, java.util.List<Protocol> protocols) Creates a new fork-stack from protocols and adds it into the hashmap of fork-stack (key is fork_stack_id).
protected void	createForkStacks(java.util.Map<java.lang.String,java.util.List<ProtocolConfiguration>> protocols, boolean replace_existing)
protected void	createForkStacks(java.lang.String config, boolean replace_existing)
protected static java.util.List<Protocol>	createProtocols(ProtocolStack stack, java.util.List<ProtocolConfiguration> protocol_configs) Creates a fork-stack from the configuration, initializes all protocols (setting values), sets the protocol stack as top protocol, connects the protocols and calls init() on them.
Protocol	get(java.lang.String fork_stack_id)
int	getForkStacks()
static java.io.InputStream	getForkStream(java.lang.String config)
void	init() Called after instance has been created (null constructor) and before protocol is started.
void	parse(org.w3c.dom.Node node) Called by the XML parser when subelements are found in the configuration of a protocol.
Protocol	putIfAbsent(java.lang.String fork_stack_id, Protocol prot)
java.lang.Object	up(Event evt) An event was received from the layer below.
void	up(MessageBatch batch) Sends up a multiple messages in a MessageBatch.

从类继承的方法 com.fr.third.jgroups.stack.Protocol

accept, destroy, down, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, start, statsEnabled, stop

从类继承的方法 java.lang.Object

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

字段详细资料

ID

public static short ID

config

protected java.lang.String config

fork_stacks

protected final java.util.concurrent.ConcurrentMap<java.lang.String,Protocol> fork_stacks

构造器详细资料

FORK

public FORK()

方法详细资料

get

public Protocol get(java.lang.String fork_stack_id)

putIfAbsent

public Protocol putIfAbsent(java.lang.String fork_stack_id,
                   Protocol prot)

getForkStacks

public int getForkStacks()

init

public void init()
          throws java.lang.Exception

从类复制的说明: Protocol

Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.

覆盖:

init 在类中 Protocol

抛出:

java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception

up

public java.lang.Object up(Event evt)

从类复制的说明: 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().

覆盖:

up 在类中 Protocol

up

public void up(MessageBatch batch)

从类复制的说明: 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(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.getMatchingMessages(short, boolean)), 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.

覆盖:

up 在类中 Protocol

参数:

batch - The message batch

createForkStacks

protected void createForkStacks(java.lang.String config,
                    boolean replace_existing)
                         throws java.lang.Exception

抛出:

java.lang.Exception

createForkStacks

protected void createForkStacks(java.util.Map<java.lang.String,java.util.List<ProtocolConfiguration>> protocols,
                    boolean replace_existing)
                         throws java.lang.Exception

抛出:

java.lang.Exception

parse

public void parse(org.w3c.dom.Node node)
           throws java.lang.Exception

从类复制的说明: Protocol

Called by the XML parser when subelements are found in the configuration of a protocol. This allows a protocol to define protocol-specific information and to parse it

覆盖:

parse 在类中 Protocol

抛出:

java.lang.Exception

createForkStack

public Protocol createForkStack(java.lang.String fork_stack_id,
                       ProtocolStack stack,
                       boolean replace_existing,
                       java.util.List<Protocol> protocols)
                         throws java.lang.Exception

Creates a new fork-stack from protocols and adds it into the hashmap of fork-stack (key is fork_stack_id). Method init() will be called on each protocol, from bottom to top.

参数:

fork_stack_id - The key under which the new fork-stack should be added to the fork-stacks hashmap

stack - The protocol stack under which to create the protocols

replace_existing - If true, and existing fork-stack is simply replaced (de-initializing it first). Otherwise, if the stack already exists, the new fork-stack will not be created.

protocols - A list of protocols from bottom to top to be inserted. They will be sandwiched between ForkProtocolStack (top) and ForkProtocol (bottom). The list can be empty (or null) in which case we won't create any protocols, but still have a separate fork-stack inserted.

返回:

The bottom-most protocol of the new stack, or the existing stack (if present)

抛出:

java.lang.Exception

createProtocols

protected static java.util.List<Protocol> createProtocols(ProtocolStack stack,
                                       java.util.List<ProtocolConfiguration> protocol_configs)
                                                   throws java.lang.Exception

Creates a fork-stack from the configuration, initializes all protocols (setting values), sets the protocol stack as top protocol, connects the protocols and calls init() on them. Returns the protocols in a list, from bottom to top

抛出:

java.lang.Exception

getForkStream

public static java.io.InputStream getForkStream(java.lang.String config)
                                         throws java.io.IOException

抛出:

java.io.IOException