Socket.EndReceive

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

Socket.EndReceive メソッド (IAsyncResult, SocketError)

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

保留中の非同期読み込みを終了します。

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

Visual Basic (宣言)

Public Function EndReceive ( _
    asyncResult As IAsyncResult, _
    <OutAttribute> ByRef errorCode As
 SocketError _
) As Integer

Visual Basic (使用法)

Dim instance As Socket
Dim asyncResult As IAsyncResult
Dim errorCode As SocketError
Dim returnValue As Integer

returnValue = instance.EndReceive(asyncResult, errorCode)

C#

public int EndReceive (
    IAsyncResult asyncResult,
    out SocketError errorCode
)

C++

public:
int EndReceive (
    IAsyncResult^ asyncResult, 
    [OutAttribute] SocketError% errorCode
)

J#

public int EndReceive (
    IAsyncResult asyncResult, 
    /** @attribute OutAttribute() */ /** @ref */ SocketError errorCode
)

JScript

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

パラメータ

asyncResult

この非同期操作の状態情報およびユーザー定義データを格納する IAsyncResult。

errorCode

ソケット エラーを格納する SocketError オブジェクト。

戻り値
受信したバイト数。

例外

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

解説

EndReceive メソッドは、BeginReceive メソッドで開始された非同期の読み取り操作を完了します。

BeginReceive を呼び出す前に、AsyncCallback デリゲートを実装するコールバック メソッドを作成する必要があります。このコールバック メソッドは個別のスレッドで実行され、BeginReceive の終了時に呼び出されます。コールバック メソッドは、BeginReceive メソッドからパラメータとして返された IAsyncResult を受け取る必要があります。

コールバック メソッド内では、IAsyncResult の AsyncState メソッドを呼び出して、BeginReceive に渡された状態オブジェクトを取得します。この状態オブジェクトから受信した Socket を抽出してください。Socket を取得したら、EndReceive メソッドを呼び出して読み取り操作を正常に完了し、読み取られたバイト数を返すことができます。

EndReceive メソッドは、データが使用可能になるまでブロックします。コネクションレスのプロトコルを使用している場合、EndReceive は、受信ネットワーク バッファ内で使用できる、最初にキューに格納されたデータグラムを読み取ります。コネクション指向のプロトコルを使用している場合、EndReceive メソッドは、BeginReceive メソッドの size パラメータで指定したバイト数までの、使用可能なデータをすべて読み取ります。リモート ホストが Shutdown メソッドで Socket 接続をシャットダウンし、使用できるデータがすべて受信されると、EndReceive メソッドはすぐに完了して、0 バイトを返します。

受信したデータを取得するには、IAsyncResult の AsyncState メソッドを呼び出して、結果として得られる状態オブジェクト内のバッファを抽出します。

メモ
SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラー コードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラー コードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ
特定のスレッドによって開始されたすべての入出力は、そのスレッドが存在する場合、キャンセルされます。操作完了前にスレッドが終了する場合、保留中の非同期操作でエラーが発生する場合があります。

メモ
このメンバは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

プラットフォーム

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

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間
BeginReceive
AsyncCallback
IAsyncResult
AsyncState
Shutdown

Socket.EndReceive メソッド

保留中の非同期読み込みを終了します。
オーバーロードの一覧

名前	説明
Socket.EndReceive (IAsyncResult)	保留中の非同期読み込みを終了します。 .NET Compact Framework によってサポートされています。
Socket.EndReceive (IAsyncResult, SocketError)	保留中の非同期読み込みを終了します。

参照

関連項目

Socket クラス
Socket メンバ
System.Net.Sockets 名前空間
BeginReceive
AsyncCallback
IAsyncResult
AsyncState
Shutdown

Socket.EndReceive メソッド (IAsyncResult)

保留中の非同期読み込みを終了します。

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

Visual Basic (宣言)

Public Function EndReceive ( _
    asyncResult As IAsyncResult _
) As Integer

Visual Basic (使用法)

Dim instance As Socket
Dim asyncResult As IAsyncResult
Dim returnValue As Integer

returnValue = instance.EndReceive(asyncResult)

C#

public int EndReceive (
    IAsyncResult asyncResult
)

C++

public:
int EndReceive (
    IAsyncResult^ asyncResult
)

J#

public int EndReceive (
    IAsyncResult asyncResult
)

JScript

public function EndReceive (
    asyncResult : IAsyncResult
) : int

