ISession.Subscribe Method (ISubscription, Boolean)

Solclient

previous page next page

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

C++

Copy

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

Exception	Condition
OperationErrorException	Thrown when the Subscribe operation fails. Possible sub-codes: InvalidTopicSyntax SubscriptionACLDenied SessionNotEstablished Timeout CommunicationError OutOfResources SubscriptionAlreadyPresent SubscriptionTooMany SubscriptionACLDenied SubscriptionOther
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