StreamLink.NET
6.2.10-3513-c11dd52
|
Defines the parameters used for Container subscriptions. To create an instance of ContainerSubscriptionParameters call the IStreamLink.CreateContainerSubscriptionParameters method. More...
Public Member Functions | |
Caplin.StreamLink.IContainerSubscriptionParameters | Select (string where, string orderBy, string groupBy) |
Allow selection, sorting and grouping of containers. More... | |
Caplin.StreamLink.IContainerSubscriptionParameters | SetWindow (int start, int size) |
Sets the size of the container window. More... | |
Public Member Functions inherited from Caplin.StreamLink.IRecordSubscriptionParameters | |
Caplin.StreamLink.IRecordSubscriptionParameters | SetFields (IList< string > fields) |
Sets the record fields that will be requested when a subscription is made using these parameters. More... | |
Caplin.StreamLink.IRecordSubscriptionParameters | SetFilter (string filter, bool isImage) |
Sets the filter that restricts the the information returned by the subscription. The filtering is performed by the Liberator, rather than the client, so that bandwidth and client side processing are reduced. More... | |
Defines the parameters used for Container subscriptions. To create an instance of ContainerSubscriptionParameters call the IStreamLink.CreateContainerSubscriptionParameters method.
The ContainerSubscriptionParameters is passed as a parameter to the subscribe method in the IStreamLink.
Caplin.StreamLink.IContainerSubscriptionParameters Caplin.StreamLink.IContainerSubscriptionParameters.Select | ( | string | where, |
string | orderBy, | ||
string | groupBy | ||
) |
Allow selection, sorting and grouping of containers.
Example: params.select('bid>123&ask<122', "bid ASC NUMBER, ask DESC NUMBER", "bid" )
The static ContainerFilterFactory can be used to build a FilterExpression whose toFilterString method will generate a where clause in the required format.
Note: this method will only work if the backend has the Caplin Refiner installed.
The following example shows how to build an expression for FIELD1 > 0.1 AND FIELD3 = "a a"
where | The where clause, in the form required by Caplin Refiner (example 'bid>123&ask<222'). |
orderBy | The sorting order of the returned container in the form: field [ASC or DESC] [NUMBER or TEXT], ... example: bid DESC NUMBER,ask ASC NUMBER |
groupBy | The group by clause in the form: field example: bid |
Caplin.StreamLink.IContainerSubscriptionParameters Caplin.StreamLink.IContainerSubscriptionParameters.SetWindow | ( | int | start, |
int | size | ||
) |
Sets the size of the container window.
start | The index of the first container element within the window, where the first container element has an index value of 0 (zero). |
size | The maximum number of container elements within the window. |