パラメータ

asyncResult

この非同期操作の状態情報およびユーザー定義データを格納する IAsyncResult。

戻り値
受信したバイト数。

例外

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

解説

EndReceive メソッドは、BeginReceive メソッドで開始された非同期の読み取り操作を完了します。

BeginReceive を呼び出す前に、AsyncCallback デリゲートを実装するコールバック メソッドを作成する必要があります。このコールバック メソッドは個別のスレッドで実行され、BeginReceive の終了時に呼び出されます。コールバック メソッドは、BeginReceive メソッドからパラメータとして返された IAsyncResult を受け取る必要があります。

コールバック メソッド内では、IAsyncResult の AsyncState メソッドを呼び出して、BeginReceive に渡された状態オブジェクトを取得します。この状態オブジェクトから受信した Socket を抽出してください。Socket を取得したら、EndReceive メソッドを呼び出して読み取り操作を正常に完了し、読み取られたバイト数を返すことができます。

EndReceive メソッドは、データが使用可能になるまでブロックします。コネクションレスのプロトコルを使用している場合、EndReceive は、受信ネットワーク バッファ内で使用できる、最初にキューに格納されたデータグラムを読み取ります。コネクション指向のプロトコルを使用している場合、EndReceive メソッドは、BeginReceive メソッドの size パラメータで指定したバイト数までの、使用可能なデータをすべて読み取ります。リモート ホストが Shutdown メソッドで Socket 接続をシャットダウンし、使用できるデータがすべて受信されると、EndReceive メソッドはすぐに完了して、0 バイトを返します。

受信したデータを取得するには、IAsyncResult の AsyncState メソッドを呼び出して、結果として得られる状態オブジェクト内のバッファを抽出します。

保留中の BeginReceive をキャンセルするには、Close メソッドを呼び出します。

メモ
SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラー コードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラー コードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ
特定のスレッドによって開始されたすべての入出力は、そのスレッドが存在する場合、キャンセルされます。操作完了前にスレッドが終了する場合、保留中の非同期操作でエラーが発生する場合があります。

メモ
このメンバは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

使用例

保留中の非同期読み込みを終了するコード例を次に示します。ソケットを使用した非同期通信を示すコード例の全体については、「ソケットのコード例」を参照してください。

Visual Basic

Public Shared Sub Read_Callback(ar
 As IAsyncResult)
   Dim so As StateObject = CType(ar.AsyncState,
 StateObject)
   Dim s As Socket = so.workSocket
   
   Dim read As Integer =
 s.EndReceive(ar)
   
   If read > 0 Then
      so.sb.Append(Encoding.ASCII.GetString(so.buffer, 0, read))
      s.BeginReceive(so.buffer, 0, StateObject.BUFFER_SIZE, 0, New
 AsyncCallback(AddressOf Async_Send_Receive.Read_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 'Read_Callback

C#

public static void Read_Callback(IAsyncResult
 ar){
    StateObject so = (StateObject) ar.AsyncState;
    Socket s = so.workSocket;

    int read = s.EndReceive(ar);

    if (read > 0) {
            so.sb.Append(Encoding.ASCII.GetString(so.buffer, 0, read));
            s.BeginReceive(so.buffer, 0, StateObject.BUFFER_SIZE, 0, 
                                     new AsyncCallback(Async_Send_Receive.Read_Callback),
 so);
    }
    else{
         if (so.sb.Length > 1) {
              //All of 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();
    }
}

C++

static void Read_Callback( IAsyncResult^ ar
 )
{
   StateObject^ so = safe_cast<StateObject^>(ar->AsyncState);
   Socket^ s = so->workSocket;

   int read = s->EndReceive( ar );

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

J#

StateObject so = (StateObject)ar.get_AsyncState();
Socket s = so.workSocket;
int read = s.EndReceive(ar);

if (read > 0) {
    so.sb.Append(Encoding.get_ASCII().GetString(so.buffer, 0, read));
    s.BeginReceive(so.buffer, 0, StateObject.BUFFER_SIZE,
        (SocketFlags)0, new AsyncCallback(Async_Send_Receive.
        Read_Callback), so);
}
else {
    if (so.sb.get_Length() > 1) {
        //All of 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} ", (Int32)strContent.get_Length(), 
            strContent));
    }
    s.Close();
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間
BeginReceive
AsyncCallback
IAsyncResult
AsyncState
Shutdown