Socket.EndReceiveFrom(IAsyncResult, EndPoint) Socket.EndReceiveFrom(IAsyncResult, EndPoint) Socket.EndReceiveFrom(IAsyncResult, EndPoint) Socket.EndReceiveFrom(IAsyncResult, EndPoint) Method

定義

特定のエンドポイントからの、保留中の非同期読み込みを終了します。Ends a pending asynchronous read from a specific endpoint.

public:
 int EndReceiveFrom(IAsyncResult ^ result, System::Net::EndPoint ^ % end_point);
public int EndReceiveFrom (IAsyncResult result, ref System.Net.EndPoint end_point);
member this.EndReceiveFrom : IAsyncResult *  -> int
Public Function EndReceiveFrom (result As IAsyncResult, ByRef end_point As EndPoint) As Integer

パラメーター

asyncResult
IAsyncResult IAsyncResult IAsyncResult IAsyncResult

この非同期操作の状態情報およびユーザー定義データを格納する IAsyncResultAn IAsyncResult that stores state information and any user defined data for this asynchronous operation.

endPoint
EndPoint EndPoint EndPoint EndPoint

コピー元 EndPointThe source EndPoint.

戻り値

正常に完了した場合は、受信したバイト数。If successful, the number of bytes received. 失敗した場合は、0 を返します。If unsuccessful, returns 0.

例外

EndReceiveFrom(IAsyncResult, EndPoint) が、非同期の読み取りのために以前に呼び出されています。EndReceiveFrom(IAsyncResult, EndPoint) was previously called for the asynchronous read.

ソケットへのアクセスを試行しているときにエラーが発生しました。An error occurred when attempting to access the socket.

次のコード例では、特定EndPointのからの保留中の非同期読み取りを終了します。The following code example ends a pending asynchronous read from a specific EndPoint.

StateObject^ so = safe_cast<StateObject^>(ar->AsyncState);
Socket^ s = so->workSocket;

// Creates a temporary EndPoint to pass to EndReceiveFrom.
IPEndPoint^ sender = gcnew IPEndPoint( IPAddress::Any,0 );
EndPoint^ tempRemoteEP = safe_cast<EndPoint^>(sender);

int read = s->EndReceiveFrom( ar, tempRemoteEP );

if ( read > 0 )
{
   so->sb->Append( Encoding::ASCII->GetString( so->buffer, 0, read ) );
   s->BeginReceiveFrom( so->buffer, 0, StateObject::BUFFER_SIZE, SocketFlags::None,
      tempRemoteEP, gcnew AsyncCallback( &Async_Send_Receive::ReceiveFrom_Callback ), so );
}
else
{
   if ( so->sb->Length > 1 )
   {
      //All the data has been read, so displays it to the console.
      String^ strContent = so->sb->ToString();
      Console::WriteLine( "Read {0} byte from socket" +
         " data = {1}", strContent->Length, strContent );
   }
   s->Close();
}
StateObject so = (StateObject) ar.AsyncState;
Socket s = so.workSocket;

      // Creates a temporary EndPoint to pass to EndReceiveFrom.
      IPEndPoint sender = new IPEndPoint(IPAddress.Any, 0);
EndPoint tempRemoteEP = (EndPoint)sender;

      int read = s.EndReceiveFrom(ar, ref tempRemoteEP); 


if (read > 0) {
           so.sb.Append(Encoding.ASCII.GetString(so.buffer, 0, read));
           s.BeginReceiveFrom(so.buffer, 0, StateObject.BUFFER_SIZE, 0, ref tempRemoteEP,
           	                     new AsyncCallback(Async_Send_Receive.ReceiveFrom_Callback), so);
}
else{
     if (so.sb.Length > 1) {
          //All the data has been read, so displays it to the console.
          string strContent;
          strContent = so.sb.ToString();
          Console.WriteLine(String.Format("Read {0} byte from socket" + 
          	               "data = {1} ", strContent.Length, strContent));
     }
     s.Close();
     
}
   Dim so As StateObject = CType(ar.AsyncState, StateObject)
   Dim s As Socket = so.workSocket
   
   ' Creates a temporary EndPoint to pass to EndReceiveFrom.
   Dim sender As New IPEndPoint(IPAddress.Any, 0)
   Dim tempRemoteEP As EndPoint = CType(sender, EndPoint)
   
   Dim read As Integer = s.EndReceiveFrom(ar, tempRemoteEP)
   
   
   If read > 0 Then
      so.sb.Append(Encoding.ASCII.GetString(so.buffer, 0, read))
      s.BeginReceiveFrom(so.buffer, 0, StateObject.BUFFER_SIZE, 0, tempRemoteEP, New AsyncCallback(AddressOf Async_Send_Receive.ReceiveFrom_Callback), so)
   Else
      If so.sb.Length > 1 Then
         'All the data has been read, so displays it to the console.
         Dim strContent As String
         strContent = so.sb.ToString()
         Console.WriteLine([String].Format("Read {0} byte from socket" + "data = {1} ", strContent.Length, strContent))
      End If
      s.Close()
   End If 
