com.lightstreamer.ls_client
Class SubscriptionConstraints

java.lang.Object
  com.lightstreamer.ls_client.SubscriptionConstraints

All Implemented Interfaces:

java.lang.Cloneable

public class SubscriptionConstraints
extends java.lang.Object
implements java.lang.Cloneable

Collects constraints to be applied on a subscription, to change the currently set parameters for all the involved items. They can only be used in order to restrict the constraints set by Lightstreamer Server Metadata Adapter.
Currently, only a constraint on the maximum update frequency is supported.

Field Summary

java.lang.Double

maxFrequency Maximum update frequency constraint; a 0 value means that no frequency limit should be set.

Constructor Summary

SubscriptionConstraints()
Creates a subscription constraints bean object with no constraints specified.

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object other)
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

maxFrequency

public java.lang.Double maxFrequency

Maximum update frequency constraint; a 0 value means that no frequency limit should be set. It can only be used in order to lower the frequency granted by the Metadata Adapter. A null value means that no change of the update frequency constraint is requested; it is useless, but reserved for future extensions.
The update frequency limit is obeyed only for MERGE, DISTINCT and COMMAND Items mode; in the latter case, the limit only applies to consecutive UPDATE events for the same key value.
If unfiltered dispatching has been requested for the Items, the change will be refused.

Edition Note:

Note that a further global frequency limit is also imposed by the Server, if it is running in Presto edition; by the way, this specific limit also applies to RAW mode and to unfiltered dispatching.

Constructor Detail

SubscriptionConstraints

public SubscriptionConstraints()

Creates a subscription constraints bean object with no constraints specified.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object