Package org.jgroups.protocols

Class PERF

java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.PERF
All Implemented Interfaces:
Lifecycle
public class PERF extends Protocol
Protocol measuring latency between stacks. On down(org.jgroups.Message), a header is added to the message with the ID of the PERF protocol, and the start time is set in the header. On up(org.jgroups.Message), the time difference is computed and a rolling average is updated in PERF.

Note that we can have several measurements by inserting PERF protocols with different IDs (Protocol.id) into the stack.

If PERF is used to measure latency between nodes running on different physical boxes, it is important that the clocks are synchronized, or else latency cannot be computed correctly (and may even be negative).

Since:
3.5

  • Field Details

    • avg

      protected Average avg

    • avg_size

      protected int avg_size

  • Constructor Details

    • PERF

      public PERF()

  • Method Details

    • latencyInNs

      public double latencyInNs()

    • latencyInMs

      public double latencyInMs()

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

    • resetStats

      public void resetStats()
      Overrides:
      resetStats 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

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

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