Package org.jgroups.fork

Class ForkProtocolStack

java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.stack.ProtocolStack
org.jgroups.fork.ForkProtocolStack
All Implemented Interfaces:
Lifecycle
public class ForkProtocolStack extends ProtocolStack
Protocol stack which maintains the mapping between fork-channel IDs and ForkChannels
Since:
3.4

  • Field Details

    • fork_stack_id

      protected final String fork_stack_id

    • fork_channels

      protected final ConcurrentMap<String,JChannel> fork_channels

    • unknownForkHandler

      protected UnknownForkHandler unknownForkHandler

    • protocols

      protected final List<Protocol> protocols

    • inits

      protected int inits

    • connects

      protected int connects

  • Constructor Details

  • Method Details

    • getForkChannels

      public ConcurrentMap<String,JChannel> getForkChannels()

    • get

      public JChannel get(String fork_channel_id)

    • putIfAbsent

      public JChannel putIfAbsent(String id, JChannel fc)

    • remove

      public void remove(String fork_channel_id)

    • getInits

      public int getInits()

    • getConnects

      public int getConnects()

    • setUnknownForkHandler

      public void setUnknownForkHandler(UnknownForkHandler ufh)

    • getUnknownForkHandler

      public UnknownForkHandler getUnknownForkHandler()

    • down

      public 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 ProtocolStack

    • down

      public 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 ProtocolStack

    • setLocalAddress

      public void setLocalAddress(Address addr)

    • getProtocols

      public List<Protocol> getProtocols()
      Description copied from class: ProtocolStack
      Returns all protocols in a list, from top to bottom. These are not copies of protocols, so modifications will affect the actual instances !
      Overrides:
      getProtocols in class ProtocolStack

    • incrInits

      public ForkProtocolStack incrInits()

    • init

      public void init() throws Exception
      Description copied from class: Protocol
      Called after a protocol has been created and before the protocol is started. Attributes are already set. Other protocols are not yet connected and events cannot yet be sent.
      Specified by:
      init in interface Lifecycle
      Overrides:
      init in class ProtocolStack
      Throws:
      Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the the channel constructor will throw an exception

    • startStack

      public void startStack() throws Exception
      Description copied from class: ProtocolStack
      Start all protocols. The Protocol.start() method is called in each protocol, from bottom to top. Each protocol can perform some initialization, e.g. create a multicast socket
      Overrides:
      startStack in class ProtocolStack
      Throws:
      Exception

    • stopStack

      public void stopStack(String cluster)
      Description copied from class: ProtocolStack
      Iterates through all the protocols from top to bottom and does the following:
      1. Waits until all messages in the down queue have been flushed (ie., size is 0)
      2. Calls stop() on the protocol
      Overrides:
      stopStack in class ProtocolStack

    • destroy

      public void destroy()
      Description copied from class: Protocol
      This method is called on a JChannel.close(). Does some cleanup; after the call, the VM will terminate
      Specified by:
      destroy in interface Lifecycle
      Overrides:
      destroy in class ProtocolStack

    • up

      public Object up(Event evt)
      Description copied from class: Protocol
      An event was received from the protocol below. Usually the current protocol 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 ProtocolStack

    • up

      public 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.
      Overrides:
      up in class ProtocolStack

    • 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.

      Overrides:
      up in class ProtocolStack
      Parameters:
      batch - The message batch