Declaration Syntax| C# | Visual Basic | Visual C++ |
public interface IRecordSubscriptionParameters : ISubscriptionParameters
Public Interface IRecordSubscriptionParameters _ Implements ISubscriptionParameters
public interface class IRecordSubscriptionParameters : ISubscriptionParameters
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | Equals(ISubscriptionParameters) |
Determines if this instance of ISubscriptionParameters is equal to another instance. This is
used for message optimisation.
(Inherited from ISubscriptionParameters.) |
 | Fields |
Gets the fields that will be requested when the subscription request
for the associated IRecordSubscription is sent to Liberator.
|
| Filter |
Gets the filter associated with the subscription.
When the record is subscribed, the Liberator uses the filter to
restrict the updates that reach the IRecordSubscriptionListener
associated with the subscription.
|
| ToParameterString()()() |
Converts the ISubscriptionParameters into a string representation.
(Inherited from ISubscriptionParameters.) |
RemarksParameters are used to specify which fields of the record should be subscribed to, and (through a filter) the conditions under which the Liberator should send the application updates for those fields.
To create an IRecordSubscriptionParameters object, use one of the CreateRecordSubscriptionParameters() methods of IParametersFactory.
Filter Syntax
A filter restricts the information returned, thus reducing the number of field updates that will be received. For example, the filter "(dLast > 50) & (dVolumeAcc > 1000)" means that Liberator only sends updates when the value of the field dLast is greater than 50 and the dVolumeAcc field is greater than 1000.
For further information on the filtering syntax see the Caplin StreamLink Overview.