Messageクラス

メッセージは、エンキューおよびデキューの単位です。Messageオブジェクトは、その内容またはペイロードと、プロパティを保持します。このクラスは、メッセージ・プロパティを取得および設定するメソッドを提供します。

表13-24 Messageクラスで使用される列挙値

属性	オプション
MessageState	`MSG_WAITING`は、メッセージ遅延時間に達していないことを示します。 `MSG_READY`は、メッセージの処理準備が完了していることを示します。 `MSG_PROCESSED`は、メッセージが処理済で保持中であることを示します。 `MSG_EXPIRED`は、メッセージが例外キューに移動されたことを示します。
PayloadType	`RAW` `ANYDATA` `OBJECT`

表13-25 Messageメソッドの概要

メソッド	概要
Message()	`Message`クラスのコンストラクタです。
getAnyData()	メッセージの`AnyData`のペイロードを取り出します。
getAttemptsToDequeue()	メッセージのデキュー試行回数を取り出します。
getBytes()	メッセージの`Bytes`のペイロードを取り出します。
getCorrelationId()	識別文字列を取り出します。
getDelay()	メッセージのエンキュー時の遅延を取り出します。
getExceptionQueueName()	処理できない`Message`の移動先キューの名前を取り出します。
getExpiration()	メッセージの期限切れを取り出します。
getMessageEnqueuedTime()	メッセージのエンキュー時刻を取り出します。
getMessageState()	エンキュー時のメッセージの状態を取り出します。
getObject()	メッセージのオブジェクトのペイロードを取り出します。
getOriginalMessageId()	最後のキューでこのメッセージを生成したメッセージのIDを取り出します。
getPayloadType()	ペイロードの型を取り出します。
getPriority()	メッセージの優先順位を取り出します。
getSenderId()	`Message`を送信したエージェントを取り出します。
isNull()	`Message`オブジェクトが`NULL`かどうかをテストします。
operator=()	`Message`の代入演算子です。
setAnyData()	メッセージの`AnyData`のペイロードを指定します。
setBytes()	メッセージの`Bytes`のペイロードを指定します。
setCorrelationId()	識別文字列を指定します。
setDelay()	エンキューされた`Message`の遅延秒数を指定します。
setExceptionQueueName()	処理できない`Message`オブジェクトの移動先キューの名前を指定します。
setExpiration()	期限切れになるまでに`Message`をデキューできる期間を指定します。
setNull()	`Message`オブジェクトを`NULL`に設定します。
setObject()	メッセージのオブジェクトのペイロードを指定します。
setOriginalMessageId()	`Message`を生成した最後のキューのIDを指定します。
setPriority()	`Message`オブジェクトの優先順位を指定します。
setRecipientList()	メッセージの宛先であるエージェントのリストを指定します。
setSenderId()	`Message`の送信者を指定します。

Message()

Messageクラスのコンストラクタです。

構文	説明
Message( const Environment *env);	指定された`Environment`内で`Message`オブジェクトを作成します。
Message( const Message& mes);	コピー・コンストラクタです。

パラメータ	説明
env	`Message`の環境を指定します。
mes	オリジナルの`Message`オブジェクトです。

getAnyData()

MessageのAnyDataのペイロードを取り出します。

構文

AnyData getAnyData() const;

getAttemptsToDequeue()

メッセージのデキュー試行回数を取り出します。エンキュー時には、このプロパティを取り出せません。

構文

int getAttemptsToDequeue() const;

getBytes()

MessageのBytesのペイロードを取り出します。

構文

Bytes getBytes() const;

getCorrelationId()

識別文字列を取り出します。

構文

string getCorrelationId() const;

getDelay()

Messageのエンキュー時の遅延秒数を取り出します。

構文

int getDelay() const;

getExceptionQueueName()

Messageを正常に処理できない場合に、Messageの移動先となるキューの名前を取り出します。

構文

string getExceptionQueueName() const;

getExpiration()

Messageの有効期間（秒数）を取り出します。この期間中はメッセージをデキューできます。

構文

int getExpiration() const;

getMessageEnqueuedTime()

メッセージのエンキュー時刻をDate書式で取り出します。この値はシステムにより決定され、ユーザーは設定できません。

構文

Date getMessageEnqueuedTime() const;

getMessageState()

エンキュー時のメッセージの状態を取り出します。このパラメータではエンキュー時刻を設定できません。MessageStateの定義は、表13-24を参照してください。

構文

MessageState getMessageState() const;

getObject()

Messageのオブジェクトのペイロードを取り出します。

