| ProviderSession Methods |
The ProviderSession type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ActivateSubServiceCodeRange |
Activates sub-service code range of the specified
[rangeBegin, rangeEnd]
and the specified priority to an already
registered service.
Numerically greater values of priority indicate higher priorities.The behavior is undefined unless rangeBegin, rangeEnd and priority are between 0 and 2^24 (2 to the power of 24) and the service has already been registered. |
| Cancel(CorrelationID) | Cancels an outstanding request or a subscription represented by the
specified correlationId.
(Inherited from AbstractSession.) |
| Cancel(IListCorrelationID) | Cancels outstanding requests or subscriptions represented by the
specified list of correlationIds.
(Inherited from AbstractSession.) |
| Cancel(CorrelationID, String) | Cancels an outstanding request or a subscription represented by the
specified correlationId.
(Inherited from AbstractSession.) |
| Cancel(IListCorrelationID, String) | Cancels outstanding requests or subscriptions represented by the
specified list of correlationIds.
(Inherited from AbstractSession.) |
| CreateIdentity | Returns a new Identity which is valid but has not been authorized.
(Inherited from AbstractSession.) |
| CreateTopic | Obsolete.
Creates a new Topic object based on the specified 'message'. The
'message' must be one of the following types: SUBSCRIPTION_STARTED,
SUBSCRIPTION_STOPPED, RECAP or RESOLUTION_SUCCESS. If the 'message' is
not valid then invoking isValid() on the returned Topic will return
false.
|
| CreateTopics(ITopicList) |
Creates the topics in the specified 'topicList' and updates the
'topicList' with the results of the resolution and creation process.
The session identity will be used if it's been authorized. |
| CreateTopics(ITopicList, ResolveMode) |
Creates the topics in the specified 'topicList' and updates the
'topicList' with the results of the resolution and creation process.
The session identity will be used if it's been authorized. |
| CreateTopics(ITopicList, ResolveMode, Identity) | Creates the topics in the specified 'topicList' and updates the
'topicList' with the results of the resolution and creation process.
|
| CreateTopicsAsync(ITopicList) |
Begins the creation of the topics in the specified 'topicList'.
The session identity will be used if it's been authorized. |
| CreateTopicsAsync(ITopicList, ResolveMode) |
Begins the creation of the topics in the specified 'topicList'.
The session identity will be used if it's been authorized. |
| CreateTopicsAsync(ITopicList, ResolveMode, Identity) | Begins the creation of the topics in the specified 'topicList'.
|
| CreateUserHandle | Obsolete. Deprecated since 3.3.0.0. Use CreateIdentity instead.
(Inherited from AbstractSession.) |
| DeactivateSubServiceCodeRange |
De-activates sub-service code range specified by
[rangeBegin, rangeEnd] from
to an already registered service. The behavior is undefined unless
rangeBegin and rangeEnd are between
0 and 2^24 (2 to the power of 24) and the service has already been
registered.
|
| DeleteTopic |
Removes one reference from the specified 'topic'.
|
| DeleteTopics |
Deletes each topic in topics.
|
| DeregisterService |
Deregisters the service identified by serviceName |
| Dispose |
Dispose this Session object. It calls AbstractSession.Stop() to
close the opened socket.
(Inherited from AbstractSession.) |
| GenerateAuthorizedIdentity |
Generates an authorized Identity with the specified
authOptions and cid.
(Inherited from AbstractSession.)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.
(Inherited from AbstractSession.) |
| GenerateToken(CorrelationID) | Return a generated token to be used for authorization.
(Inherited from AbstractSession.) |
| GenerateToken(CorrelationID, IEventQueue) | Return a generated token to be used for authorization.
(Inherited from AbstractSession.) |
| GenerateToken(String, String, CorrelationID, IEventQueue) |
Return a generated token to be used for authorization.
(Inherited from AbstractSession.) |
| GetAuthorizedIdentity |
Gets the authorized Identity associated with the
specified cid.
(Inherited from AbstractSession.)If cid is omitted and the session identity is authorized, the function will return the session identity. |
| GetService |
Returns the Service identified by
serviceName.
(Inherited from AbstractSession.) |
| GetTopic | |
| NextEvent | Returns the next event available for processing on this session.
(Inherited from AbstractSession.) |
| NextEvent(Int64) | Returns the next event available for processing on this session.
(Inherited from AbstractSession.) |
| OpenService |
Opens the service identified by serviceName.
(Inherited from AbstractSession.) |
| OpenServiceAsync(String) |
Issues an asynchronous request to open a service.
(Inherited from AbstractSession.) |
| OpenServiceAsync(String, CorrelationID) |
Initiates an asynchronous request to open a service.
(Inherited from AbstractSession.) |
| Publish |
Publish the specified 'event'.
|
| RegisterService(String, Identity) | Attempts to register the service identified by serviceName and blocks until the service is either registered successfully or has failed to be registered. The specified 'providerIdentity' is used to verify permissions to provide the service being registered. Returns true if the service is registered successfully and false if the service cannot be registered successfully. serviceName must be a full qualified service name. That is, it must be of form "//{namespace}/{service-name}". This method does not return until a SERVICE_STATUS event has been generated. Note that if the session was created in asynchronous mode, the event may be processed before the function returns. When providerIdentity is null the session identity will be used if it's been authorized. |
| RegisterService(String, Identity, ServiceRegistrationOptions) | Attempts to register the service identified by serviceName and blocks until the service is either registered successfully or has failed to be registered. providerIdentity is used to verify permissions to provide the service being registered. Returns true if the service is registered successfully and false if the service cannot be registered successfully. serviceName must be a full qualified service name. That is, it must be of form with "//{namespace}/{service-name}". This method does not return until a SERVICE_STATUS event has been generated. Note that if the session was created in asynchronous mode, the event may be processed before the function returns. When providerIdentity is null the session identity will be used if it's been authorized. |
| RegisterServiceAsync(String, Identity) |
Begins the process of registering the service identified by
serviceName with identity and returns immediately.
|
| RegisterServiceAsync(String, Identity, CorrelationID) |
Begins the process of registering the service identified by
serviceName and returns immediately.
When providerIdentity is null the session identity will be used if it's been authorized. |
| RegisterServiceAsync(String, Identity, ServiceRegistrationOptions) |
Begins the process of registering the service identified by
serviceName with identity and
registration options, and returns immediately.
When providerIdentity is null the session identity will be used if it's been authorized. |
| RegisterServiceAsync(String, Identity, CorrelationID, ServiceRegistrationOptions) |
Begins the process of registering the service identified by
serviceName with identity, CorrelationID
and registration options. Returns immediately.
When providerIdentity is null the session identity will be used if it's been authorized. |
| Resolve(IResolutionList) |
Resolves the topics in the specified 'resolutionList' and updates the
'resolutionList' with the results of the resolution process. All services
referenced in the topics in the 'resolutionList' must already have been
registered using RegisterService(). Once Resolve() returns each entry
in the 'resolutionList' will have been updated with a new status.
The session identity will be used if it's been authorized. |
| Resolve(IResolutionList, ResolveMode) |
Resolves the topics in the specified 'resolutionList' and updates the
'resolutionList' with the results of the resolution process.
The session identity will be used if it's been authorized. |
| Resolve(IResolutionList, ResolveMode, Identity) |
Resolves the topics in the specified 'resolutionList' and updates the
'resolutionList' with the results of the resolution process.
|
| ResolveAsync(IResolutionList) |
Begins the resolution of the topics in the specified 'resolutionList'.
The session identity will be used if it's been authorized. |
| ResolveAsync(IResolutionList, ResolveMode) |
Begins the resolution of the topics in the specified 'resolutionList'.
The session identity will be used if it's been authorized. |
| ResolveAsync(IResolutionList, ResolveMode, Identity) | Begins the resolution of the topics in the specified 'resolutionList'.
|
| SendAuthorizationRequest(Request, Identity, CorrelationID) | Sends the specified authorizationRequest and update the specified
identity with the results.
(Inherited from AbstractSession.) |
| SendAuthorizationRequest(Request, UserHandle, CorrelationID) | Obsolete. Deprecated since 3.3.0.0. Use
SendAuthorizationRequest(Request, Identity, CorrelationID)instead.
(Inherited from AbstractSession.) |
| SendAuthorizationRequest(Request, Identity, CorrelationID, String) | Sends the specified authorizationRequest and update the specified
identity with the results.
(Inherited from AbstractSession.) |
| SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID) | Sends the specified authorizationRequest and update the specified
identity with the results.
(Inherited from AbstractSession.) |
| SendAuthorizationRequest(Request, UserHandle, CorrelationID, String) | Obsolete. Deprecated since 3.3.0.0. Use
SendAuthorizationRequest(Request, Identity, CorrelationID, String) instead.
(Inherited from AbstractSession.) |
| SendAuthorizationRequest(Request, UserHandle, IEventQueue, CorrelationID) | Obsolete. Deprecated since 3.3.0.0. Use
SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID) instead.
(Inherited from AbstractSession.) |
| SendAuthorizationRequest(Request, Identity, IEventQueue, CorrelationID, String) | Sends the specified authorizationRequest and update the specified
identity with the results.
(Inherited from AbstractSession.) |
| SendAuthorizationRequest(Request, UserHandle, IEventQueue, CorrelationID, String) | Obsolete. Deprecated since 3.3.0.0. Use
SendAuthorizationRequest(Request, UserHandle, IEventQueue, CorrelationID, String) instead.
(Inherited from AbstractSession.) |
| SendResponse(Event) |
Sends the response event for previously received request
|
| SendResponse(Event, Boolean) |
Sends the response event for previously received request
|
| SetEventHandler | Sets event specific event handlers
|
| Start |
Issues a blocking call to start the session.
(Inherited from AbstractSession.) |
| StartAsync |
Initiates a non blocking call to start the session.
(Inherited from AbstractSession.) |
| Stop | Stops this session.
(Inherited from AbstractSession.) |
| Stop(AbstractSessionStopOption) | Stops the operation of this session.
(Inherited from AbstractSession.) |
| TryNextEvent | Tries to retrieve the next event available for processing
on this session
(Inherited from AbstractSession.) |
See Also