AcknowledgeTypes 列挙体
メッセージ キューが送信元アプリケーションに返す受信確認メッセージのタイプを指定します。
この列挙体には、メンバ値をビットごとに演算するための FlagsAttribute 属性が含まれています。
<Flags>
<Serializable>
Public Enum AcknowledgeTypes
[C#]
[Flags]
[Serializable]
public enum AcknowledgeTypes
[C++]
[Flags]
[Serializable]
__value public enum AcknowledgeTypes
[JScript]
public
Flags
Serializable
enum AcknowledgeTypes
解説
AcknowledgeTypes クラスは、受信確認メッセージの 1 つ以上のカテゴリを要求するために組み合わせるフラグのセットを提供します。
アプリケーションがメッセージを送信するときには、元のメッセージの成功または失敗を示す受信確認メッセージをメッセージ キューが返すように要求できます。メッセージ キューは、ユーザーが指定した管理キューにこれらの受信確認メッセージを送信します。受信確認のタイプは 4 つのグループに大別できます。肯定到達受信確認、肯定読み取り受信確認、否定到達受信確認、および否定読み取り受信確認です。受信確認を要求すると、アプリケーションは特定の状況の通知を受信できるようになります。たとえば、メッセージが送信先キューに到達した、メッセージが取得された、タイムアウトによりメッセージが到達できない、タイムアウトによりメッセージが送信先キューから取得されないなどのメッセージです。
Message クラスを使用してメッセージをキューに送信するときには、アプリケーションが受信する受信確認のタイプを AcknowledgeType プロパティで指定し、受信確認メッセージを受信する管理キューを AdministrationQueue プロパティで指定します。
Message クラスを使用して管理キューの受信確認メッセージを読み取る場合、インスタンスの Acknowledgment プロパティは受信確認メッセージの原因となる状況、たとえば元のメッセージをキューから読み取る前にタイムアウトになったなどを示します。
メンバ
| メンバ名 | 説明 | 値 |
|---|---|---|
| FullReachQueue | 元のメッセージがキューに到達した場合は肯定受信確認を要求するために使用され、キュー到達制限時間タイマがタイムアウトとなる場合または元のメッセージを認証できない場合は否定受信確認を要求するために使用されるマスク。 | 5 |
| FullReceive | 元のメッセージが受信制限時間タイマがタイムアウトとなる前にキューから受信された場合は肯定受信確認を要求し、それ以外の場合は否定受信確認を要求するために使用するマスク。 | 14 |
| NegativeReceive | 元のメッセージをキューから受信することに失敗した場合に否定受信確認を要求するために使用するマスク。
メモ MessageQueue.Peek メソッドを使用するとキューからメッセージが削除されないため、メッセージをピークした場合でもこのタイプの受信確認は返されません。キューからメッセージを削除するのは MessageQueue.Receive メソッド (または関連する非同期 MessageQueue.BeginReceive メソッド) だけです。 |
8 |
| None | 受信確認メッセージ (肯定または否定) をポストしないように要求するために使用するマスク。 | 0 |
| NotAcknowledgeReachQueue | 元のメッセージがキューに到達しなかった場合に否定受信確認を要求するために使用するマスク。これはキュー到達制限時間タイマがタイムアウトとなった場合、またはメッセージが認証されなかった場合に発生します。 | 4 |
| NotAcknowledgeReceive | 受信制限時間タイマがタイムアウトとなる前に、キューから元のメッセージを受信できなくなるというエラーが発生したときに否定受信確認を要求するために使用するマスク。 | 12 |
| PositiveArrival | 元のメッセージがキューに到達した場合に肯定受信確認を要求するために使用するマスク。 | 1 |
| PositiveReceive | 元のメッセージをキューから正常に取得した場合に肯定受信確認を要求するために使用するマスク。 | 2 |
使用例
[Visual Basic, C#, C++] オーダーを含んでいるメッセージをキューに送信し、またオーダーを含んでいるメッセージをキューから受信する例を次に示します。これは特に、元のメッセージがキューに到着するか、元のメッセージがキューから取得されたときに、肯定受信確認を要求します。
Imports System
Imports System.Messaging
Namespace MyProject
_
'/ <summary>
'/ Provides a container class for the example.
'/ </summary>
Public Class MyNewQueue
'**************************************************
' Provides an entry point into the application.
'
' This example sends and receives a message from
' a queue.
'**************************************************
Public Shared Sub Main()
' Create a new instance of the class.
Dim myNewQueue As New MyNewQueue()
' Create new queues.
CreateQueue(".\myQueue")
CreateQueue(".\myAdministrationQueue")
' Send messages to a queue.
myNewQueue.SendMessage()
' Receive messages from a queue.
Dim messageId As String = myNewQueue.ReceiveMessage()
' Receive acknowledgment message.
If Not (messageId Is Nothing) Then
myNewQueue.ReceiveAcknowledgment(messageId, ".\myAdministrationQueue")
End If
Return
End Sub 'Main
'**************************************************
' Creates a new queue.
'**************************************************
Public Shared Sub CreateQueue(queuePath As String)
Try
If Not MessageQueue.Exists(queuePath) Then
MessageQueue.Create(queuePath)
Else
Console.WriteLine((queuePath + " already exists."))
End If
Catch e As MessageQueueException
Console.WriteLine(e.Message)
End Try
End Sub 'CreateQueue
'**************************************************
' Sends a string message to a queue.
'**************************************************
Public Sub SendMessage()
' Connect to a queue on the local computer.
Dim myQueue As New MessageQueue(".\myQueue")
' Create a new message.
Dim myMessage As New Message("Original Message")
myMessage.AdministrationQueue = New MessageQueue(".\myAdministrationQueue")
myMessage.AcknowledgeType = AcknowledgeTypes.PositiveReceive Or AcknowledgeTypes.PositiveArrival
' Send the Order to the queue.
myQueue.Send(myMessage)
Return
End Sub 'SendMessage
'**************************************************
' Receives a message containing an Order.
'**************************************************
Public Function ReceiveMessage() As String
' Connect to the a queue on the local computer.
Dim myQueue As New MessageQueue(".\myQueue")
myQueue.MessageReadPropertyFilter.CorrelationId = True
' Set the formatter to indicate body contains an Order.
myQueue.Formatter = New XmlMessageFormatter(New Type() {GetType(String)})
Dim returnString As String = Nothing
Try
' Receive and format the message.
Dim myMessage As Message = myQueue.Receive()
' Display message information.
Console.WriteLine("____________________________________________")
Console.WriteLine("Original message information--")
Console.WriteLine(("Body: " + myMessage.Body.ToString()))
Console.WriteLine(("Id: " + myMessage.Id.ToString()))
Console.WriteLine("____________________________________________")
returnString = myMessage.Id
Catch
' Handle Message Queuing exceptions.
' Handle invalid serialization format.
Catch e As InvalidOperationException
Console.WriteLine(e.Message)
End Try
' Catch other exceptions as necessary.
Return returnString
End Function 'ReceiveMessage
'**************************************************
' Receives a message containing an Order.
'**************************************************
Public Sub ReceiveAcknowledgment(messageId As String, queuePath As String)
Dim found As Boolean = False
Dim queue As New MessageQueue(queuePath)
queue.MessageReadPropertyFilter.CorrelationId = True
queue.MessageReadPropertyFilter.Acknowledgment = True
Try
While Not (queue.PeekByCorrelationId(messageId) Is Nothing)
Dim myAcknowledgmentMessage As Message = queue.ReceiveByCorrelationId(messageId)
' Output acknowledgment message information. The correlation Id is identical
' to the id of the original message.
Console.WriteLine("Acknowledgment Message Information--")
Console.WriteLine(("Correlation Id: " + myAcknowledgmentMessage.CorrelationId.ToString()))
Console.WriteLine(("Id: " + myAcknowledgmentMessage.Id.ToString()))
Console.WriteLine(("Acknowledgment Type: " + myAcknowledgmentMessage.Acknowledgment.ToString()))
Console.WriteLine("____________________________________________")
found = True
End While
Catch e As InvalidOperationException
' This exception would be thrown if there is no (further) acknowledgment message
' with the specified correlation Id. Only output a message if there are no messages;
' not if the loop has found at least one.
If found = False Then
Console.WriteLine(e.Message)
End If
End Try
End Sub 'ReceiveAcknowledgment ' Handle other causes of invalid operation exception.
End Class 'MyNewQueue
End Namespace 'MyProject
[C#]
using System;
using System.Messaging;
namespace MyProject
{
/// <summary>
/// Provides a container class for the example.
/// </summary>
public class MyNewQueue
{
//**************************************************
// Provides an entry point into the application.
//
// This example sends and receives a message from
// a queue.
//**************************************************
public static void Main()
{
// Create a new instance of the class.
MyNewQueue myNewQueue = new MyNewQueue();
// Create new queues.
CreateQueue(".\\myQueue");
CreateQueue(".\\myAdministrationQueue");
// Send messages to a queue.
myNewQueue.SendMessage();
// Receive messages from a queue.
string messageId = myNewQueue.ReceiveMessage();
// Receive acknowledgment message.
if(messageId != null)
{
myNewQueue.ReceiveAcknowledgment(messageId, ".\\myAdministrationQueue");
}
return;
}
//**************************************************
// Creates a new queue.
//**************************************************
public static void CreateQueue(string queuePath)
{
try
{
if(!MessageQueue.Exists(queuePath))
{
MessageQueue.Create(queuePath);
}
else
{
Console.WriteLine(queuePath + " already exists.");
}
}
catch (MessageQueueException e)
{
Console.WriteLine(e.Message);
}
}
//**************************************************
// Sends a string message to a queue.
//**************************************************
public void SendMessage()
{
// Connect to a queue on the local computer.
MessageQueue myQueue = new MessageQueue(".\\myQueue");
// Create a new message.
Message myMessage = new Message("Original Message");
myMessage.AdministrationQueue = new MessageQueue(".\\myAdministrationQueue");
myMessage.AcknowledgeType = AcknowledgeTypes.PositiveReceive | AcknowledgeTypes.PositiveArrival;
// Send the Order to the queue.
myQueue.Send(myMessage);
return;
}
//**************************************************
// Receives a message containing an Order.
//**************************************************
public string ReceiveMessage()
{
// Connect to the a queue on the local computer.
MessageQueue myQueue = new MessageQueue(".\\myQueue");
myQueue.MessageReadPropertyFilter.CorrelationId = true;
// Set the formatter to indicate body contains an Order.
myQueue.Formatter = new XmlMessageFormatter(new Type[]
{typeof(string)});
string returnString = null;
try
{
// Receive and format the message.
Message myMessage = myQueue.Receive();
// Display message information.
Console.WriteLine("____________________________________________");
Console.WriteLine("Original message information--");
Console.WriteLine("Body: " +myMessage.Body.ToString());
Console.WriteLine("Id: " + myMessage.Id.ToString());
Console.WriteLine("____________________________________________");
returnString = myMessage.Id;
}
catch (MessageQueueException)
{
// Handle Message Queuing exceptions.
}
// Handle invalid serialization format.
catch (InvalidOperationException e)
{
Console.WriteLine(e.Message);
}
// Catch other exceptions as necessary.
return returnString;
}
//**************************************************
// Receives a message containing an Order.
//**************************************************
public void ReceiveAcknowledgment(string messageId, string queuePath)
{
bool found = false;
MessageQueue queue = new MessageQueue(queuePath);
queue.MessageReadPropertyFilter.CorrelationId = true;
queue.MessageReadPropertyFilter.Acknowledgment = true;
try
{
while(queue.PeekByCorrelationId(messageId) != null)
{
Message myAcknowledgmentMessage = queue.ReceiveByCorrelationId(messageId);
// Output acknowledgment message information. The correlation Id is identical
// to the id of the original message.
Console.WriteLine("Acknowledgment Message Information--");
Console.WriteLine("Correlation Id: " + myAcknowledgmentMessage.CorrelationId.ToString());
Console.WriteLine("Id: " + myAcknowledgmentMessage.Id.ToString());
Console.WriteLine("Acknowledgment Type: " + myAcknowledgmentMessage.Acknowledgment.ToString());
Console.WriteLine("____________________________________________");
found = true;
}
}
catch (InvalidOperationException e)
{
// This exception would be thrown if there is no (further) acknowledgment message
// with the specified correlation Id. Only output a message if there are no messages;
// not if the loop has found at least one.
if(found == false)
{
Console.WriteLine(e.Message);
}
// Handle other causes of invalid operation exception.
}
}
}
}
[C++]
#using <mscorlib.dll>
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
__gc class MyNewQueue
{
public:
static void CreateQueue(String* queuePath)
{
try
{
if (!MessageQueue::Exists(queuePath))
{
MessageQueue::Create(queuePath);
}
else
{
Console::WriteLine("{0} already exists.", queuePath );
}
}
catch (MessageQueueException* e)
{
Console::WriteLine(e->Message);
}
}
public:
void SendMessage()
{
// Connect to a queue on the local computer.
MessageQueue* myQueue = new MessageQueue(S".\\myQueue");
// Create a new message.
Message* myMessage = new Message(S"Original Message");
myMessage->AdministrationQueue = new MessageQueue(S".\\myAdministrationQueue");
myMessage->AcknowledgeType = (AcknowledgeTypes)(AcknowledgeTypes::PositiveReceive | AcknowledgeTypes::PositiveArrival);
// Send the Order to the queue.
myQueue->Send(myMessage);
return;
}
public:
String* ReceiveMessage()
{
// Connect to the a queue on the local computer.
MessageQueue* myQueue = new MessageQueue(S".\\myQueue");
myQueue->MessageReadPropertyFilter->CorrelationId = true;
Type* p __gc[] = new Type*[1];
p[0] = __typeof(String);
myQueue->Formatter = new XmlMessageFormatter( p );
String* returnString = 0;
try
{
// Receive and format the message.
Message* myMessage = myQueue->Receive();
// Display message information.
Console::WriteLine(S"____________________________________________");
Console::WriteLine(S"Original message information--");
Console::WriteLine(S"Body: {0}", myMessage->Body);
Console::WriteLine(S"Id: {0}", myMessage->Id);
Console::WriteLine(S"____________________________________________");
returnString = myMessage->Id;
}
catch (MessageQueueException*)
{
// Handle Message Queuing exceptions.
}
// Handle invalid serialization format.
catch (InvalidOperationException* e)
{
Console::WriteLine(e->Message);
}
// Catch other exceptions as necessary.
return returnString;
}
public:
void ReceiveAcknowledgment(String* messageId, String* queuePath)
{
bool found = false;
MessageQueue* queue = new MessageQueue(queuePath);
queue->MessageReadPropertyFilter->CorrelationId = true;
queue->MessageReadPropertyFilter->Acknowledgment = true;
try
{
while(queue->PeekByCorrelationId(messageId) != 0)
{
Message* myAcknowledgmentMessage = queue->ReceiveByCorrelationId(messageId);
// Output acknowledgment message information. The correlation Id is identical
// to the id of the original message.
Console::WriteLine(S"Acknowledgment Message Information--");
Console::WriteLine(S"Correlation Id: {0}", myAcknowledgmentMessage->CorrelationId);
Console::WriteLine(S"Id: {0}", myAcknowledgmentMessage->Id);
Console::WriteLine(S"Acknowledgment Type: {0}", __box(myAcknowledgmentMessage->Acknowledgment));
Console::WriteLine(S"____________________________________________");
found = true;
}
}
catch (InvalidOperationException* e)
{
// This exception would be thrown if there is no (further) acknowledgment message
// with the specified correlation Id. Only output a message if there are no messages;
// not if the loop has found at least one.
if (found == false)
{
Console::WriteLine(e->Message);
}
// Handle other causes of invalid operation exception.
}
}
};
int main()
{
// Create a new instance of the class.
MyNewQueue* myNewQueue = new MyNewQueue();
// Create new queues.
MyNewQueue::CreateQueue(S".\\myQueue");
MyNewQueue::CreateQueue(S".\\myAdministrationQueue");
// Send messages to a queue.
myNewQueue->SendMessage();
// Receive messages from a queue.
String* messageId = myNewQueue->ReceiveMessage();
// Receive acknowledgment message.
if (messageId != 0)
{
myNewQueue->ReceiveAcknowledgment(messageId, S".\\myAdministrationQueue");
}
return 0;
}
[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン .gif)
をクリックします。
必要条件
名前空間: System.Messaging
プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ
アセンブリ: System.Messaging (System.Messaging.dll 内)
参照
System.Messaging 名前空間 | Message | Message.AdministrationQueue | Message.AcknowledgeType | Message.Acknowledgment