setRequestedBufferSize method

void setRequestedBufferSize(
  1. String? size
)

Setter method that sets the length to be requested to Lightstreamer Server for the internal queuing buffers for the items in the MpnSubscription.

A Queuing buffer is used by the Server to accumulate a burst of updates for an item, so that they can all be sent to the client, despite of bandwidth or frequency limits.
Note that the Server may pose an upper limit on the size of its internal buffers.

Default null, meaning to lean on the Server default based on the subscription mode. This means that the buffer size will be 1 for MERGE subscriptions and "unlimited" for DISTINCT subscriptions. See the "General Concepts" document for further details.

Lifecycle This method can only be called while the MpnSubscription instance is in its "inactive" state.

Notification A change to this setting will be notified through a call to MpnSubscriptionListener.onPropertyChanged with argument requested_buffer_size on any MpnSubscriptionListener listening to the related MpnSubscription.

  • size An integer number, representing the length of the internal queuing buffers to be used in the Server. If the string "unlimited" is supplied, then no buffer size limit is requested (the check is case insensitive). It is also possible to supply a null value to stick to the Server default (which currently depends on the subscription mode).

Throws IllegalStateException if the MpnSubscription is currently "active".

Throws IllegalArgumentException if the specified value is not null nor "unlimited" nor a valid positive integer number.

Implementation

void setRequestedBufferSize(String? size) {
  _bufferSize = size;
}