IMessageDispatcher.Unsubscribe Method

Solclient

previous page next page

Solclient

IMessageDispatcherUnsubscribe Method

version: 7.2.1.27

Removes an IDispatchTarget subscription from the given IMessageDispatcher.

Note: To use this feature, the parent ISession's SessionProperties must have TopicDispatch set to true.

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 Unsubscribe(
	IDispatchTarget dispatchTarget,
	int flags,
	Object correlationKey
)

Function Unsubscribe ( 
	dispatchTarget As IDispatchTarget,
	flags As Integer,
	correlationKey As Object
) As ReturnCode

ReturnCode Unsubscribe(
	IDispatchTarget^ dispatchTarget, 
	int flags, 
	Object^ correlationKey
)

Parameters

dispatchTarget: Type: SolaceSystems.Solclient.MessagingIDispatchTarget
flags: 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, WaitForConfirm and LocalDispatchOnly. If LocalDispatchOnly is used, it should be the only flag in the set.
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, if the operation cannot be accepted by the API immediately, SOLCLIENT_OK if successful, or SOLCLIENT_IN_PROGRESS if in progress.

Exceptions

Exception	Condition
OperationErrorException	Thrown when the Unsubscribe operation fails. More details are available in the fields of the OperationErrorException. Possible sub-codes: InvalidTopicSyntax InvalidSessionOperation SubscriptionNotFound SubscriptionOther Topic dispatch is not enabled for transacted flows InvalidFlowOperation
ObjectDisposedException	Thrown when the session is already disposed (terminal state).
FatalErrorException	Thrown when an unrecoverable error occurs.
ArgumentNullException	Thrown if dispatchTarget is null.

Reference

IMessageDispatcher Interface

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