Enum Constant Detail

• MESSAGES_PER_SECOND

  public static final ClientThrottlerType MESSAGES_PER_SECOND

  Deprecated. 
  The Client is throttled on a 'messages per second' basis.

  This means that the Throttler will restrict the maximum number of messages per second that can be sent to the Client. The Throttler limit will indicate the number of messages per second.

• BYTES_PER_SECOND

  public static final ClientThrottlerType BYTES_PER_SECOND

  Deprecated. 
  The Client is throttled on a 'bytes per second' basis.

  This means that the Throttler will restrict the maximum number of bytes per second that can be sent to the Client. The Throttler limit will indicate the number of bytes per second.

• MESSAGE_INTERVAL

  public static final ClientThrottlerType MESSAGE_INTERVAL

  Deprecated. 
  The Client is throttled on a 'Message Interval' basis.

  This means that messages are sent out with a fixed interval between them. e.g. one message every 5 seconds. The Throttler limit indicates the period between messages measured in milliseconds (so 5000 for one message every 5 seconds).

  This type of throttling can lead to a significant backlog of messages on the Client queue therefore it is recommended that it is only used along with conflation in order to minimise the queue size.

• BUFFER_INTERVAL

  public static final ClientThrottlerType BUFFER_INTERVAL

  Deprecated. 
  The Client is throttled to a full output buffer every interval.

  This means that the number of bytes that fill a full buffer are output every period (specified in milliseconds). The number of bytes is therefore determined by the size of the output buffer specified by the Client connector. The Throttler limit indicates the period between messages measured in milliseconds (so 5000 for one message every 5 seconds).

  Note that output buffers are filled from the client queue until no more messages can be added in which case, depending upon message sizes the average rate per second would be less than the actual buffer size. When buffers are not filled then the throttler may allow several sends in the specified interval until more than the buffer size has been sent, in which case more than the buffer size could be sent in a single interval.

Method Detail

• values

  public static ClientThrottlerType[] values()

  Deprecated. 
  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 (ClientThrottlerType c : ClientThrottlerType.values())
      System.out.println(c);
  

  Returns:

  an array containing the constants of this enum type, in the order they are declared

• valueOf

  public static ClientThrottlerType valueOf(String name)

  Deprecated. 
  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

• fromString

  public static ClientThrottlerType fromString(String symbol)

  Deprecated. 
  Returns type enum from string representation.

  Parameters:

  symbol - type name in either lower or upper case

  Returns:

  the type or null if not recognised