13.32 Subscriptionクラス
Subscriptionクラスは、通知に対するサブスクライバの登録に必要な情報と操作をカプセル化します。
表13-47 Subscriptionクラスで使用される列挙値
属性 | オプション |
---|---|
Presentation |
|
Protocol |
|
Namespace |
|
表13-48 Subscriptionメソッドの概要
メソッド | 概要 |
---|---|
|
|
コールバックのコンテキストを取り出します。 |
|
クライアントが登録する可能性のあるデータベース・サーバーの数を取得します。 |
|
クライアントが通知対象を登録した全データベース・サーバーの名前を戻します。 |
|
登録済コールバック関数へのポインタを戻します。 |
|
ポスティング前に |
|
|
|
|
|
|
|
通知表示モードを取り出します。 |
|
通知プロトコルを取り出します。 |
|
|
|
|
|
OCIプロトコル用のコールバック関数を登録します。 |
|
クライアントに通知を送信するデータベース・サーバーの識別名を指定します。 |
|
ユーザー・コールバックに渡されるコンテキストを指定します。 |
|
|
|
サブスクリプション名を指定します。 |
|
サブスクリプションが使用されるネームスペースを指定します。 |
|
通知のバッファの内容を指定します。 |
|
通知受信者の名前を指定します。 |
|
クライアントで通知の受信に使用する表示モードを指定します。 |
|
クライアントで通知の受信に使用するプロトコルを指定します。 |
|
サブスクリプション名を指定します。 |
|
サブスクリプションが使用されるネームスペースを指定します。 |
|
通知受信者の名前を指定します。 |
13.32.1 Subscription()
Subscription
クラスのコンストラクタです。
構文 | 説明 |
---|---|
Subscription ( const Environment *env ); |
指定された |
Subscription( const Subscription& sub); |
コピー・コンストラクタです。 |
構文
Subscription(const Subscription& sub);
パラメータ | 説明 |
---|---|
env |
|
sub |
元の |
13.32.3 getDatabaseServersCount()
クライアントが登録する可能性のあるデータベース・サーバーの数を取り出します。
構文
unsigned int getDatabaseServersCount() const;
13.32.4 getDatabaseServerNames()
クライアントが通知対象を登録した全データベース・サーバーの名前を戻します。
構文
vector<string> getDatabaseServerNames() const;
13.32.5 getNotifyCallback()
このSubscription
の登録済コールバック関数へのポインタを戻します。
構文
unsigned int (*getNotifyCallback() const)( Subscription& sub, NotifyResult *nr);
パラメータ | 説明 |
---|---|
sub |
|
nr |
|
13.32.8 getSubscriptionNamespace()
サブスクリプションのネームスペースを取り出します。サブスクリプション名には、ネームスペースとの一貫性が必要です。有効なNamespace
の値は、NS_AQ
およびNS_ANONYMOUS
です(表13-47の定義を参照)。
構文
Namespace getSubscriptionNamespace() const;
13.32.9 getRecipientName()
通知受信者の名前を取得します。可能な戻り値は、プロトコルに応じて電子メール・アドレス、HTTPのURLおよびPL/SQLプロシージャです。
構文
string getRecipientName() const;
13.32.10 getPresentation()
クライアントで通知の受信に使用する表示モードを取得します。有効なPresentation
値は、表13-47の定義を参照してください。
構文
Presentation getPresentation() const;
13.32.13 operator=()
Subscription
の代入演算子です。
構文
void operator=( const Subscription& sub);
パラメータ | 説明 |
---|---|
sub |
元の |
13.32.14 setCallbackContext()
プロトコルがPROTO_CBK
の場合に通知コールバック関数を登録します。表13-47の定義を参照してください。このコールにはコンテキスト登録も含まれます。
構文
void setCallbackContext( void *ctx);
パラメータ | 説明 |
---|---|
ctx |
設定するコンテキストを指定します。 |
13.32.15 setDatabaseServerNames()
クライアントに通知を送信するデータベース・サーバーの識別名のリストを指定します。
構文
void setDatabaseServerNames( const vector<string>& dbsrv);
パラメータ | 説明 |
---|---|
dbsrv |
データベース識別名のリストを指定します。 |
13.32.16 setNotifyCallback()
クライアントでユーザー・コールバックに渡すコンテキストを設定します。プロトコルがPROTO_CBK
に設定されているか未指定の場合、サブスクリプション・ハンドルを登録する前に、この属性を設定する必要があります。
構文
void setNotifyCallback( unsigned int (*callback)( Subscription& sub, NotifyResult *nr));
パラメータ | 説明 |
---|---|
callback |
ユーザー・コールバック関数を指定します。 |
sub |
|
nr |
|
13.32.18 setPayload()
Subscription
にポストされるペイロードに対応するバッファの内容を設定します。
構文
void setPayload( const Bytes& payload);
パラメータ | 説明 |
---|---|
payload |
通知の内容を指定します。 |
13.32.19 setPresentation()
クライアントで通知の受信に使用する表示モードを設定します。
構文
void setPresentation( Presentation pres);
パラメータ | 説明 |
---|---|
pres |
表示モードは、表13-47の定義を参照してください。 |
13.32.20 setProtocol()
クライアントでイベント通知の受信に使用するProtocol
を設定します。表13-47の定義を参照してください。
構文
void setProtocol( Protocol prot);
パラメータ | 説明 |
---|---|
prot |
プロトコルのモードを指定します。 |
13.32.21 setSubscriptionName()
サブスクリプションの名前を設定します。すべてのサブスクリプションはサブスクリプション名で識別され、サブスクリプション名は指定の長さのバイト・シーケンスで構成されます。
ネームスペースがNS_AQ
の場合、サブスクリプション名は次のようになります。
-
シングル・コンシューマ・キューで登録する場合は
SCHEMA.QUEUE
-
マルチ・コンシューマ・キューで登録する場合は
SCHEMA.QUEUE:CONSUMER_NAME
構文
void setSubscriptionName( const string& name);
パラメータ | 説明 |
---|---|
name |
サブスクリプション名を指定します。 |
13.32.22 setSubscriptionNamespace()
サブスクリプションが使用されるネームスペースを指定します。サブスクリプション名には、ネームスペースとの一貫性が必要です。デフォルト値はNS_AQ
です。
構文
void setSubscriptionNamespace( Namespace nameSpace);
パラメータ | 説明 |
---|---|
nameSpace |
サブスクリプションが使用されるネームスペースを指定します。表13-47の定義を参照してください。 |