ProviderSession.RegisterServiceAsync Method (String, Identity, CorrelationID)

ProviderSessionRegisterServiceAsync Method (String, Identity, CorrelationID)

Begins the process of registering the service identified by the specified 'uri' and returns immediately.

Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.12.5.1

Syntax

public CorrelationID RegisterServiceAsync(
	string uri,
	Identity providerIdentity,
	CorrelationID correlationId
)

Public Function RegisterServiceAsync ( 
	uri As String,
	providerIdentity As Identity,
	correlationId As CorrelationID
) As CorrelationID

public:
CorrelationID^ RegisterServiceAsync(
	String^ uri, 
	Identity^ providerIdentity, 
	CorrelationID^ correlationId
)

member RegisterServiceAsync : 
        uri : string * 
        providerIdentity : Identity * 
        correlationId : CorrelationID -> CorrelationID

Parameters

uri: Type: SystemString
providerIdentity: Type: Bloomberglp.BlpapiIdentity
correlationId: Type: Bloomberglp.BlpapiCorrelationID

Return Value

Type: CorrelationID
The actual CorrelationID object that will identify Event objects generated as a result of this call.

Exceptions

Exception	Condition
InvalidOperationException	The session is not started.
DuplicateCorrelationIDException	The specified 'correlationId' is currently active for this Session.

Remarks

The specified 'providerIdentity' is used to verify permissions to provide the service being registered. The specified 'correlationId' is used to track Events generated as a result of this call.

The 'uri' must begin with a full qualified service name. That is it must begin with "//[namespace]/[service-name]". Any portion of the 'uri' after the service name is ignored.

The application must monitor events for a EventType.SERVICE_STATUS event which will be generated once the service has been successfully registered or registration has failed.

Reference

ProviderSession Class

RegisterServiceAsync Overload

Bloomberglp.Blpapi Namespace