Package org.jgroups.protocols

Class SIZE2

  • All Implemented Interfaces:
    Lifecycle
    public class SIZE2
extends Protocol
    Records number of messages sent/received based on size
    Since:
    5.4.9
    Author:
    Bela Ban

    • Field Detail

      • up_sizes

        protected java.lang.String up_sizes

      • down_sizes

        protected java.lang.String down_sizes

      • sizes

        protected java.lang.String sizes

      • use_size

        protected boolean use_size

      • exception_on_missing_bucket

        protected boolean exception_on_missing_bucket

    • Constructor Detail

      • SIZE2

        public SIZE2()

    • Method Detail

      • numDownSamples

        public long numDownSamples()

      • numUpSamples

        public long numUpSamples()

      • init

        public void init()
          throws java.lang.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:
        java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the the channel constructor will throw an exception

      • dumpDownSamples

        public java.lang.String dumpDownSamples()

      • dumpUpSamples

        public java.lang.String dumpUpSamples()

      • dump

        public java.lang.String dump()

      • down

        public java.lang.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

      • down

        public java.util.concurrent.CompletableFuture<java.lang.Object> down​(Message msg,
                                                                     boolean async)
        Description copied from class: Protocol
        Passes a message down asynchronously. The sending is executed in the transport's thread pool. If the pool is full and the message is marked as Message.TransientFlag.DONT_BLOCK, then it will be dropped, otherwise it will be sent on the caller's thread.
        Overrides:
        down in class Protocol
        Parameters:
        msg - The message to be sent
        async - Whether to send the message asynchronously
        Returns:
        A CompletableFuture of the result (or exception)

      • up

        public java.lang.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