Package org.jgroups.protocols

Class RATE

java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.RATE
All Implemented Interfaces:
Lifecycle
public class RATE extends Protocol
Measures incoming and outgoing rates: messages/sec, bytes/sec. This is done per destination and total.
Since:
5.3.5

  • Field Details

    • measure_serialized_size

      protected boolean measure_serialized_size

    • interval

      protected long interval

    • history_size

      protected int history_size

    • current_send_rate

      protected volatile long current_send_rate

    • highest_send_rate

      protected volatile long highest_send_rate

    • current_receive_rate

      protected volatile long current_receive_rate

    • highest_receive_rate

      protected volatile long highest_receive_rate

    • out

      protected final LongAdder out

    • in

      protected final LongAdder in

    • send_history

      protected BoundedList<Long> send_history

    • recv_history

      protected BoundedList<Long> recv_history

    • timer

      protected TimeScheduler timer

    • f

      protected Future<?> f

    • task

      protected final Runnable task

  • Constructor Details

    • RATE

      public RATE()

  • Method Details

    • measureSerializedSize

      public boolean measureSerializedSize()

    • measureSerializedSize

      public RATE measureSerializedSize(boolean b)

    • interval

      public long interval()

    • interval

      public RATE interval(long i)

    • currentSendRate

      public String currentSendRate()

    • highestSendRate

      public String highestSendRate()

    • currentReceiveRate

      public String currentReceiveRate()

    • highestReceiveRate

      public String highestReceiveRate()

    • 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

    • start

      public void start() throws Exception
      Description copied from class: Protocol
      This method is called on a JChannel.connect(String); starts work. Protocols are connected ready to receive events. Will be called from bottom to top.
      Specified by:
      start in interface Lifecycle
      Overrides:
      start in class Protocol
      Throws:
      Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so JChannel.connect(String) will throw an exception

    • stop

      public void stop()
      Description copied from class: Protocol
      Called on a JChannel.disconnect(); stops work (e.g. by closing multicast socket). Will be called from top to bottom.
      Specified by:
      stop in interface Lifecycle
      Overrides:
      stop 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

    • resetStats

      public void resetStats()
      Overrides:
      resetStats in class Protocol

    • printSendHistory

      public String printSendHistory()

    • printReceiveHistory

      public String printReceiveHistory()

    • size

      protected long size(Message msg)

    • size

      protected long size(MessageBatch batch)