Interface LimiterRampUpMBean


  • public interface LimiterRampUpMBean

    The LimiterRampUpMBean interface provides methods to configure ramp up of the "SystemInput" limiter. Rate limiting is based on a concept of a maximum number of "tokens" per second (a rate) that Rhino can process. The allowed Rate can grow from a smaller value up to the configured maximum to cater for cache-loading, Just-In-Time compilation effects, etc.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void disableRampUp()
      Disable incremental growth in the allowed rate of the SystemInput limiter and set the allowed rate to the maximum rate.
      void enableRampUp​(double startRate, double rateIncrement, int eventsPerIncrement)
      Enable incremental growth in the allowed rate of the SystemInput limiter (Tip: ramp up will only be effective when the "SystemInput" limiter is not bypassed)
      int getEventsPerIncrement()
      Get the number of events which must be processed before Rhino will add "RateIncrement" to the allowed rate.
      double getRateIncrement()
      Get the amount added to the allowed rate if Rhino is successfully processing work.
      double getStartRate()
      Get the initial rate allowed by the SystemInput limiter.
      boolean isEnabled()
      Test if the ramp up is enabled.
    • Method Detail

      • getEventsPerIncrement

        int getEventsPerIncrement()
                           throws ConfigurationException

        Get the number of events which must be processed before Rhino will add "RateIncrement" to the allowed rate.

        Throws:
        ConfigurationException
      • enableRampUp

        void enableRampUp​(double startRate,
                          double rateIncrement,
                          int eventsPerIncrement)
                   throws ConfigurationException

        Enable incremental growth in the allowed rate of the SystemInput limiter (Tip: ramp up will only be effective when the "SystemInput" limiter is not bypassed)

        Parameters:
        startRate - the initial allowed rate, in tokens per timeunit (timeunit is configured in the systemInput limiter)
        rateIncrement - incremental adjustment to the allowed rate. A positive number.
        eventsPerIncrement - the number of events processed before the allowed rate is increased
        Throws:
        ConfigurationException