OracleAQMessageAvailableEventArgsクラス

OracleAQMessageAvailableEventArgsクラスは、OracleAQQueue.MessageAvailableイベントのイベント・データを提供します。

クラスの継承

System.Object

System.EventArgs

Oracle.DataAccess.Client.OracleAQMessageAvailableEventArgs

宣言

// C#
public sealed class OracleAQMessageAvailableEventArgs

要件

プロバイダ	ODP.NET管理対象外ドライバ
アセンブリ	`Oracle.DataAccess.dll`
ネームスペース	`Oracle.DataAccess.Client`
.NET Framework	3.5, 4.0, 4.5, 4.6

スレッド安全性

パブリック静的メソッドはスレッドセーフですが、インスタンス・メソッドではスレッド安全性は保証されません。

備考

このクラスは継承できません。

すべての継承プロパティおよびメソッドの詳細は、Microsoftの.NETドキュメントに用意されているドキュメントをお読みください。

関連項目:

「Oracle.DataAccess.ClientおよびOracle.ManagedDataAccess.Clientのネームスペース」
OracleAQMessageAvailableEventArgsメンバー
OracleAQMessageAvailableEventArgsコンストラクタ
OracleAQMessageAvailableEventArgsプロパティ

OracleAQMessageAvailableEventArgsメンバー

OracleAQMessageAvailableEventArgsメンバーを、次の各表に示します。

OracleAQMessageAvailableEventArgsコンストラクタ

OracleAQMessageAvailableEventArgsプロパティを、表12-17にリストします。

表12-17 OracleAQMessageAvailableEventArgsコンストラクタ

プロパティ	説明
OracleAQMessageAvailableEventArgsコンストラクタ	OracleAQMessageAvailableEventArgsクラスの新規インスタンスをインスタンス化します。

OracleAQMessageAvailableEventArgsプロパティ

OracleAQMessageAvailableEventArgsプロパティを、表12-18にリストします。

表12-18 OracleAQMessageAvailableEventArgsプロパティ

プロパティ	説明
AvailableMessages	この通知が発生したメッセージの数を指定します。
ConsumerName	デキュー可能なメッセージのコンシューマの名前を示します。
Correlation	デキュー可能なメッセージのコンシューマの名前を示します。
Delay	エンキューされたメッセージがデキュー可能になるまでの期間(秒)を指定します。
DeliveryMode	メッセージの配信モードを指定します。
EnqueueTime	メッセージがエンキューされた時間を指定します。
ExceptionQueue	メッセージを正常に処理できない場合に、そのメッセージの移動先となるキューの名前を指定します。
Expiration	エンキューされたメッセージが期限切れになるまでのデキュー可能な期間(秒)を指定します。
MessageId	メッセージ識別子の配列を戻します。
NotificationType	通知のタイプ(通常、グループ化、タイムアウトなど)を示します。
OriginalMessageId	このメッセージを生成した、最後のキュー内のメッセージのIDを指定します。
Priority	メッセージの優先順位を指定します。
QueueName	デキューされるメッセージを含むキューの名前を示します。
SenderId	メッセージの元の送信者を識別します。
State	メッセージの状態を指定します。

関連項目:

OracleAQMessageAvailableEventArgsコンストラクタ

このコンストラクタは、OracleAQMessageAvailableEventArgsクラスのインスタンスをデフォルトのプロパティ値で作成します。

宣言

// C#
public OracleAQMessageAvailableEventArgs();

関連項目:

OracleAQMessageAvailableEventArgsプロパティ

OracleAQMessageAvailableEventArgsプロパティを、表12-19にリストします。

表12-19 OracleAQMessageAvailableEventArgsプロパティ

プロパティ	説明
AvailableMessages	この通知が発生したメッセージの数を指定します。
ConsumerName	デキュー可能なメッセージのコンシューマの名前を示します。
Correlation	デキュー可能なメッセージのコンシューマの名前を示します。
Delay	エンキューされたメッセージがデキュー可能になるまでの期間(秒)を指定します。
DeliveryMode	メッセージの配信モードを指定します。
EnqueueTime	メッセージがエンキューされた時間を指定します。
ExceptionQueue	メッセージを正常に処理できない場合に、そのメッセージの移動先となるキューの名前を指定します。
Expiration	エンキューされたメッセージが期限切れになるまでのデキュー可能な期間(秒)を指定します。
MessageId	メッセージ識別子の配列を戻します。
NotificationType	通知のタイプ(通常、グループ化、タイムアウトなど)を示します。
OriginalMessageId	このメッセージを生成した、最後のキュー内のメッセージのIDを指定します。
Priority	メッセージの優先順位を指定します。
QueueName	デキューされるメッセージを含むキューの名前を示します。
SenderId	メッセージの元の送信者を識別します。
State	メッセージの状態を指定します。

