BLPAPI C++
3.24.11
|
Provide a list of subscriptions. More...
Namespaces | |
BloombergLP | |
BloombergLP::blpapi | |
Classes | |
class | SubscriptionList |
Provide a list of subscriptions.
blpapi::SubscriptionList | Represents a list of subscriptions. |
Session::subscribe
, Session::resubscribe
, and Session::unsubscribe
methods. This structure comprises a list in which each list entry contains two primary fields: a CorrelationId
associated with the subscription, and a string, called a subscription string, describing the data to be delivered as a part of the subscription. ^//[-_.a-zA-Z0-9]+/[-_.a-zA-Z0-9]+\$
, e.g. //blp/mktdata. See blpapi_abstractsession
for further details./([-_.a-zA-Z0-9]+/)?
, often used as a symbology identifier. Common examples include /ticker/
and /cusip/
. Not all services make use of prefixes. Note than an "empty" topic prefix consists of the string "/", so the topic prefix always separates the service string from the instrument string.?
(i.e. a string matching [^?]+
) e.g. "IBM US Equity", or "SPX Index". The service, prefix, and instrument together uniquely identify a source for subscription data.fields
key is formatted as a comma-separated list of field names. BLPAPI provides several convenience functions to assist in formatting subscription strings for services that make use of these conventions; see the SubscriptionList::add
methods for details.SessionOptions
. Session::subscribe
and Session::resubscribe
are automatically qualified if the service identifier is missing (i.e. if the subscription string does not start with "//"). The subscription parameters (i.e. the optional part after instrument identifier) are never modified. The rules for qualifying the subscription string are: //
then it is assumed to be a a fully qualified subscription string including service identifier, prefix, and instrument. In this case the string will not be modified and session options defaults have no affect on the subscription. /
and the second character is not /
, then the string is assumed to begin with the topic prefix, but no service identifier. In this case the string is qualified by prepending the SessionOptions::defaultSubscriptionService()
to the specified string. /
it is assumed to begin with an instrument identifier. In this case the string is qualified by prepending the SessionOptions::defaultSubscriptionService()
followed by SessionOptions::defaultTopicPrefix()
to the specified string. If the defaultTopicPrefix
is empty or null, then the prefix used is /
. Otherwise (in the case of a nontrivial prefix) if the separator /
is not specified at the beginning or the end of the defaultTopicPrefix
, then it will be added. SubscriptionList
is used when calling Session::subscribe()
, Session::resubscribe()
and Session::unsubscribe()
. The entries can be constructed in a variety of ways.