Class AbstractTrafficShapingHandler

    • Field Detail

      • DEFAULT_CHECK_INTERVAL

        public static final long DEFAULT_CHECK_INTERVAL
        Default delay between two checks: 1s
        See Also:
        Constant Field Values
      • DEFAULT_MAX_TIME

        public static final long DEFAULT_MAX_TIME
        Default max delay in case of traffic shaping (during which no communication will occur). Shall be less than TIMEOUT. Here half of "standard" 30s
        See Also:
        Constant Field Values
      • DEFAULT_MAX_SIZE

        static final long DEFAULT_MAX_SIZE
        Default max size to not exceed in buffer (write only).
        See Also:
        Constant Field Values
      • MINIMAL_WAIT

        static final long MINIMAL_WAIT
        Default minimal time to wait: 10ms
        See Also:
        Constant Field Values
      • trafficCounter

        protected TrafficCounter trafficCounter
        Traffic Counter
      • writeLimit

        private volatile long writeLimit
        Limit in B/s to apply to write
      • readLimit

        private volatile long readLimit
        Limit in B/s to apply to read
      • maxTime

        protected volatile long maxTime
        Max delay in wait
      • checkInterval

        protected volatile long checkInterval
        Delay between two performance snapshots
      • READ_SUSPENDED

        static final AttributeKey<java.lang.Boolean> READ_SUSPENDED
      • REOPEN_TASK

        static final AttributeKey<java.lang.Runnable> REOPEN_TASK
      • maxWriteDelay

        volatile long maxWriteDelay
        Max time to delay before proposing to stop writing new objects from next handlers
      • maxWriteSize

        volatile long maxWriteSize
        Max size in the list before proposing to stop writing new objects from next handlers
      • userDefinedWritabilityIndex

        final int userDefinedWritabilityIndex
        Rank in UserDefinedWritability (1 for Channel, 2 for Global TrafficShapingHandler). Set in final constructor. Must be between 1 and 31
      • CHANNEL_DEFAULT_USER_DEFINED_WRITABILITY_INDEX

        static final int CHANNEL_DEFAULT_USER_DEFINED_WRITABILITY_INDEX
        Default value for Channel UserDefinedWritability index
        See Also:
        Constant Field Values
      • GLOBAL_DEFAULT_USER_DEFINED_WRITABILITY_INDEX

        static final int GLOBAL_DEFAULT_USER_DEFINED_WRITABILITY_INDEX
        Default value for Global UserDefinedWritability index
        See Also:
        Constant Field Values
      • GLOBALCHANNEL_DEFAULT_USER_DEFINED_WRITABILITY_INDEX

        static final int GLOBALCHANNEL_DEFAULT_USER_DEFINED_WRITABILITY_INDEX
        Default value for GlobalChannel UserDefinedWritability index
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractTrafficShapingHandler

        protected AbstractTrafficShapingHandler​(long writeLimit,
                                                long readLimit,
                                                long checkInterval,
                                                long maxTime)
        Parameters:
        writeLimit - 0 or a limit in bytes/s
        readLimit - 0 or a limit in bytes/s
        checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.
        maxTime - The maximum delay to wait in case of traffic excess. Must be positive.
      • AbstractTrafficShapingHandler

        protected AbstractTrafficShapingHandler​(long writeLimit,
                                                long readLimit,
                                                long checkInterval)
        Constructor using default max time as delay allowed value of 15000L ms.
        Parameters:
        writeLimit - 0 or a limit in bytes/s
        readLimit - 0 or a limit in bytes/s
        checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.
      • AbstractTrafficShapingHandler

        protected AbstractTrafficShapingHandler​(long writeLimit,
                                                long readLimit)
        Constructor using default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
        Parameters:
        writeLimit - 0 or a limit in bytes/s
        readLimit - 0 or a limit in bytes/s
      • AbstractTrafficShapingHandler

        protected AbstractTrafficShapingHandler()
        Constructor using NO LIMIT, default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
      • AbstractTrafficShapingHandler

        protected AbstractTrafficShapingHandler​(long checkInterval)
        Constructor using NO LIMIT and default max time as delay allowed value of 15000L ms.
        Parameters:
        checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.
    • Method Detail

      • setTrafficCounter

        void setTrafficCounter​(TrafficCounter newTrafficCounter)
        Parameters:
        newTrafficCounter - the TrafficCounter to set
      • userDefinedWritabilityIndex

        protected int userDefinedWritabilityIndex()
        Returns:
        the index to be used by the TrafficShapingHandler to manage the user defined writability. For Channel TSH it is defined as 1, for Global TSH it is defined as 2, for GlobalChannel TSH it is defined as 3.
      • configure

        public void configure​(long newWriteLimit,
                              long newReadLimit,
                              long newCheckInterval)
        Change the underlying limitations and check interval.

        Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.

        So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.

        Parameters:
        newWriteLimit - The new write limit (in bytes)
        newReadLimit - The new read limit (in bytes)
        newCheckInterval - The new check interval (in milliseconds)
      • configure

        public void configure​(long newWriteLimit,
                              long newReadLimit)
        Change the underlying limitations.

        Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.

        So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.

        Parameters:
        newWriteLimit - The new write limit (in bytes)
        newReadLimit - The new read limit (in bytes)
      • configure

        public void configure​(long newCheckInterval)
        Change the check interval.
        Parameters:
        newCheckInterval - The new check interval (in milliseconds)
      • getWriteLimit

        public long getWriteLimit()
        Returns:
        the writeLimit
      • setWriteLimit

        public void setWriteLimit​(long writeLimit)

        Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.

        So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.

        Parameters:
        writeLimit - the writeLimit to set
      • getReadLimit

        public long getReadLimit()
        Returns:
        the readLimit
      • setReadLimit

        public void setReadLimit​(long readLimit)

        Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.

        So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.

        Parameters:
        readLimit - the readLimit to set
      • getCheckInterval

        public long getCheckInterval()
        Returns:
        the checkInterval
      • setCheckInterval

        public void setCheckInterval​(long checkInterval)
        Parameters:
        checkInterval - the interval in ms between each step check to set, default value being 1000 ms.
      • setMaxTimeWait

        public void setMaxTimeWait​(long maxTime)

        Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.

        So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.

        Parameters:
        maxTime - Max delay in wait, shall be less than TIME OUT in related protocol. Must be positive.
      • getMaxTimeWait

        public long getMaxTimeWait()
        Returns:
        the max delay in wait to prevent TIME OUT
      • getMaxWriteDelay

        public long getMaxWriteDelay()
        Returns:
        the maxWriteDelay
      • setMaxWriteDelay

        public void setMaxWriteDelay​(long maxWriteDelay)

        Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.

        So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.

        Parameters:
        maxWriteDelay - the maximum Write Delay in ms in the buffer allowed before write suspension is set. Must be positive.
      • getMaxWriteSize

        public long getMaxWriteSize()
        Returns:
        the maxWriteSize default being 4194304L bytes.
      • setMaxWriteSize

        public void setMaxWriteSize​(long maxWriteSize)

        Note that this limit is a best effort on memory limitation to prevent Out Of Memory Exception. To ensure it works, the handler generating the write should use one of the way provided by Netty to handle the capacity:

        - the Channel.isWritable() property and the corresponding channelWritabilityChanged()

        - the ChannelFuture.addListener(new GenericFutureListener())

        Parameters:
        maxWriteSize - the maximum Write Size allowed in the buffer per channel before write suspended is set, default being 4194304L bytes.
      • doAccounting

        protected void doAccounting​(TrafficCounter counter)
        Called each time the accounting is computed from the TrafficCounters. This method could be used for instance to implement almost real time accounting.
        Parameters:
        counter - the TrafficCounter that computes its performance
      • releaseReadSuspended

        void releaseReadSuspended​(ChannelHandlerContext ctx)
        Release the Read suspension
      • checkWaitReadTime

        long checkWaitReadTime​(ChannelHandlerContext ctx,
                               long wait,
                               long now)
        Method overridden in GTSH to take into account specific timer for the channel.
        Parameters:
        wait - the wait delay computed in ms
        now - the relative now time in ms
        Returns:
        the wait to use according to the context
      • informReadOperation

        void informReadOperation​(ChannelHandlerContext ctx,
                                 long now)
        Method overridden in GTSH to take into account specific timer for the channel.
        Parameters:
        now - the relative now time in ms
      • setUserDefinedWritability

        void setUserDefinedWritability​(ChannelHandlerContext ctx,
                                       boolean writable)
      • checkWriteSuspend

        void checkWriteSuspend​(ChannelHandlerContext ctx,
                               long delay,
                               long queueSize)
        Check the writability according to delay and size for the channel. Set if necessary setUserDefinedWritability status.
        Parameters:
        delay - the computed delay
        queueSize - the current queueSize
      • releaseWriteSuspended

        void releaseWriteSuspended​(ChannelHandlerContext ctx)
        Explicitly release the Write suspended status.
      • trafficCounter

        public TrafficCounter trafficCounter()
        Returns:
        the current TrafficCounter (if channel is still connected)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • calculateSize

        protected long calculateSize​(java.lang.Object msg)
        Calculate the size of the given Object. This implementation supports ByteBuf, ByteBufHolder and FileRegion. Sub-classes may override this.
        Parameters:
        msg - the msg for which the size should be calculated.
        Returns:
        size the size of the msg or -1 if unknown.