ISession.Unsubscribe Method (ITopicEndpoint, Int32)

Solclient

previous page next page

Solclient

ISessionUnsubscribe Method (ITopicEndpoint, Int32)

version: 7.2.1.27

Note: This API is now obsolete.

Unsubscribes from a durable Topic Endpoint.

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

[ObsoleteAttribute("Use Unsubscribe(ITopicEndpoint,object) instead ", 
	false)]
ReturnCode Unsubscribe(
	ITopicEndpoint dte,
	int correlationId
)

<ObsoleteAttribute("Use Unsubscribe(ITopicEndpoint,object) instead ", 
	false)>
Function Unsubscribe ( 
	dte As ITopicEndpoint,
	correlationId As Integer
) As ReturnCode

[ObsoleteAttribute(L"Use Unsubscribe(ITopicEndpoint,object) instead ", 
	false)]
ReturnCode Unsubscribe(
	ITopicEndpoint^ dte, 
	int correlationId
)

Parameters

dte: Type: SolaceSystems.Solclient.MessagingITopicEndpoint
The durable Topic Endpoint to unsubscribe from.
correlationId: Type: SystemInt32
Correlation Id used in the unsubscribe request and returned in the session event CorrelationKey. Valid values are within [1..16777215]. A value of 0 (zero) indicates that correlationId is not to be returned (in this case CorrelationKey will be null). Any other value outside of the previously stated values will cause an ArgumentOutOfRangeException exception to be thrown.

Return Value

Type: ReturnCode
The return code from the unsubscribe request.

Exceptions

Exception	Condition
OperationErrorException	Thrown when the operation fails.
ObjectDisposedException	Thrown when the session is already disposed (terminal state).
FatalErrorException	Thrown when an unrecoverable error occurs.
ArgumentNullException	Thrown if any of the required parameters is null.
ArgumentOutOfRangeException	Thrown if correlationId is out of range.

Reference

ISession Interface

Unsubscribe 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