CORBA Notification Service API Reference

e-docs > Tuxedo > Using the CORBA Notification Service > CORBA Notification Service API Reference

Using the CORBA Notification Service

Channel::unsubscribe

CORBA IDL

void unsubscribe( in SubscriptionID id );

Parameter

subscription_id

The subscription identifier.

Exceptions

CORBA::BAD_PARAM

Indicates the following problem: Tobj_Events::INVALID_SUBSCRIPTION_ID

Note: For more information on exceptions and corresponding minor codes, see "Exception Minor Codes" on page 2-66.

Description

Used to unsubscribe. Subscriber applications use this operation to terminate subscriptions. On return from this operation, no further events can be delivered. There is one input parameter: SubscriptionID, which you got when you subscribed.

Note: This operation is not instantaneous. After returning from this operation, a subscriber may continue to receive events for a period of time. The period of time may be significant depending on your configuration. For more information on factors impacting this period of time, see "Synchronizing Databases" on page 7-24.

Examples

C++ code example:

channel->unsubscribe(subscription_id);

Java code example:

channel.unsubscribe(subscription_id);