Socket.ReceiveAsync(SocketAsyncEventArgs) Socket.ReceiveAsync(SocketAsyncEventArgs) Socket.ReceiveAsync(SocketAsyncEventArgs) Socket.ReceiveAsync(SocketAsyncEventArgs) Method

定義

接続されている Socket オブジェクトからデータを受信する非同期要求を開始します。Begins an asynchronous request to receive data from a connected Socket object.

public:
 bool ReceiveAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);
public bool ReceiveAsync (System.Net.Sockets.SocketAsyncEventArgs e);
member this.ReceiveAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool
Public Function ReceiveAsync (e As SocketAsyncEventArgs) As Boolean

パラメーター

e
SocketAsyncEventArgs SocketAsyncEventArgs SocketAsyncEventArgs SocketAsyncEventArgs

この非同期ソケット操作に使用する SocketAsyncEventArgs オブジェクト。The SocketAsyncEventArgs object to use for this asynchronous socket operation.

戻り値

I/O 操作が保留中の場合は truetrue if the I/O operation is pending. 操作の完了時に、e パラメーターの Completed イベントが発生します。The Completed event on the e parameter will be raised upon completion of the operation.

I/O 操作が同期的に完了した場合は falsefalse if the I/O operation completed synchronously. この場合、e パラメーターの Completed イベントは発生しません。メソッド呼び出しから制御が戻った直後に、パラメーターとして渡された e オブジェクトを調べて操作の結果を取得できます。In this case, The Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.

例外

引数が無効です。An argument was invalid. e パラメーターの Buffer プロパティまたは BufferList プロパティは、有効なバッファーを参照する必要があります。The Buffer or BufferList properties on the e parameter must reference valid buffers. これらのプロパティは、どちらか 1 つを設定できます。一度に両方のプロパティを設定することはできません。One or the other of these properties may be set, but not both at the same time.

e パラメーターに指定された SocketAsyncEventArgs オブジェクトを使用してソケット操作が既に進行していました。A socket operation was already in progress using the SocketAsyncEventArgs object specified in the e parameter.

このメソッドには Windows XP 以降が必要です。Windows XP or later is required for this method.

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

注釈

メソッドReceiveAsyncは、接続されたソケットまたはバインドされたコネクションレスソケットで使用され、受信データの読み取りに使用されます。The ReceiveAsync method is used on connected sockets or bound connectionless sockets and is used to read incoming data. ソケットのローカルアドレスがわかっている必要があります。The socket's local address must be known.

バインドされたコネクションレスソケットの場合、この関数は、受信したメッセージが受け入れられるアドレスを制限します。For bound connectionless sockets, this function restricts the addresses from which received messages are accepted. 関数は、接続で指定されたリモートアドレスからのメッセージのみを返します。The function only returns messages from the remote address specified in the connection. 他のアドレスからのメッセージは、暗黙的に破棄されます。Messages from other addresses are silently discarded.

eパラメーター SocketAsyncEventArgs.SocketFlagsのプロパティは、windows ソケットサービスプロバイダーに読み取り要求に関する追加情報を提供します。The SocketAsyncEventArgs.SocketFlags property on the e parameter provides the Window Sockets service provider with additional information about the read request. このパラメーターの使用方法の詳細についてはSystem.Net.Sockets.SocketFlags、「」を参照してください。For more information about how to use this parameter, see System.Net.Sockets.SocketFlags.

このメソッドを正常に呼び出すにSystem.Net.Sockets.SocketAsyncEventArgsは、オブジェクトの次のプロパティとイベントが必要です。The following properties and events on the System.Net.Sockets.SocketAsyncEventArgs object are required to successfully call this method:

呼び出し元は、 SocketAsyncEventArgs.UserToken ReceiveAsyncメソッドを呼び出す前に、プロパティを任意のユーザー状態オブジェクトに設定できます。これにより、コールバックメソッドで情報を取得できるようになります。The caller may set the SocketAsyncEventArgs.UserToken property to any user state object desired before calling the ReceiveAsync method, so that the information will be retrievable in the callback method. コールバックが1つのオブジェクトよりも多くの情報を必要とする場合は、他の必要な状態情報をメンバーとして保持するために、小さなクラスを作成できます。If the callback needs more information than a single object, a small class can be created to hold the other required state information as members.

バイトストリームスタイルのソケットの場合、バッファーがいっぱいになるか、接続が閉じられるか、内部バッファーデータが使い果たされるまで、受信データがバッファーに配置されます。For byte stream-style sockets, incoming data is placed into the buffer until the buffer is filled, the connection is closed, or the internally buffered data is exhausted.

メッセージ指向のソケットの場合、受信メッセージは、 eパラメーターに関連付けられているバッファーの合計サイズまでバッファーに配置されます。For message-oriented sockets, an incoming message is placed into the buffer up to the total size of the buffer associated with the e parameter. メッセージがバッファーより大きい場合、バッファーにはメッセージの最初の部分が格納されます。If the message is larger than the buffer, the buffer is filled with the first part of the message.

接続指向のソケットの場合、 ReceiveAsyncメソッドは、ソケットがバイトストリームかメッセージ指向かに応じて、2つの方法のいずれかで仮想回線の正常な終了を示すことができます。For connection-oriented sockets, the ReceiveAsync method can indicate the graceful termination of the virtual circuit in one of two ways that depend on whether the socket is byte stream or message oriented. バイトストリームの場合、読み取られたゼロバイトは正常に終了したことを示し、これ以上バイトは読み取られません。For byte streams, zero bytes having been read indicates graceful closure and that no more bytes will ever be read. ゼロバイトのメッセージが許容されるメッセージ指向のソケットの場合、ネイティブSocketException Winsock WSAEDISCON SocketAsyncEventArgs.SocketErrorエラーコード (10101) に設定されたを使用して、正常なクロージャを示すことができます。For message-oriented sockets, where a zero byte message is often allowable, a SocketException with the SocketAsyncEventArgs.SocketError set to the native Winsock WSAEDISCON error code (10101) is used to indicate graceful closure. いずれの場合も、 SocketExceptionSocketAsyncEventArgs.SocketErrorネイティブ Winsock WSAECONNRESET エラーコード (10054) に設定されたを使用すると、強制終了が発生したことを示します。In any case, a SocketException with the SocketAsyncEventArgs.SocketError set to the native Winsock WSAECONNRESET error code (10054) indicates an abortive close has occurred.

適用対象

こちらもご覧ください