Cancels an outstanding request or a subscription.

This is the same as calling Cancel(CorrelationID, String) with a null request label.

Cancels an outstanding request or a subscription.

Cancels outstanding requests or subscriptions.

Cancels a previous request or subscription for asynchronous topic updates associated with each CorrelationID in correlators. Upon return, no further message will be generated for those requests or subscriptions.

For asynchronous sessions, a handler may still be processing an existing message for the associated request or subscription after the call returns. While iterating over an event, if any message is encountered for a cancelled CorrelationID, it will be silently ignored, but if the message was iterated to just prior to the completion of the cancel request it will be delivered, it is up to the application developer to handle this condition.

If any of the specified CorrelationIds do not refer to an "active" request or Subscription then, that particular CorrelationID will be ignored.

Once this call returns, the specified CorrelationID can be reused for new requests to this session. Also note that application developers should generally be cautious not to reuse a CorrelationID until all existing references within their applications have been cleared. Depending on the use of the CorrelationID, this can possibly result in accessing application resources which are no longer available.

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

Create a handle to represent a user of services. For using services with the specific user's credentials the identity should be authorized with the corresponding authorization service.

This is the same as calling createSnapshotRequestTemplate(String, CorrelationID, Identity) with null Identity.

Create a snapshot service request template for getting subscription data.

When creating a snapshot requests a subscription is established, but messages are sent to the application only when requested. This reduces latency for receiving the latest data when compared to starting a new subscription each time.

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.

This is the same as calling GenerateToken(String, String, CorrelationID, IEventQueue) with all null arguments.

This is the same as calling GenerateToken(String, String, CorrelationID, IEventQueue) with a null user ID and IP address and a null IEventQueue.

This is the same as calling GenerateToken(String, String, CorrelationID, IEventQueue) with a null user ID and IP address.

Generate a token to be used for authorization.

Valid authentication options must have been specified in the SessionOptions.

Gets an authorized Identity. A CorrelationID that maps to an authorized Identity.

If cid is omitted and the session identity is authorized, the function will return the session identity.

An authorized identity must be mapped to cid. If cid is omitted the session identity must have been authorized.

Gets the Service object.

Returns an enumerable collection of all subscriptions in this session.

Returns the subscription status for a given CorrelationID.

Returns the subscription string for a given CorrelationID.

This is the same as NextEvent(Int64) with 0 milliseconds.

Returns the next event available for processing on this session.

If no event is available immediately wait for timeoutMillis milliseconds for an event to arrive. If no event is received before the timeout expires return a TIMEOUT event. If the timeout specified is 0 then wait for an infinite amount of time for an event to be received. Note that this function cannot be called on a session that is operating in "asynchronous" mode. That is a session that was constructed with an EventHandler.

An EventHandler must not have been provided at construction.

Opens the service.

Issues an asynchronous request to open a service.

Initiates an asynchronous request to open a service.

Once the request has completed, a SERVICE_STATUS event will be generated indicating the result of the request. The correlationId will be returned in generated message. It can also be used to cancel this request before it completes by calling Cancel(CorrelationID).

Modifies subscriptions to reflect the modified options specified for them.

This is the same as calling Resubscribe(IListSubscription, Int32, String) with null request label.

Modifies subscriptions to reflect the modified options specified for them.

Modifies subscriptions to reflect the modified options specified for them.

This is the same as calling SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID, String) with a null IEventQueue and null request label.

This is the same as calling SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID, String) with a null IEventQueue.

This is the same as calling SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID, String) with a null request label.

Authorizes an identity.

This request can be used by applications to authorize users to receive data from services. If a user is successfully authorized all the entitlements for that user are cached locally. Once authorized the identity can be used to make subscriptions and requests as the user.

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

An Event will be published containing a message with the result of the authorization request. If the user was successfully authorized an "AuthorizationSuccess" message will be generated. If the user was not authorized an "AuthorizationFailure" message will be generated.

This is the same as calling SendRequest(RequestTemplate, CorrelationID) with null CorrelationID.

This is the same as calling SendRequest(Request, Identity, IEventQueue, CorrelationID, String) with null Identity, null IEventQueue and null request label.

Send a request based on a RequestTemplate.

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.

This is the same as calling SendRequest(Request, Identity, IEventQueue, CorrelationID, String) with null Identity and null IEventQueue.

This is the same as calling SendRequest(Request, Identity, IEventQueue, CorrelationID, String) with null IEventQueue and null request label.

This is the same as calling SendRequest(Request, Identity, IEventQueue, CorrelationID, String) with null Identity and null request label.

This is the same as calling SendRequest(Request, Identity, IEventQueue, CorrelationID, String) with null IEventQueue.

This is the same as calling SendRequest(Request, Identity, IEventQueue, CorrelationID, String) with null request label.

This is the same as calling SendRequest(Request, Identity, IEventQueue, CorrelationID, String) with null Identity.

Sends a request to a service.

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.

The number of enqueued requests must not exceed the amount specified in MaxPendingRequests when this session was created.

Set event specific event handlers.

Issues a blocking call to start the session.

A SESSION_STATUS event may be published containing a message with the result of the request. If the session was started successfully a "SessionStarted" message will be generated. If the start failed a "SessionStartupFailure" message may be generated.

Note: If this is an asynchronous session then the SESSION_STATUS event may be processed by the registered EventHandler before this method has returned. If this session is using an external EventDispatcher it should be already started.

A session must only be started once.

Initiates a non blocking call to start the session.

On completion of this request a SESSION_STATUS event is published containing a message with the result of the request. If the session was started successfully a "SessionStarted" message will be generated. If the start failed a "SessionStartupFailure" message will be generated.

Note: If this is an asynchronous session then the SESSION_STATUS may be processed by the registered EventHandler before this method has returned. If this session is using an external EventDispatcher it should be already started.

A session must only be started once.

This is the same as calling Stop(AbstractSessionStopOption) with SYNC.

Stops this session.

This is the same as calling Subscribe(IListSubscription, Identity, String) with null Identity and null request label.

This is the same calling Subscribe(IListSubscription, Identity, String) with null request label.

This is the same as calling Subscribe(IListSubscription, Identity, String) with null Identity.

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

Upon completion of this request a SUBSCRIPTION_STATUS event will be published for each topic in the subscription list containing a message with the result for one topic. A "SubscriptionStarted" message will be generated if the subscription was successfully initiated. If the subscription fails for any topic a "SubscriptionFailure" message containing the failure reason will be generated.

Any subscriptions in subscriptionList which were not given a application generated CorrelationID will have a session generated CorrelationID set.

Multiple subscriptions to the same subscription string are valid and each will have their own, unique CorrelationID.

In the case of an exception none of the subscriptions will be processed.

Retrieves the next event available for processing on this session.

This method never blocks.

An EventHandler must not have been provided at construction.

This is the same as calling Unsubscribe(IListSubscription, String) with null request label.

Cancel a list of subscriptions.

If the CorrelationID of any entry in the list does not identify a current subscription then that entry is ignored.

See Cancel(CorrelationID) for more information on the handling of cancel requests.