Session.SendRequest Method (Request, Identity, IEventQueue, CorrelationID, String)

SessionSendRequest Method (Request, Identity, IEventQueue, CorrelationID, String)

Sends the specified request to a service using this session.

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

Syntax

public CorrelationID SendRequest(
	Request request,
	Identity identity,
	IEventQueue eventQueue,
	CorrelationID correlationId,
	string requestLabel
)

Public Function SendRequest ( 
	request As Request,
	identity As Identity,
	eventQueue As IEventQueue,
	correlationId As CorrelationID,
	requestLabel As String
) As CorrelationID

public:
virtual CorrelationID^ SendRequest(
	Request^ request, 
	Identity^ identity, 
	IEventQueue^ eventQueue, 
	CorrelationID^ correlationId, 
	String^ requestLabel
) sealed

abstract SendRequest : 
        request : Request * 
        identity : Identity * 
        eventQueue : IEventQueue * 
        correlationId : CorrelationID * 
        requestLabel : string -> CorrelationID 
override SendRequest : 
        request : Request * 
        identity : Identity * 
        eventQueue : IEventQueue * 
        correlationId : CorrelationID * 
        requestLabel : string -> CorrelationID

Parameters

request: Type: Bloomberglp.BlpapiRequest
Filled in request that needs to be sent to the service.
identity: Type: Bloomberglp.BlpapiIdentity
A handle to the user whose privileges are to be used for this request.
eventQueue: Type: Bloomberglp.BlpapiIEventQueue
An event queue to be used to receive response events for this request.
correlationId: Type: Bloomberglp.BlpapiCorrelationID
A correlationId to be used to match the response.
requestLabel: Type: SystemString
A label that defines a string which will be recorded along with any diagnostics for this operation.

Return Value

Type: CorrelationID
An internally generated CorrelationID if the specified correlationId is null or return the specified correlationId.

Implements

ISessionSendRequest(Request, Identity, IEventQueue, CorrelationID, String)

Exceptions

Exception	Condition
InvalidOperationException	The session is not started.
InvalidRequestException	The request is not compliant with the schema for the request.
RequestQueueOverflowException	This session has too many enqueued requests.
DuplicateCorrelationIDException	The specified correlationId is already active for this Session.

Remarks

This method sends the specified request to a service that is available on this session. The specified correlationId is returned on the response and can be used to correlate the response to this request. If a null correlationId is specified then an internal CorrelationID is generated and returned.

If a valid identity is specified then it used as authorization for the specified request. If a valid identity is not specified then the request runs with the session authorization. SendAuthorizationRequest for more information.

If an eventQueue is specified then all response events for this Request are published to this eventQueue. The user can block on this event queue for response and can use this as a mechanism to convert this asynchronous request into a synchronous request.

A successful request will generate zero or more PARTIAL_RESPONSE events followed by exactly one RESPONSE event. Once the final RESPONSE event has been received the CorrelationID associated with this request may be re-used. If the request fails at any stage a REQUEST_STATUS event will be generated after which the CorrelationId associated with the request may be re-used.

Reference

Session Class

SendRequest Overload

Bloomberglp.Blpapi Namespace