End Sub 'ReceiveFrom_Callback

注釈

メソッドは、 BeginReceiveFromメソッドで開始された非同期の読み取り操作を完了します。 EndReceiveFromThe EndReceiveFrom method completes the asynchronous read operation started in the BeginReceiveFrom method.

を呼び出すBeginReceiveFrom前に、 AsyncCallbackデリゲートを実装するコールバックメソッドを作成する必要があります。Before calling BeginReceiveFrom, you need to create a callback method that implements the AsyncCallback delegate. このコールバックメソッドは、別のスレッドで実行され、がBeginReceiveFrom返された後にシステムによって呼び出されます。This callback method executes in a separate thread and is called by the system after BeginReceiveFrom returns. コールバックメソッドは、パラメーター IAsyncResultとしてBeginReceiveFromメソッドによって返されたを受け入れる必要があります。The callback method must accept the IAsyncResult returned by the BeginReceiveFrom method as a parameter.

コールバックメソッド内で、 AsyncState IAsyncResultのメソッドを呼び出して、 BeginReceiveFromメソッドに渡される状態オブジェクトを取得します。Within the callback method, call the AsyncState method of the IAsyncResult to obtain the state object passed to the BeginReceiveFrom method. この状態オブジェクトSocketから受信を抽出します。Extract the receiving Socket from this state object. を取得Socketした後、 EndReceiveFromメソッドを呼び出して、読み取り操作を正常に完了し、読み取ったバイト数を返すことができます。After obtaining the Socket, you can call the EndReceiveFrom method to successfully complete the read operation and return the number of bytes read.

メソッドEndReceiveFromは、データが使用可能になるまでブロックします。The EndReceiveFrom method will block until data is available. コネクションレスプロトコルを使用しているEndReceiveFrom場合、は、受信ネットワークバッファーで使用可能な最初のエンキューされたデータグラムを読み取ります。If you are using a connectionless protocol, EndReceiveFrom will read the first enqueued datagram available in the incoming network buffer. 接続指向プロトコルを使用している場合、 EndReceiveFromメソッドは、 BeginReceiveFromメソッドのsizeパラメーターで指定したバイト数まで、使用可能な量のデータを読み取ります。If you are using a connection-oriented protocol, the EndReceiveFrom method will read as much data as is available up to the number of bytes you specified in the size parameter of the BeginReceiveFrom method. リモートホストがSocket Shutdownメソッドとの接続を切断し、使用可能なすべてのデータを受信したEndReceiveFrom場合、メソッドは直ちに完了し、0バイトを返します。If the remote host shuts down the Socket connection with the Shutdown method, and all available data has been received, the EndReceiveFrom method will complete immediately and return zero bytes. 受信したデータを取得するにAsyncStateは、 IAsyncResultオブジェクトのメソッドを呼び出し、結果の状態オブジェクトに格納されているバッファーを抽出します。To obtain the received data, call the AsyncState method of the IAsyncResult object, and extract the buffer contained in the resulting state object. 元のホストを特定するにはEndPoint 、を抽出し、 IPEndPointにキャストします。To identify the originating host, extract the EndPoint and cast it to an IPEndPoint. メソッドを使用して、IP アドレスIPEndPoint.Portを取得し、メソッドを使用してポート番号を取得します。 IPEndPoint.AddressUse the IPEndPoint.Address method to obtain the IP address and the IPEndPoint.Port method to obtain the port number.

注意

SocketException受け取った場合は、 SocketException.ErrorCodeプロパティを使用して、特定のエラーコードを取得します。If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. このコードを取得したら、 Windows Sockets version 2 API エラーコードのドキュメントを参照して、エラーの詳細な説明を参照してください。After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

注意

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。This member outputs trace information when you enable network tracing in your application. 詳細については、「 .NET Framework のネットワークトレース」を参照してください。For more information, see Network Tracing in the .NET Framework.

適用対象