tpunsubscribe(3c)

Name

tpunsubscribe()—Unsubscribes to an event.

Synopsis

#include <atmi.h> 
int tpunsubscribe(long subscription, long flags)

Description

The caller uses tpunsubscribe() to remove an event subscription or a set of event subscriptions from the BEA Tuxedo EventBroker's list of active subscriptions. subscription is an event subscription handle returned by tpsubscribe(). Setting subscription to the wildcard value, -1, directs tpunsubscribe() to unsubscribe to all non-persistent subscriptions previously made by the calling process. Non-persistent subscriptions are those made without the TPEVPERSIST bit setting in the ctl—>flags parameter of tpsubscribe(). Persistent subscriptions can be deleted only by using the handle returned by tpsubscribe().

Note that the -1 handle removes only those subscriptions made by the calling process and not any made by previous instantiations of the caller (for example, a server that dies and restarts cannot use the wildcard to unsubscribe to any subscriptions made by the original server).

The following is a list of valid flags:

In a multithreaded application, a thread in the TPINVALIDCONTEXT state is not allowed to issue a call to tpunsubscribe().

Return Values

Upon completion of tpunsubscribe(), tpurcode() contains the number of subscriptions deleted (zero or greater) from the EventBroker's list of active subscriptions. tpurcode() may contain a number greater than 1 only when the wildcard handle, -1, is used. Also, tpurcode() may contain a number greater than 0 even when tpunsubscribe() completes unsuccessfully (that is, when the wildcard handle is used, the EventBroker may have successfully removed some subscriptions before it encountered an error deleting others).

Upon failure, tpunsubscribe() returns -1 and sets tperrno() to indicate the error condition.

Errors

Upon failure, tpunsubscribe() sets tperrno() to one of the following values. (Unless otherwise noted, failure does not affect the caller's transaction, if one exists.)

See Also