13.12 Consumerクラス
Consumer
クラスはMessage
のデキューをサポートし、デキュー・オプションを制御します。
表13-14 Consumerクラスで使用される列挙値
属性 | オプション |
---|---|
DequeMode |
|
Navigation |
|
Visibility |
|
DequeWaitOption |
|
表13-15 Consumerメソッドの概要
メソッド | 説明 |
---|---|
|
|
|
|
デキューするメッセージの相関識別子を取得します。 |
|
|
|
デキューされるメッセージのIDを取得します。 |
|
コンシューマで使用するキューの名前を取得します。 |
|
デキューされるメッセージの位置を取得します。 |
|
|
|
デキュー操作のトランザクション動作を取得します。 |
|
検索基準と一致する |
|
|
|
|
|
|
|
コンシューマの |
|
|
|
デキューするメッセージの相関IDを指定します。 |
|
デキューに関連付けられているロック動作を指定します。 |
|
デキューする |
|
|
|
取得する |
|
|
|
|
|
|
|
基準と一致する |
13.12.1 Consumer()
Consumerクラスのコンストラクタです。
構文 | 説明 |
---|---|
Consumer( const Connection *conn); |
指定した |
Consumer( const Connection *conn const Agent& agent); |
指定した |
Consumer( const Connection *conn, const string& queue); |
指定した |
Consumer( const Consumer& consumer); |
コピー・コンストラクタです。 |
パラメータ | 説明 |
---|---|
conn |
|
agent |
|
queue |
|
consumer |
オリジナルの |
13.12.6 getPositionOfMessage()
デキューされるメッセージの位置またはナビゲーションを取得します。Navigation
の定義は、表13-14を参照してください。
構文
Navigation getPositionOfMessage() const;
13.12.10 getWaitTime()
検索基準と一致するMessage
を待機するときの、Consumer
の指定の動作を取得します。DequeWaitOption
の定義は、表13-14を参照してください。
構文
DequeWaitOption getWaitTime() const;
13.12.11 isNull()
Consumer
オブジェクトがNULL
かどうかをテストします。Consumer
オブジェクトがNULL
の場合はTRUE
を、それ以外の場合はFALSE
を戻します。
構文
bool isNull() const;
13.12.12 operator=()
Consumer
クラスの代入演算子です。
構文
void operator=( const Consumer& consumer);
パラメータ | 説明 |
---|---|
consumer |
オリジナルの |
13.12.13 receive()
Message
を受信してデキューします。
構文
Message receive( Message::PayloadType pType, const string& type="", const string& schema="");
パラメータ | 説明 |
---|---|
pType |
受信するペイロードの型を指定します。ペイロード型は表13-14に定義されています。 |
type |
|
schema |
型が定義されているスキーマを指定します( |
13.12.14 setAgent()
コンシューマのAgent
の名前とアドレス(キュー名)を設定します。
構文
void setAgent( const Agent& agent);
パラメータ | 説明 |
---|---|
agent |
|
13.12.15 setConsumerName()
Consumer
の名前を設定します。コンシューマ名が一致するメッセージにのみアクセスできます。キューが複数のコンシューマ用に設定されていない場合は、このオプションをNULL
に設定する必要があります。
構文
void setConsumerName( const string& name);
パラメータ | 説明 |
---|---|
name |
|
13.12.16 setCorrelationId()
デキューするメッセージの相関IDを指定します。パーセント記号(%)やアンダースコア(_)など、特殊なパターン一致文字を使用できます。複数のメッセージがパターンと一致する場合、デキュー順序は不定になります。
構文
void setCorrelationId const string& id);
パラメータ | 説明 |
---|---|
id |
|
13.12.17 setDequeueMode()
デキューに関連付けられているロック動作を指定します。
構文
void setDequeueMode( DequeueMode mode);
パラメータ | 説明 |
---|---|
mode |
エンキュー動作を指定します。 |
13.12.18 setMessageIdToDequeue()
デキューするMessage
の識別子を指定します。
構文
void setMessageIdToDequeue( const Bytes& msgid);
パラメータ | 説明 |
---|---|
msgid |
デキューする |
13.12.20 setPositionOfMessage()
取得するMessage
の位置を指定します。
構文
void setPositionOfMessage( Navigation pos);
パラメータ | 説明 |
---|---|
pos |
メッセージの位置、 |
13.12.21 setQueueName()
Message
のデキュー前にキューの名前を指定します。通常は、同じキューから複数のメッセージをデキューする場合に使用します。
構文
void setQueueName( const string& queue);
パラメータ | 説明 |
---|---|
queue |
データベース内で有効なキューの名前を指定します。 |
13.12.22 setTransformation()
Message
のデキュー前に適用される変換を指定します。
構文
void setTransformation( string &fName);
パラメータ | 説明 |
---|---|
fName |
SQL変換関数を指定します。 |
13.12.23 setVisibility()
Message
を現行のトランザクションの一部としてデキューする必要があるかどうかを指定します。DEQ_BROWSE
モードの場合、可視性パラメータは無視されます。
構文
void setVisibility( Visibility option);
パラメータ | 説明 |
---|---|
option |
設定するVisibilityオプションの定義は、表13-14を参照してください。 |
13.12.24 setWaitTime()
基準と一致するMessage
がない場合の待機条件を指定します。同じグループのメッセージをデキューする場合、wait
パラメータは無視されます。
構文
void setWaitTime( DequeWaitOption wait);
パラメータ | 説明 |
---|---|
wait |
待機条件を指定します。 |