UdpClient.EndReceive メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

UdpClient.EndReceive メソッド

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

保留中の非同期受信を終了します。

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

Visual Basic (宣言)

Public Function EndReceive ( _
    asyncResult As IAsyncResult, _
    ByRef remoteEP As IPEndPoint _
) As Byte()

Visual Basic (使用法)

Dim instance As UdpClient
Dim asyncResult As IAsyncResult
Dim remoteEP As IPEndPoint
Dim returnValue As Byte()

returnValue = instance.EndReceive(asyncResult, remoteEP)

public byte[] EndReceive (
    IAsyncResult asyncResult,
    ref IPEndPoint remoteEP
)

C++

public:
array<unsigned char>^ EndReceive (
    IAsyncResult^ asyncResult, 
    IPEndPoint^% remoteEP
)

public byte[] EndReceive (
    IAsyncResult asyncResult, 
    /** @ref */ IPEndPoint remoteEP
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

asyncResult: BeginReceive の呼び出しによって返される IAsyncResult オブジェクト。

remoteEP: 指定したリモートエンドポイント。

戻り値
正常に完了した場合は、受信したバイト数。失敗した場合、このメソッドは 0 を返します。

例外

例外の種類	条件
ArgumentNullException	asyncResult が null 参照 (Visual Basic では Nothing) です。
ArgumentException	BeginReceive メソッドへの呼び出しで asyncResult が返されませんでした。
InvalidOperationException	EndReceive が、非同期の読み取りのために以前に呼び出されています。
SocketException	基になる Socket へのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	基になる Socket は閉じられています。

解説

このメソッドは、操作が完了するまでブロックします。

この操作を同期で実行するには、Receive メソッドを使用します。

使用例

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

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);
        }
    }