MessageQueue.BeginPeek メソッド
メッセージのピークを開始し、完了したときにイベント ハンドラに通知するようにメッセージ キューに指示して、非同期のピーク操作を実行します。
オーバーロードの一覧
タイムアウトのない非同期のピーク操作を実行します。操作は、キューのメッセージが利用可能になるまで完了しません。
[Visual Basic] Overloads Public Function BeginPeek() As IAsyncResult
指定したタイムアウトのある非同期のピーク操作を実行します。この操作は、メッセージをキューで使用できるようになる、タイムアウトが発生するまで完了しません。
[Visual Basic] Overloads Public Function BeginPeek(TimeSpan) As IAsyncResult
[JScript] public function BeginPeek(TimeSpan) : IAsyncResult;
指定したタイムアウトと指定した状態オブジェクトを持つ非同期のピーク操作を実行します。状態オブジェクトは、操作の有効期間を通じて関連付けられた情報を提供します。この操作は、メッセージをキューで使用できるようになる、タイムアウトが発生するまで完了しません。
[Visual Basic] Overloads Public Function BeginPeek(TimeSpan, Object) As IAsyncResult
[JScript] public function BeginPeek(TimeSpan, Object) : IAsyncResult;
指定したタイムアウトと指定した状態オブジェクトを持つ非同期のピーク操作を実行します。状態オブジェクトは、操作の有効期間を通じて関連付けられた情報を提供します。このオーバーロードは、コールバックを通じて操作のイベント ハンドラ ID の通知を受信します。この操作は、メッセージをキューで使用できるようになる、タイムアウトが発生するまで完了しません。
[Visual Basic] Overloads Public Function BeginPeek(TimeSpan, Object, AsyncCallback) As IAsyncResult
[C#] public IAsyncResult BeginPeek(TimeSpan, object, AsyncCallback);
[C++] public: IAsyncResult* BeginPeek(TimeSpan, Object*, AsyncCallback*);
[JScript] public function BeginPeek(TimeSpan, Object, AsyncCallback) : IAsyncResult;
使用例
[Visual Basic, C#, C++] キューのパス ".\myQueue" を使用して非同期のピーク操作を作成する例を次に示します。イベントハンドラ MyPeekCompleted を作成し、 PeekCompleted イベント ハンドラ デリゲートに結び付けます。 BeginPeek は 1 分間のタイムアウトで呼び出されます。 BeginPeek の各呼び出しに、特定の操作を識別する一意に関連付けられた整数が割り当てられます。 PeekCompleted イベントが発生するか、またはタイムアウトの時間が経過すると、メッセージがある場合はそれが取得され、本文と操作固有の整数型の ID が画面に書き込まれます。次に、 BeginPeek がもう一度呼び出され、同じタイムアウトと完了した操作に関連付けられていた整数で新しい非同期のピーク操作が実行されます。
[Visual Basic, C#, C++] メモ ここでは、BeginPeek のオーバーロード形式のうちの 1 つだけについて、使用例を示します。その他の例については、各オーバーロード形式のトピックを参照してください。
Imports System
Imports System.Messaging
Namespace MyProject
'/ <summary>
'/ Provides a container class for the example.
'/ </summary>
Public Class MyNewQueue
' Represents a state object associated with each message.
Private Shared messageNumber As Integer = 0
'**************************************************
' Provides an entry point into the application.
'
' This example performs asynchronous peek operation
' processing.
'**************************************************
Public Shared Sub Main()
' Create an instance of MessageQueue. Set its formatter.
Dim myQueue As New MessageQueue(".\myQueue")
myQueue.Formatter = New XmlMessageFormatter(New Type() _
{GetType([String])})
' Add an event handler for the PeekCompleted event.
AddHandler myQueue.PeekCompleted, AddressOf _
MyPeekCompleted
' Begin the asynchronous peek operation with a time-out
' of one minute.
myQueue.BeginPeek(New TimeSpan(0, 1, 0), messageNumber)
messageNumber += 1
' Do other work on the current thread.
Return
End Sub 'Main
'**************************************************
' Provides an event handler for the PeekCompleted
' event.
'**************************************************
Private Shared Sub MyPeekCompleted(ByVal [source] As _
[Object], ByVal asyncResult As _
PeekCompletedEventArgs)
Try
' Connect to the queue.
Dim mq As MessageQueue = _
CType([source], MessageQueue)
' End the asynchronous peek operation.
Dim m As Message = _
mq.EndPeek(asyncResult.AsyncResult)
' Display message information on the screen,
' including(the) message number (state object).
Console.WriteLine(("Message: " + _
CInt(asyncResult.AsyncResult.AsyncState) + _
" " + CStr(m.Body)))
' Restart the asynchronous peek operation, with the
' same time-out.
mq.BeginPeek(New TimeSpan(0, 1, 0), messageNumber)
messageNumber += 1
Catch e As MessageQueueException
If e.MessageQueueErrorCode = _
MessageQueueErrorCode.IOTimeout Then
Console.WriteLine(e.ToString())
' Handle other sources of MessageQueueException.
End If
' Handle other exceptions.
End Try
Return
End Sub 'MyPeekCompleted
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
{
// Represents a state object associated with each message.
static int messageNumber = 0;
//**************************************************
// Provides an entry point into the application.
//
// This example performs asynchronous peek operation
// processing.
//**************************************************
public static void Main()
{
// Create an instance of MessageQueue. Set its formatter.
MessageQueue myQueue = new MessageQueue(".\\myQueue");
myQueue.Formatter = new XmlMessageFormatter(new Type[]
{typeof(String)});
// Add an event handler for the PeekCompleted event.
myQueue.PeekCompleted += new
PeekCompletedEventHandler(MyPeekCompleted);
// Begin the asynchronous peek operation with a time-out
// of one minute.
myQueue.BeginPeek(new TimeSpan(0,1,0), messageNumber++);
// Do other work on the current thread.
return;
}
//**************************************************
// Provides an event handler for the PeekCompleted
// event.
//**************************************************
private static void MyPeekCompleted(Object source,
PeekCompletedEventArgs asyncResult)
{
try
{
// Connect to the queue.
MessageQueue mq = (MessageQueue)source;
// End the asynchronous peek operation.
Message m = mq.EndPeek(asyncResult.AsyncResult);
// Display message information on the screen,
// including the message number (state object).
Console.WriteLine("Message: " +
(int)asyncResult.AsyncResult.AsyncState + " "
+(string)m.Body);
// Restart the asynchronous peek operation, with the
// same time-out.
mq.BeginPeek(new TimeSpan(0,1,0), messageNumber++);
}
catch(MessageQueueException e)
{
if (e.MessageQueueErrorCode ==
MessageQueueErrorCode.IOTimeout)
{
Console.WriteLine(e.ToString());
}
// Handle other sources of MessageQueueException.
}
// Handle other exceptions.
return;
}
}
}
[C++]
#using <mscorlib.dll>
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
__gc class MyNewQueue
{
public:
// Represents a state object associated with each message.
static int messageNumber = 0;
// Provides an event handler for the PeekCompleted
// event.
//
static void MyPeekCompleted(Object* source,
PeekCompletedEventArgs* asyncResult)
{
try
{
// Connect to the queue.
MessageQueue* mq = dynamic_cast<MessageQueue*>(source);
// End the asynchronous peek operation.
Message* m = mq->EndPeek(asyncResult->AsyncResult);
// Display message information on the screen,
// including the message number (state object).
Console::WriteLine(S"Message: {0} {1}", asyncResult->AsyncResult->AsyncState , static_cast<String*>(m->Body));
// Restart the asynchronous peek operation, with the
// same time-out.
mq->BeginPeek(TimeSpan(0, 1, 0), __box(messageNumber++));
}
catch (MessageQueueException* e)
{
if (e->MessageQueueErrorCode ==
MessageQueueErrorCode::IOTimeout)
{
Console::WriteLine(e);
}
// Handle other sources of MessageQueueException.
}
// Handle other exceptions.
return;
}
};
// Provides an entry point into the application.
//
// This example performs asynchronous peek operation
// processing.
int main()
{
// Create an instance of MessageQueue. Set its formatter.
MessageQueue* myQueue = new MessageQueue(S".\\myQueue");
Type* p __gc[] = new Type* __gc[1];
p[0] = __typeof(String);
myQueue->Formatter = new XmlMessageFormatter( p );
// Add an event handler for the PeekCompleted event.
myQueue->PeekCompleted += new PeekCompletedEventHandler(0, MyNewQueue::MyPeekCompleted);
// Begin the asynchronous peek operation with a timeout
// of one minute.
myQueue->BeginPeek(TimeSpan(0, 1, 0), __box(MyNewQueue::messageNumber++));
// Do other work on the current thread.
return 0;
}
[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン .gif)
をクリックします。