構文

PObject* getObject();

getOriginalMessageId()

オリジナルのメッセージIDを取り出します。あるキューから別のキューにメッセージが伝播されたとき、伝播後のメッセージの生成元メッセージのIDを最後のキューに取得します。

構文

Bytes getOriginalMessageId() const;

getPayloadType()

ペイロードの型を取り出します。表13-24のPayloadTypeを参照してください。

構文

PayloadType getPayloadType( ) const;

getPriority()

Messageの優先順位を取り出します。

構文

int getPriority() const;

getSenderId()

Messageを送信したエージェントを取り出します。

構文

Agent getSenderId() const;

isNull()

MessageオブジェクトがNULLかどうかをテストします。MessageオブジェクトがNULLの場合はTRUEを、それ以外の場合はFALSEを戻します。

構文

bool isNull() const;

operator=()

Messageの代入演算子です。

void operator=(
   const Message& mes);

パラメータ	説明
mes	オリジナルのメッセージを指定します。

setAnyData()

MessageのAnyDataのペイロードを指定します。

構文

void setAnyData(
   const AnyData& anydata);

パラメータ	説明
anydata	`Message`のデータの内容を指定します。

setBytes()

MessageのBytesのペイロードを指定します。

構文

void setBytes(
   const Bytes& bytes);

パラメータ	説明
bytes	`Message`のデータの内容を指定します。

setCorrelationId()

識別文字列を指定します。このパラメータは、エンキュー時にProducerにより設定されます。メッセージは、このIDを使用してデキューできます。IDには、ワイルドカード文字を含めることができます。

構文

void setCorrelationId(
   const string& id);

パラメータ	説明
id	IDを指定します。上限は`128`バイトです。

setDelay()

エンキューされたMessageの遅延秒数を指定します。遅延終了後は、Messageをデキューできます。

注意:

msgidによりデキューする場合は、遅延指定がオーバーライドされます。遅延付きでエンキューされたMessageは、WAITING状態になります。遅延は、Messageのプロデューサにより設定されます。

構文

void setDelay(
   int delay);

パラメータ	説明
delay	遅延を指定します。

setExceptionQueueName()

正常に処理できないMessageオブジェクトの移動先キューの名前を指定します。有効なキュー名を指定する必要があります。

注意:

移動時に例外キューが存在しなければ、Message はキュー表に関連付けられているデフォルトの例外キューに移動し、アラート・ファイルに警告が記録されます。
デフォルトの例外キューが使用される場合、パラメータはエンキュー時にNULL値を戻します。属性では有効なキュー名を参照する必要があります。

構文

void setExceptionQueueName(
   const string& queue);

パラメータ	説明
queue	例外キューの名前を指定します。

setExpiration()

Messageオブジェクトをデキューできる有効期間を秒単位で指定します。この期間をすぎると、Messageは期限切れになります。

構文

void setExpiration(
   int exp);

パラメータ	説明
exp	有効期間を指定します。

setNull()

MessageオブジェクトをNULLに設定します。EnvironmentクラスのterminateConnection()のコールによりConnectionが破棄される前に、すべてのMessageオブジェクトをNULLに設定する必要があります。

構文

void setNull();

setObject()

Messageのオブジェクトのペイロードを指定します。

構文

void setObject(
   PObject& pobj);

パラメータ	説明
pobj	データの内容を指定します。

setOriginalMessageId()

あるキューから別のキューにメッセージが伝播されたとき、伝播後のメッセージの生成元メッセージのIDを最後のキューに設定します。

構文

void setOriginalMessageId(
   const Bytes& queue);

パラメータ	説明
queue	最後のキューを指定します。

setPriority()

Messageオブジェクトの優先順位を指定します。この優先順位はエンキュー時に設定され、負の値に設定できます。デフォルトは0（ゼロ）です。

構文

void setPriority(
   int priority);

パラメータ	説明
priority	`Message`の優先順位を指定します。

setRecipientList()

Messageの宛先であるAgentのリストを指定します。これらの受信者は、キューのサブスクライバとは異なります。このプロパティはエンキュー時に設定されます。リスト内のAgentがすべて有効である必要があります。受信者リストによりデフォルトのサブスクライバ・リストがオーバーライドされます。

構文

void setRecipientList(
   vector<Agent>& agentList);

パラメータ	説明
agentList	`Agent`のリストを指定します。

setSenderId()

Messageの送信者を指定します。

構文

void setSenderId(
   const Agent& sender);

パラメータ	説明
sender	送信者IDを指定します。