ForkProtocol

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.fork.ForkProtocol

All Implemented Interfaces:: Lifecycle

public class ForkProtocol extends Protocol

Acts as bottom protocol of a fork-stack. Knows about the fork-stack-id and inserts it into the ForkHeader of messages sent down the stack

Since:: 3.4

Field Summary

Fields

Modifier and Type

Field

Description

protected final String

fork_stack_id

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

Constructor

Description

ForkProtocol(String fork_stack_id)
Method Summary

Modifier and Type

Method

Description

Object

down(Event evt)

An event is to be sent down the stack.

Object

down(Message msg)

A message is sent down the stack.

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- fork_stack_id
  
  protected final String fork_stack_id
Constructor Details
- ForkProtocol
  
  public ForkProtocol(String fork_stack_id)
Method Details
- 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 Protocol
- 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 Protocol