AbstractSession Class

This class provides an abstract session for sharing interfaces between Session and ProviderSession.

Inheritance Hierarchy

SystemObject
  Bloomberglp.BlpapiAbstractSession
    Bloomberglp.BlpapiProviderSession
    Bloomberglp.BlpapiSession

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

Syntax

C++

Copy

public abstract class AbstractSession : IAbstractSession, 
	IDisposable

Public MustInherit Class AbstractSession
	Implements IAbstractSession, IDisposable

public ref class AbstractSession abstract : IAbstractSession, 
	IDisposable

[<AbstractClassAttribute>]
type AbstractSession =  
    class
        interface IAbstractSession
        interface IDisposable
    end

The AbstractSession type exposes the following members.

Constructors

	Name	Description
	AbstractSession	The default constructor.

Top

Properties

	Name	Description
	SessionName	Returns the session name.

Top

Methods

	Name	Description
	Cancel(CorrelationID)	Cancels an outstanding request or a subscription represented by the specified correlationId.
	Cancel(IListCorrelationID)	Cancels outstanding requests or subscriptions represented by the specified list of correlationIds.
	Cancel(CorrelationID, String)	Cancels an outstanding request or a subscription represented by the specified correlationId.
	Cancel(IListCorrelationID, String)	Cancels outstanding requests or subscriptions represented by the specified list of correlationIds.
	CreateIdentity	Returns a new Identity which is valid but has not been authorized.
	CreateUserHandle	Obsolete. Deprecated since 3.3.0.0. Use CreateIdentity instead.
	DispatchEvent	Dispatches event with event handler if it has been set otherwise do nothing. Event handlers are set by a library client in case of async session. SetEventHandler(ISessionEventHandler), SetEventHandler(ISessionEventHandler, EventEventType), EventEventType
	Dispose	Dispose this Session object. It calls AbstractSession.Stop() to close the opened socket.
	GenerateAuthorizedIdentity	Generates an authorized Identity with the specified authOptions and cid. One or more AUTHORIZATION_STATUS events, zero or more TOKEN_STATUS events and zero or more SERVICE_STATUS events are generated. If this is an asynchronous AbstractSession then an Event may be processed by the registered EventHandler before GenerateAuthorizedIdentity(AuthOptions, CorrelationID) has returned. The behavior is undefined when authOptions is null.
	GenerateToken	Return a generated token to be used for authorization.
	GenerateToken(CorrelationID)	Return a generated token to be used for authorization.
	GenerateToken(CorrelationID, IEventQueue)	Return a generated token to be used for authorization.
	GenerateToken(String, String, CorrelationID, IEventQueue)	Return a generated token to be used for authorization.
	GetAuthorizedIdentity	Gets the authorized Identity associated with the specified cid. If cid is omitted and the session identity is authorized, the function will return the session identity.
	GetService	Returns the Service identified by serviceName.
	Init	Initialize AbstractSession. Must be called from the constructor(s) of the derived class.
	NextEvent	Returns the next event available for processing on this session.
	NextEvent(Int64)	Returns the next event available for processing on this session.
	OpenService	Opens the service identified by serviceName.
	OpenServiceAsync(String)	Issues an asynchronous request to open a service.
	OpenServiceAsync(String, CorrelationID)	Initiates an asynchronous request to open a service.
	SendAuthorizationRequest(Request, Identity, CorrelationID)	Sends the specified authorizationRequest and update the specified identity with the results.
	SendAuthorizationRequest(Request, UserHandle, CorrelationID)	Obsolete. Deprecated since 3.3.0.0. Use SendAuthorizationRequest(Request, Identity, CorrelationID)instead.
	SendAuthorizationRequest(Request, Identity, CorrelationID, String)	Sends the specified authorizationRequest and update the specified identity with the results.
	SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID)	Sends the specified authorizationRequest and update the specified identity with the results.
	SendAuthorizationRequest(Request, UserHandle, CorrelationID, String)	Obsolete. Deprecated since 3.3.0.0. Use SendAuthorizationRequest(Request, Identity, CorrelationID, String) instead.
	SendAuthorizationRequest(Request, UserHandle, IEventQueue, CorrelationID)	Obsolete. Deprecated since 3.3.0.0. Use SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID) instead.
	SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID, String)	Sends the specified authorizationRequest and update the specified identity with the results.
	SendAuthorizationRequest(Request, UserHandle, IEventQueue, CorrelationID, String)	Obsolete. Deprecated since 3.3.0.0. Use SendAuthorizationRequest(Request, UserHandle, IEventQueue, CorrelationID, String) instead.
	Start	Issues a blocking call to start the session.
	StartAsync	Initiates a non blocking call to start the session.
	Stop	Stops this session.
	Stop(AbstractSessionStopOption)	Stops the operation of this session.
	TryNextEvent	Tries to retrieve the next event available for processing on this session

Top

Remarks

Sessions manage access to services either by requests and responses or subscriptions. A Session can dispatch events and replies in either a synchronous or asynchronous mode. The mode of a Session is determined when it is constructed and cannot be changed subsequently.

Reference

Bloomberglp.Blpapi Namespace