setRequestedMaxBandwidth method

Future<void> setRequestedMaxBandwidth(String newVal)

Setter method that sets the maximum bandwidth expressed in kilobits/s that can be consumed for the data coming from Lightstreamer Server.

A limit on bandwidth may already be posed by the Metadata Adapter, but the client can further restrict this limit. The limit applies to the bytes received in each streaming or polling connection.

General Edition Note Bandwidth Control is an optional feature, available 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 "unlimited"

Lifecycle The bandwidth limit can be set and changed at any time. If a connection is currently active, the bandwidth limit for the connection is changed on the fly. Remember that the Server may apply a different limit.

Notification A change to this setting will be notified through a call to ClientListener.onPropertyChange with argument "requestedMaxBandwidth" on any ClientListener listening to the related LightstreamerClient.
Moreover, upon any change or attempt to change the limit, the Server will notify the client and such notification will be received through a call to ClientListener.onPropertyChange with argument "realMaxBandwidth" on any ClientListener listening to the related LightstreamerClient.

• newVal A decimal number, which represents the maximum bandwidth requested for the streaming or polling connection expressed in kbps (kilobits/sec). The string "unlimited" is also allowed, to mean that the maximum bandwidth can be entirely decided on the Server side (the check is case insensitive).

Throws IllegalArgumentException if a negative, zero, or a not-number value (excluding special values) is passed.

• See getRealMaxBandwidth

Implementation

Future<void> setRequestedMaxBandwidth(String newVal) async {
  _requestedMaxBandwidth = newVal;
  var arguments = <String, dynamic> {
    'newVal': newVal
  };
  return await _invokeMethod('setRequestedMaxBandwidth', arguments);
}