Package org.jainslee.resources.sip.overloadcontrol

Enum LimiterInstruction.Action

    • Enum Constant Detail

      • ACCEPT

        public static final LimiterInstruction.Action ACCEPT
        The request is accepted by the overload control plugin as a normal request. The SIS will pass the request up the software stack where it may be subject to regular SIS rate limiting. This means the request could still be rejected by the SIS due to rate limiter overload conditions.

      • EXEMPT

        public static final LimiterInstruction.Action EXEMPT
        The request is accepted by the overload control plugin and is considered exempt from regular SIS rate limiting. The SIS will pass the request up the software stack without any further rate limiting considerations of its own.

      • REJECT

        public static final LimiterInstruction.Action REJECT
        The request is rejected by the overload control plugin. The limiter instruction for this action may include an optional response. The SIS will send this response to the request, if provided, otherwise it will send its default overload control rejection response.

        Caution must be used when rejecting requests, as doing so may break various call flows and application state machines. As a rule of thumb, do not reject mid-dialog requests, and consider carefully which initial requests should be exempt from overload control.

      • DISCARD

        public static final LimiterInstruction.Action DISCARD
        The request is rejected by the overload control plugin and should be discarded with no SIP response sent. Any associated server transaction state is also discarded.

        Discarded requests may be observable through side effects such as statistics, TCP sequence numbers, and so-on.

        Extreme caution must be used when discarding requests, the specific algorithm must be very well thought through. If in doubt, never discard a request.

    • Method Detail

      • values

        public static LimiterInstruction.Action[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (LimiterInstruction.Action c : LimiterInstruction.Action.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static LimiterInstruction.Action valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null