UdpClient.BeginReceive メソッド

.NET Framework クラス ライブラリ リファレンス

UdpClient.BeginReceive メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

データグラムをリモート ホストから非同期的に受信します。

名前空間: System.Net.Sockets
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Function BeginReceive ( _
    requestCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult

Visual Basic (使用法)

Dim instance As UdpClient
Dim requestCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginReceive(requestCallback, state)

C#

public IAsyncResult BeginReceive (
    AsyncCallback requestCallback,
    Object state
)

C++

public:
IAsyncResult^ BeginReceive (
    AsyncCallback^ requestCallback, 
    Object^ state
)

J#

public IAsyncResult BeginReceive (
    AsyncCallback requestCallback, 
    Object state
)

JScript

public function BeginReceive (
    requestCallback : AsyncCallback, 
    state : Object
) : IAsyncResult

パラメータ

requestCallback

操作の完了時に呼び出すメソッドを参照する AsyncCallback デリゲート。

state

受信操作に関する情報を格納するユーザー定義のオブジェクト。このオブジェクトは、操作の完了時に requestCallback デリゲートに渡されます。

戻り値
非同期の受信を参照する IAsyncResult オブジェクト。

解説

非同期の BeginReceive 操作は、EndReceive メソッドを呼び出して終了させる必要があります。通常、このメソッドは requestCallback デリゲートによって呼び出されます。

このメソッドは、操作が完了するまでブロックしません。操作が完了するまでブロックするには、Receive メソッドを使用します。

非同期プログラミング モデルの使用法の詳細については、「同期メソッドの非同期呼び出し」を参照してください。

使用例

BeginReceive を使用して、サーバーからの応答を非同期的に受信するコード例を次に示します。

C#

public static bool messageReceived
 = false;

public static void ReceiveCallback(IAsyncResult
 ar)
{
  UdpClient u = (UdpClient)((UdpState)(ar.AsyncState)).u;
  IPEndPoint e = (IPEndPoint)((UdpState)(ar.AsyncState)).e;

  Byte[] receiveBytes = u.EndReceive(ar, ref e);
  string receiveString = Encoding.ASCII.GetString(receiveBytes);

  Console.WriteLine("Received: {0}", receiveString);
  messageReceived = true;
}

public static void ReceiveMessages()
{
  // Receive a message and write it to the console.
  IPEndPoint e = new IPEndPoint(IPAddress.Any, listenPort);
  UdpClient u = new UdpClient(e);

  UdpState s = new UdpState();
  s.e = e;
  s.u = u;

  Console.WriteLine("listening for messages");
  u.BeginReceive(new AsyncCallback(ReceiveCallback), s);

  // Do some work while we wait for a message. For this example,
  // we'll just sleep
  while (!messageReceived)
  {
    Thread.Sleep(100);
  }
}

C++

public:
    static bool isMessageReceived;

    static void ReceiveCallback(IAsyncResult^
 asyncResult)
    {
        UdpClient^ udpClient =
            ((UdpState)(asyncResult->AsyncState)).udpClient;
        IPEndPoint^ ipEndPoint =
            ((UdpState)(asyncResult->AsyncState)).ipEndPoint;

        array<Byte>^ receiveBytes =
            udpClient->EndReceive(asyncResult, ipEndPoint);
        String^ receiveString =
            Encoding::ASCII->GetString(receiveBytes);

        Console::WriteLine("Received: {0}", receiveString);
        isMessageReceived = true;
    }

    static void ReceiveMessages()
    {
        // Receive a message and write it to the console.
        IPEndPoint^ ipEndPoint = gcnew IPEndPoint(IPAddress::Any, listenPort);
        UdpClient^ udpClient = gcnew UdpClient(ipEndPoint);

        UdpState^ udpState = gcnew UdpState();
        udpState->ipEndPoint = ipEndPoint;
        udpState->udpClient = udpClient;

        Console::WriteLine("listening for messages");
        udpClient->BeginReceive(gcnew AsyncCallback(ReceiveCallback),
            udpState);

        // Do some work while we wait for a message. For this example
,
        // we'll just sleep
        while (!isMessageReceived)
        {
            Thread::Sleep(100);
        }
    }

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
UdpClient クラス
UdpClient メンバ
System.Net.Sockets 名前空間