|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bloomberglp.blpapi.Subscription
public class Subscription
A Subscription object holds information about a subscription for topic and comprises of 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.
"//blp/mktdata/ticker/IBM US Equity?fields=BID,ASK&interval=2" \-----------/\------/\-----------/\------------------------/ | | | | Service Prefix Instrument SuffixSuch a fully-qualified string is composed of: Service Identifier: a string matching the expression
^//[-_.a-zA-Z0-9]+/[-_.a-zA-Z0-9]+$
, e.g.
//blp/mktdata
. See 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 prefices. 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.
SubscriptionList.add(com.bloomberglp.blpapi.Subscription)
methods for details.
SubscriptionList
objects that can be used for
subscribe()
,
resubscribe()
,
unsubscribe()
requests
The two important elements when creating a subscription are
OPERATION | SUBSCRIPTION STRING | CORRELATION ID |
---|---|---|
'subscribe' | Used to specify the topic to subscribe to. | Identifier for the subscription. If null correlationId was specified an internally generated correlationId will be set for the subscription. |
'resubscribe' | Used to specify the new topic to which the subscription should be modified to. | Identifier of the subscription which needs to be modified. |
'unsubscribe' | NOT USED | Identifier of the subscription which needs to be canceled. |
Constructor Summary | |
---|---|
Subscription(java.lang.String subscriptionString)
Construct a Subscription object with the specified subscription string and an internally generated CorrelationID. |
|
Subscription(java.lang.String subscriptionString,
boolean isResolved)
Construct a Subscription object with the specified subscription string, and the specified isResolved flag and an internally generated
CorrelationID . |
|
Subscription(java.lang.String subscriptionString,
CorrelationID correlationID)
Construct a Subscription object with the specified subscription string and the specified correlationID for correlation. |
|
Subscription(java.lang.String subscriptionString,
CorrelationID correlationID,
boolean isResolved)
Construct a Subscription object with the specified subscription string, the specified correlationID for correlation, and the specified isResolved flag. |
|
Subscription(java.lang.String security,
java.util.List<java.lang.String> fields)
|
|
Subscription(java.lang.String security,
java.util.List<java.lang.String> fields,
CorrelationID correlationId)
|
|
Subscription(java.lang.String security,
java.util.List<java.lang.String> fields,
java.util.List<java.lang.String> options)
|
|
Subscription(java.lang.String security,
java.util.List<java.lang.String> fields,
java.util.List<java.lang.String> options,
CorrelationID correlationId)
|
|
Subscription(java.lang.String subscriptionString,
java.lang.String fields)
Create a Subscription object with the specified subscriptionString and fields with no options and an internally generated CorrelationID |
|
Subscription(java.lang.String subscriptionString,
java.lang.String fields,
CorrelationID correlationId)
Create a Subscription object with the specified subscriptionString and fields with no options and the specified correlationId |
|
Subscription(java.lang.String subscriptionString,
java.lang.String fields,
java.lang.String options)
Create a Subscription object with the specified subscriptionString, fields and options and an internally generated CorrelationID |
|
Subscription(java.lang.String subscriptionString,
java.lang.String fields,
java.lang.String options,
CorrelationID correlationId)
Create a Subscription object with the specified subscriptionString, fields, options and correlationId |
Method Summary | |
---|---|
CorrelationID |
correlationID()
|
boolean |
isResolved()
|
void |
setCorrelationID(CorrelationID correlationId)
|
void |
setSubscriptionString(java.lang.String subscriptionString)
|
Session.SubscriptionStatus |
subscriptionStatus()
|
java.lang.String |
subscriptionString()
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Subscription(java.lang.String subscriptionString)
public Subscription(java.lang.String subscriptionString, CorrelationID correlationID)
public Subscription(java.lang.String subscriptionString, boolean isResolved)
isResolved
flag and an internally generated
CorrelationID . If the isResolved
is set to true
, the
subscriptionString
is assumed to be a fully-resolved topic
string. Note that even if the isResolved
flag is true, it is
still at the discretion of each function operating on
Subscription
to perform resolution (again) on this topic or not.
subscriptionString
- string representing the data to be subscribedisResolved
- whether the resolution phase can be skipped because
the subscriptionString
contains a pre-resolved
topicpublic Subscription(java.lang.String subscriptionString, CorrelationID correlationID, boolean isResolved)
isResolved
flag. If the isResolved
is set to
true
, the subscriptionString
is assumed to be a
fully-resolved topic string. Note that even if the isResolved
flag is true, it is still at the discretion of each function operating
on Subscription
to perform resolution (again) on this topic or
not.
subscriptionString
- string representing the data to be subscribedcorrelationID
- the correlation idisResolved
- whether the resolution phase can be skipped because
the subscriptionString
contains a pre-resolved
topicpublic Subscription(java.lang.String subscriptionString, java.lang.String fields)
CorrelationID
public Subscription(java.lang.String subscriptionString, java.lang.String fields, CorrelationID correlationId)
public Subscription(java.lang.String subscriptionString, java.lang.String fields, java.lang.String options)
CorrelationID
public Subscription(java.lang.String subscriptionString, java.lang.String fields, java.lang.String options, CorrelationID correlationId)
public Subscription(java.lang.String security, java.util.List<java.lang.String> fields)
public Subscription(java.lang.String security, java.util.List<java.lang.String> fields, CorrelationID correlationId)
public Subscription(java.lang.String security, java.util.List<java.lang.String> fields, java.util.List<java.lang.String> options)
public Subscription(java.lang.String security, java.util.List<java.lang.String> fields, java.util.List<java.lang.String> options, CorrelationID correlationId)
Method Detail |
---|
public java.lang.String subscriptionString()
public CorrelationID correlationID()
public Session.SubscriptionStatus subscriptionStatus()
public void setSubscriptionString(java.lang.String subscriptionString)
public void setCorrelationID(CorrelationID correlationId)
public java.lang.String toString()
toString
in class java.lang.Object
public boolean isResolved()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |