Subscription Class

The subscription class encapsulates the information and operations necessary for registering a subscriber for notification.

Presentation

Protocol

Namespace

Subscription()

Subscription class constructor.

Subscription (
   const Environment *env );

Subscription(
   const Subscription& sub);

LNCPP21804Syntax

Subscription(const Subscription& sub);

env

sub

getCallbackContext()

Retrieves the callback context.

LNCPP21806Syntax

void* getCallbackContext() const;

getDatabaseServersCount()

Returns the number of database servers in which the client is interested for the registration.

LNCPP21808Syntax

unsigned int getDatabaseServersCount() const;

getDatabaseServerNames()

Returns the names of all the database servers where the client registered an interest for notification.

LNCPP21810Syntax

vector<string> getDatabaseServerNames() const;

getNotifyCallback()

Returns the pointer to the callback function registered for this Subscription.

LNCPP21812Syntax

unsigned int (*getNotifyCallback() const)(
   Subscription& sub,
   NotifyResult *nr);

sub

nr

getPayload()

Retrieves the payload that has been set on the Subscription object before posting.

LNCPP21814Syntax

Bytes getCPayload() const;

getSubscriptionName()

Retrieves the name of the subscription.

LNCPP21816Syntax

string getSubscriptionName() const;

getSubscriptionNamespace()

Retrieves the namespace of the subscription. The subscription name must be consistent with its namespace. Valid Namespace values are NS_AQ and NS_ANONYMOUS, as defined in Table 13-47.

LNCPP21818Syntax

Namespace getSubscriptionNamespace() const;

getRecipientName()

Retrieves the name of the recipient of the notification. Possible return values are E-mail address, the HTTP url and the PL/SQL procedure, depending on the protocol.

LNCPP21820Syntax

string getRecipientName() const;

getPresentation()

Retrieves the presentation mode in which the client receives notifications. Valid Presentation values are defined in Table 13-47.

LNCPP21822Syntax

Presentation getPresentation() const;

getProtocol()

Retrieves the protocol in which the client receives notifications. Valid Protocol values are defined in Table 13-47.

LNCPP21824Syntax

Protocol getProtocol() const;

isNull()

Returns TRUE if Subscription is NULL or FALSE otherwise.

LNCPP21826Syntax

bool isNull() const;

operator=()

Assignment operator for Subscription.

LNCPP21828Syntax

void operator=(
   const Subscription& sub); 

sub

setCallbackContext()

Registers a notification callback function when the protocol is PROTO_CBK, as defined in Table 13-47. Context registration is also included in this call.

LNCPP21830Syntax

void setCallbackContext(
   void *ctx);

ctx

setDatabaseServerNames()

Specifies the list of database server distinguished names from which the client receives notifications.

LNCPP21832Syntax

void setDatabaseServerNames(
   const vector<string>& dbsrv);

dbsrv

setNotifyCallback()

Sets the context that the client wants to get passed to the user callback. If the protocol is set to PROTO_CBK or not specified, this attribute must be set before registering the subscription handle.

LNCPP21834Syntax

void setNotifyCallback( 
   unsigned int (*callback)(
                    Subscription& sub,
                    NotifyResult *nr));

callback

sub

nr

setNull()

Sets the Subscription object to NULL and frees the memory associated with the object.

LNCPP21836Syntax

void setNull();

setPayload()

Sets the buffer content that corresponds to the payload to be posted to the Subscription.

LNCPP21838Syntax

void setPayload(
   const Bytes& payload);

payload

setPresentation()

Sets the presentation mode in which the client receives notifications.

LNCPP21840Syntax

void setPresentation(
   Presentation pres);

pres

setProtocol()

Sets the Protocol in which the client receives event notifications, as defined in Table 13-47.

LNCPP21842Syntax

void setProtocol(
   Protocol prot);

prot

setSubscriptionName()

Sets the name of the subscription. All subscriptions are identified by a subscription name, which consists of a sequence of bytes of specified length.

If the namespace is NS_AQ, the subscription name is:

• SCHEMA.QUEUE when registering on a single consumer queue

• SCHEMA.QUEUE:CONSUMER_NAME when registering on a multiconsumer queue

LNCPP21844Syntax

void setSubscriptionName(
   const string& name);

name

setSubscriptionNamespace()

Sets the namespace where the subscription is used. The subscription name must be consistent with its namespace. Default value is NS_AQ.

LNCPP21846Syntax

void setSubscriptionNamespace(
   Namespace nameSpace);

nameSpace

setRecipientName()

Sets the name of the recipient of the notification.

LNCPP21848Syntax

void setRecipientName( 
   const string& name);

name