ISession.Subscribe Method (IEndpoint, ISubscription, Int32, Object)

Solclient

ISessionSubscribe Method (IEndpoint, ISubscription, Int32, Object)

version: 7.2.1.27

Add a ITopic subscription on the endpoint if the operation is supported on the endpoint (Only endpoints of type IQueue or type IClientName support this operation).

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)

Syntax

C++

Copy

ReturnCode Subscribe(
	IEndpoint endpoint,
	ISubscription subscription,
	int subscribeFlags,
	Object correlationKey
)

Function Subscribe ( 
	endpoint As IEndpoint,
	subscription As ISubscription,
	subscribeFlags As Integer,
	correlationKey As Object
) As ReturnCode

ReturnCode Subscribe(
	IEndpoint^ endpoint, 
	ISubscription^ subscription, 
	int subscribeFlags, 
	Object^ correlationKey
)

Parameters

endpoint: Type: SolaceSystems.Solclient.MessagingIEndpoint
The endpoint to add the subscription on (must be of type IQueue or type IClientName). When authorized, a session can add subscriptions to any queue or to other sessions as identified by ClientName.
subscription: Type: SolaceSystems.Solclient.MessagingISubscription
Only subscriptions of type ITopic are supported
subscribeFlags: Type: SystemInt32
Possible values are: 0, this signals to the API not to request or wait for a confirmation One or more flags from SubscribeFlag ORed. Valid flags are RequestConfirm and WaitForConfirm
correlationKey: Type: SystemObject
If subscribeFlags is RequestConfirm, client applications can specify a non-null correlationKey object reference which is returned to the application as a CorrelationKey field within a SessionEventArgs event.

Return Value

Type: ReturnCode
SOLCLIENT_WOULD_BLOCK or SOLCLIENT_OK or SOLCLIENT_IN_PROGRESS

Exceptions

Exception	Condition
OperationErrorException	Thrown when the Subscribe operation fails, more information will be available in the OperationErrorException fields. Possible sub-codes: Timeout CommunicationError UnknownQueueName UnknownClientName
ObjectDisposedException	Thrown when the session is already disposed (terminal state).
FatalErrorException	Thrown when an unrecoverable error occurs.
ArgumentNullException	Thrown if subscription is null.

Reference

ISession Interface

Subscribe Overload

SolaceSystems.Solclient.Messaging Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page