Creates parameters for a record subscription, specifying a filter that restricts the
information returned in updates on the subject.
Declaration Syntax
C# | Visual Basic | Visual C++ |
IRecordSubscriptionParameters CreateRecordSubscriptionParameters( string filter )
Function CreateRecordSubscriptionParameters ( _ filter As String _ ) As IRecordSubscriptionParameters
IRecordSubscriptionParameters^ CreateRecordSubscriptionParameters( String^ filter )
Parameters
- filter (String)
- The record filter. For an explanation of filters and their syntax, see the Caplin StreamLink Overview.
Return Value
A set of IRecordSubscriptionParameters
representing the required fields and filter.
Remarks
When a subscription is made using the returned
IRecordSubscriptionParameters,
all fields in the record are subscribed to. The application is subsequently supplied with
updates to any of the fields in the record, with the specified filter applied.
Examples
CopyC#
using System; using System.Collections.Generic; using System.Text; using Caplin.StreamLink; using Caplin.StreamLink.Authentication; using Caplin.StreamLink.Subscription.Record; namespace StreamLinkExamples.Record { /// <summary> /// Various examples of how to create an IRecordSubscription using the /// IStreamLinkProvider interface. /// </summary> public class CreateRecordSubscriptionWithFiltering { /// <summary> /// Subscribe to a record and all fields (specify no fields) and filter on a field. /// </summary> public static void CreateRecordSubscriptionWithFilteringExample() { IStreamLink myStreamLink = new StreamLink(); myStreamLink.CredentialsProvider = new PasswordCredentialsProvider("admin", "admin"); IRecordSubscriptionListener subscriptionListener = new ExampleRecordSubscriptionListener(); // All fields and filter string filter = "Bid>10"; IRecordSubscriptionParameters recordParameters = myStreamLink.StreamLinkProvider.ParametersFactory.CreateRecordSubscriptionParameters(filter); IRecordSubscription subscription = myStreamLink.StreamLinkProvider.CreateRecordSubscription(subscriptionListener, "/DEMO/MSFT"); subscription.Subscribe(); myStreamLink.StreamLinkProvider.Connect(); } } }