ISession.Subscribe Method (ISubscription, Boolean)

Solclient

ISessionSubscribe Method (ISubscription, Boolean)
version: 7.2.1.27
Registers a subscription to the appliance. When the appliance is running SolOS-TR, a Topic is required.

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)
Syntax
ReturnCode Subscribe(
	ISubscription subscription,
	bool waitForConfirm
)
Function Subscribe ( 
	subscription As ISubscription,
	waitForConfirm As Boolean
) As ReturnCode
ReturnCode Subscribe(
	ISubscription^ subscription, 
	bool waitForConfirm
)

Parameters

subscription
Type: SolaceSystems.Solclient.MessagingISubscription
The subscription to subscribe to.
waitForConfirm
Type: SystemBoolean
If true, this call blocks the calling thread until a confirmation is received from the appliance.

Return Value

Type: ReturnCode
SOLCLIENT_WOULD_BLOCK, if the subscription cannot be accepted by the API immediately, or SOLCLIENT_OK or SOLCLIENT_IN_PROGRESS
Exceptions
ExceptionCondition
OperationErrorException Thrown when the Subscribe operation fails. Possible sub-codes:
ObjectDisposedException Thrown when the session is already disposed (terminal state).
FatalErrorException Thrown when an unrecoverable error occurs.
ArgumentNullException Thrown if subscription is null.
See Also