setRequestedMaxFrequency method

void setRequestedMaxFrequency(
  1. String? freq
)

Setter method that sets the maximum update frequency to be requested to Lightstreamer Server for all the items in the MpnSubscription.

Note that frequency limits on the items can also be set on the server side and this request can only be issued in order to further reduce the frequency, not to rise it beyond these limits.

General Edition Note A further global frequency limit could also be imposed by the Server, depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Default null, meaning to lean on the Server default based on the subscription mode. This consists, for all modes, in not applying any frequency limit to the subscription (the same as "unlimited"); 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_max_frequency on any MpnSubscriptionListener listening to the related MpnSubscription.

  • freq A decimal number, representing the maximum update frequency (expressed in updates per second) for each item in the Subscription; for instance, with a setting of 0.5, for each single item, no more than one update every 2 seconds will be received. If the string "unlimited" is supplied, then no frequency limit is requested. It is also possible to supply the null value to stick to the Server default (which currently corresponds to "unlimited"). The check for the string constants is case insensitive.

Throws IllegalStateException if the MpnSubscription is currently "active".

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

Implementation

external void setRequestedMaxFrequency(String? freq);