関連項目:

AvailableMessages

このインスタンス・プロパティは、この通知が発生したメッセージの数を指定します。

宣言

// C#
public int AvailableMessages{get;}

プロパティ値

この通知が発生したメッセージの数を示すinteger。

備考

通常の通知タイプの場合、プロパティ値は1です。通知タイプは、OracleAQQueue.Notificationプロパティを使用して指定できます。

NotificationTypeがOracleAQNotificationType.Timeoutの場合、このプロパティは意味を持ちません。

関連項目:

ConsumerName

このプロパティは、デキュー可能なメッセージのコンシューマの名前を示します。

宣言

// C#
public string ConsumerName {get;}

プロパティ値

コンシューマの名前を示すstring。

関連項目:

Correlation

このインスタンス・プロパティは、メッセージの識別情報を指定します。

宣言

// C#
public string Correlation {get;}

プロパティ値

メッセージの識別情報を指定するstring。

備考

このプロパティは、通知が発生したメッセージの相関関係を指定します。コンシューマは、OracleAQDequeueOptionsオブジェクトの「Correlation」プロパティを設定することで、この識別情報を使用して特定のメッセージをデキューできます。

関連項目:

Delay

このインスタンス・プロパティは、エンキューされたメッセージがデキュー可能になるまでの期間(秒)を指定します。

宣言

// C#
public int Delay {get;}

プロパティ値

エンキューされたメッセージがデキュー可能になるまでの期間(秒)を示すinteger。

関連項目:

DeliveryMode

このインスタンス・プロパティは、メッセージの配信モードを指定します。

宣言

// C#
public OracleAQMessageDeliveryMode DeliveryMode {get;}

プロパティ値

OracleAQMessageDeliveryModeの列挙値。

関連項目:

EnqueueTime

このインスタンス・プロパティは、メッセージがエンキューされた時間を指定します。

宣言

// C#
public DateTime EnqueueTime {get;}

プロパティ値

DateTimeオブジェクト。

関連項目:

ExceptionQueue

このインスタンス・プロパティは、メッセージを正常に処理できない場合に、そのメッセージの移動先となるキューの名前を指定します。

宣言

// C#
public string ExceptionQueue {get;}

プロパティ値

メッセージを正常に処理できない場合に、そのメッセージの移動先となるキューの名前。

関連項目:

Expiration

このインスタンス・プロパティは、エンキューされたメッセージが期限切れになるまでのデキュー可能な期間(秒)を指定します。

宣言

// C#
public int Expiration {get;}

プロパティ値

エンキューされたメッセージがデキュー可能な期間(秒)を指定するinteger。

関連項目:

MessageId

このインスタンス・プロパティは、メッセージ識別子の配列を戻します。

宣言

// C#
public byte[][] MessageId{get;}

プロパティ値

通知の一部として受信したメッセージ識別子を指定するbyte[][]。

備考

このプロパティは、通知が発生したメッセージのメッセージ識別子を指定します。

通常の通知に対するMessageId配列のサイズは1です。通知グループ化タイプがOracleAQNotificationGroupingType.Lastの場合、グループ化通知に対するMessageId配列のサイズは1です。NotificationTypeがOracleAQNotificationType.Timeoutの場合、このプロパティは意味を持ちません。

関連項目:

NotificationType

このプロパティは、通知のタイプ(通常、グループ化、タイムアウトなど)を示します。

宣言

// C#
public OracleAQNotificationType NotificationType {get;}

プロパティ値

OracleAQNotificationTypeの列挙値。

関連項目:

OriginalMessageId

このプロパティは、このメッセージを生成した、最後のキュー内のメッセージのIDを指定します。

宣言

// C#
public byte[] OriginalMessageId {get;}

プロパティ値

元のメッセージIDを指定するbyte[]。

関連項目:

Priority

このインスタンス・プロパティは、メッセージの優先順位を指定します。

宣言

// C#
public int Priority {get;}

プロパティ値

メッセージの優先順位を指定するinteger。

関連項目:

QueueName

このプロパティは、デキューされるメッセージを含むキューの名前を示します。

宣言

// C#
public string QueueName {get;}

プロパティ値

string。

関連項目:

SenderId

このプロパティは、メッセージの元の送信者を識別します。

宣言

// C#
public OracleAQAgent SenderId {get;}

プロパティ値

OracleAQAgentオブジェクト。

関連項目:

State

このインスタンス・プロパティは、メッセージの状態を指定します。

宣言

// C#
public OracleAQMessageState State {get;}

プロパティ値

OracleAQMessageStateの列挙値。

関連項目: