Cancels an outstanding request or a subscription represented by the specified correlationId.

Cancels outstanding requests or subscriptions represented by the specified list of correlationIds.

Cancels an outstanding request or a subscription represented by the specified correlationId.

Cancels outstanding requests or subscriptions represented by the specified list of correlationIds.

Returns a new Identity which is valid but has not been authorized.

Same as calling createSnapshotRequestTemplate( subscriptionString, statusCid, null)

The session identity will be used if it's been authorized.

Create a snapshot service request template for getting subscription data specified by the 'subscriptionString' using the optionally specified 'identity' if all the following conditions are met: the session is established, 'subscriptionString' is a valid subscription string and 'statusCid' is not used in this session. If one or more conditions are not met, an exception is thrown. The provided 'statusCid' will be used for an implied subscription associated with the create request template. The created request template status updates will be delivered using ADMIN events.

The benefit of the snapshot service request templates is that these requests may be serviced from a cache and the user may expect to see significantly lower response time.

There are 3 possible states for a created request template: 'Pending', 'Available', and 'Terminated'. A 'RequestTemplate' is initially in the 'Pending' state.

The user may send a request using a template that is in 'Pending' state. If this succeeds, the state of that template changes to 'Available'. Note that response times to receive data may be longer than a response time for a request in the 'Available' state since request caches may not yet have been established. A template may transition back into 'Pending' state from the 'Available' state, in which case a 'RequestTemplatePending' message will be generated.

If state is 'Available', all requests will be serviced from a cache and the user may expect to see significantly reduced latency. Note, that a snapshot request template can transition out of the 'Available' state concurrently with requests being sent, so no guarantee of service from the cache can be provided. Request template may transition into 'Available' state only from the 'Pending' state. In this case the 'RequestTemplateAvailable' message is generated. This message will also contain information about currently used connection in the 'boundTo' field. Note that it is possible to get the 'RequestTemplateAvailable' message with a new connection information, even if a request template is already in the 'Available' state.

If state is 'Terminated', sending request will always result in a failure response. Request template may transition into this state from any other state. This is a final state and it is guaranteed that the last message associated with the provided 'statusCid' will be the 'RequestTemplateTerminated' message which is generated when a request template transitions into this state. If a request template transitions into this state, all outstanding requests will be failed and appropriate messages will be generated for each request. After receiving the 'RequestTemplateTerminated' message, 'statusCid' may be reused.

Note that resources used by a snapshot service request template are released only when request template transitions into the 'Terminated' state or when session is destroyed. In order to release resources when request template is not needed anymore, user should call Cancel(CorrelationID) or close unless the 'RequestTemplateTerminated' message was already received due to some problems. If the 'Session.cancel' method is used, all outstanding requests are canceled and the underlying subscription is closed immediately. If the handle is closed with the 'RequestTemplate.close' method, the underlying subscription is closed only when all outstanding requests are served. Note that it is possible to have a situation when response contain data that were sent by a backend before user actually sends a request template. For example it is possible if user requested data were already in an incoming TCP queue.

Deprecated since 3.3.0.0. Use CreateIdentity instead.

Dispatch 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

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.

Return a generated token to be used for authorization.

Return a generated token to be used for authorization.

Return a generated token to be used for authorization.

Return a generated token to be used for authorization.

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.

Returns a handle to a Service object representing the service identified by the specified uri.

Returns an enumerable collection for iterating over the subscriptions.

Returns the subscription status for the specified correlationId.

Returns the subscription string for the specified correlationId.

Initialize AbstractSession. Must be called from the constructor(s) of the derived class.

Returns the next event available for processing on this session.

Returns the next event available for processing on this session.

Opens the service having the specified uri.

Issues an asynchronous request to open a service.

Initiates an asynchronous request to open a service.

This is the same as calling Resubscribe(subscriptionList, requestLabel: null) .

This is the same as calling Subscribe(subscriptionList, requestLabel: null, mode)

This is the same as calling Resubscribe(subscriptionList, resubId, requestLabel: null) .

Modifies each subscription in the specified subscriptionList to reflect the modified options specified for it.

This is the same as calling Subscribe(subscriptionList, resubId, requestLabel: null, mode)

Modifies each subscription in the specified subscriptionList to reflect the modified options specified for it.

Modifies each subscription in the subscriptionList to reflect the modified options specified for it.

Modifies each subscription in the subscriptionList to reflect the modified options specified for it.

Sends the specified authorizationRequest and update the specified identity with the results.

Deprecated since 3.3.0.0. Use SendAuthorizationRequest(Request, Identity, CorrelationID)instead.

Sends the specified authorizationRequest and update the specified identity with the results.

Sends the specified authorizationRequest and update the specified identity with the results.

Deprecated since 3.3.0.0. Use SendAuthorizationRequest(Request, Identity, CorrelationID, String) instead.

Deprecated since 3.3.0.0. Use SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID) instead.

Sends the specified authorizationRequest and update the specified identity with the results.

Deprecated since 3.3.0.0. Use SendAuthorizationRequest(Request, UserHandle, IEventQueue, CorrelationID, String) instead.

Same as calling 'SendRequest(requestTemplate, null)'

Sends the specified request to a service using this session.

The session identity will be used if it's been authorized.

Send a request defined by the specified 'requestTemplate'. If the optionally specified 'correlationId' is supplied, use it otherwise create a new 'CorrelationId'. The actual 'CorrelationId' used is returned. 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' will be generated after which the 'CorrelationId' associated with the request may be re-used.

Sends the specified request to a service using this session.

The session identity will be used if it's been authorized.

Sends the specified request to a service using this session.

Sends the specified request to a service using this session.

The session identity will be used if it's been authorized.

Deprecated since 3.3.0.0. Use SendRequest(Request, Identity, CorrelationID) instead.

Sends the specified request to a service using this session.

Sends the specified request to a service using this session.

Sends the specified request to a service using this session.

Deprecated since 3.3.0.0. Use SendRequest(Request, Identity, CorrelationID, String) instead.

Deprecated since 3.3.0.0. Use SendRequest(Request, Identity, IEventQueue, CorrelationID) instead.

Sends the specified request to a service using this session.

Deprecated since 3.3.0.0. Use SendRequest(Request, Identity, IEventQueue, CorrelationID, String) instead.

Set event specific event handlers

Issues a blocking call to start the session.

Initiates a non blocking call to start the session.

Stops this session.

Stops the operation of this session.

This is the same as calling Subscribe(subscriptionList, identity: null, requestLabel: null) .

This is the same as calling Subscribe(subscriptionList, identity, requestLabel: null) .

This is the same as calling Subscribe(subscriptionList, identity: null, requestLabel: null, mode)

Deprecated since 3.3.0.0. Use Subscribe(IListSubscription, Identity) instead.

This is the same as calling Subscribe(subscriptionList, identity: null, requestLabel) .

This is the same as calling Subscribe(subscriptionList, identity, requestLabel: null, mode)

Initiates a request to receive asynchronous updates to the specified topics in the subscriptionList.

Deprecated since 3.3.0.0. Use Subscribe(IListSubscription, Identity, String) instead.

This is the same as calling Subscribe(subscriptionList, identity: null, requestLabel, mode)

Initiates a request to receive asynchronous updates to the specified topics in the subscriptionList.

Tries to retrieve the next event available for processing on this session

Cancels a previous request for asynchronous topic updates associated with the specified correlationId.

Cancels previous requests for asynchronous topic updates associated with the correlation ids listed in the specified subscriptionList.

Cancels previous requests for asynchronous topic updates associated with the correlation ids listed in the specified subscriptionList.

Dispose this Session object. It calls AbstractSession.Stop() to close the opened socket.