Socket.ReceiveMessageFromAsync(SocketAsyncEventArgs) メソッド

定義

指定された SocketFlags を使用し、指定されたバイト数のデータの非同期受信を開始して、データ バッファー内の指定された場所に格納します。さらに、エンドポイントとパケットの情報を格納します。Begins to asynchronously receive the specified number of bytes of data into the specified location in the data buffer, using the specified SocketFlags, and stores the endpoint and packet information.

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

パラメーター

e
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.

例外

RemoteEndPoint に null 値を指定することはできません。The RemoteEndPoint cannot be null.

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

Socket が閉じられました。The Socket has been closed.

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

注釈

ReceiveMessageFromAsync メソッドは、主にコネクションレスソケットでメッセージデータを受信するために使用されます。The ReceiveMessageFromAsync method is used primarily to receive message data on a connectionless socket. ソケットのローカルアドレスがわかっている必要があります。The socket's local address must be known. このメソッドは、データグラムと raw ソケットでのみ使用できます。This method can only be used with datagram and raw sockets. ソケットは、このメソッドを呼び出す前に、Dgram または Raw に設定されたソケットの種類を使用して初期化する必要があります。The socket must be initialized with the socket type set to Dgram or Raw before calling this method. これは Socketを使用してソケットを構築するときに行うことができます。This can be done when the socket is constructed using Socket.

呼び出し元は、SocketAsyncEventArgs.RemoteEndPoint プロパティを、データを受信するリモートホストの IPEndPoint に設定する必要があります。The caller must set the SocketAsyncEventArgs.RemoteEndPoint property to the IPEndPoint of the remote host from which the data is to be received.

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

呼び出し元は、ReceiveMessageFromAsync メソッドを呼び出す前に、SocketAsyncEventArgs.UserToken プロパティを任意のユーザー状態オブジェクトに設定して、コールバックメソッドで情報を取得できるようにすることができます。The caller may set the SocketAsyncEventArgs.UserToken property to any user state object desired before calling the ReceiveMessageFromAsync 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 message-oriented sockets, an incoming message is placed into the buffer up to the total size of the buffer. SocketAsyncEventArgs.Count プロパティと SocketAsyncEventArgs.Offset プロパティによって、バッファー内のデータの格納場所とデータ量が決まります。The SocketAsyncEventArgs.Count and SocketAsyncEventArgs.Offset properties determine where in the buffer the data is placed and the amount of data.

ReceiveMessageFromAsync メソッドは、指定された Socketに対して初めて呼び出されたときに、PacketInformation socket オプションを true に自動的に設定します。The ReceiveMessageFromAsync method automatically sets the PacketInformation socket option to true the first time it is called for a given Socket. ただし、IPPacketInformation オブジェクトは、ソケットオプションが設定された後にローカルコンピューターに到着するパケットに対してのみ有効です。However, the IPPacketInformation object will only be valid for packets which arrive at the local computer after the socket option has been set. ソケットがローカルエンドポイントにバインドされたとき (Bind メソッドによって明示的に、または ConnectConnectAsyncSendTo、または SendToAsync メソッドのいずれかによって暗黙的に) にソケットが送信される場合は、ReceiveMessageFromAsync メソッドの最初の呼び出しです。では、ReceiveMessageFromAsync メソッドを呼び出すと、これらのパケットに対して無効な IPPacketInformation オブジェクトが生成されます。If a socket is sent packets between when the socket is bound to a local endpoint (explicitly by the Bind method or implicitly by one of the Connect, ConnectAsync, SendTo, or SendToAsync methods) and the first call to the ReceiveMessageFromAsync method, calls to ReceiveMessageFromAsync method will result in invalid IPPacketInformation objects for these packets.

すべての IPPacketInformation オブジェクトが有効であることを確認するには、SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean) メソッドを使用してローカルエンドポイントにバインドする前に、アプリケーションで PacketInformation socket オプションをtrue に設定する必要があります。To ensure that all IPPacketInformation objects are valid, an application should set the PacketInformation socket option totrue before it is bound to a local endpoint using the SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean) method.

アプリケーションでは、データグラムがユニキャスト、マルチキャスト、またはブロードキャストアドレスを使用して送信されたかどうかを確認する必要がある場合に、結果の IPPacketInformation オブジェクトを調べることができます。An application can examine the resulting IPPacketInformation objects if it needs to know if the datagram was sent using a unicast, multicast, or broadcast address.

適用対象

こちらもご覧ください