Socket.ReceiveMessageFromAsync(SocketAsyncEventArgs) Socket.ReceiveMessageFromAsync(SocketAsyncEventArgs) Socket.ReceiveMessageFromAsync(SocketAsyncEventArgs) Socket.ReceiveMessageFromAsync(SocketAsyncEventArgs) Method

定義

指定された 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 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.

例外

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

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

ソケットへのアクセスを試行しているときにエラーが発生しました。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:

呼び出し元の設定、SocketAsyncEventArgs.UserTokenを呼び出す前に必要なすべてのユーザー状態オブジェクトのプロパティ、ReceiveMessageFromAsyncメソッド情報をコールバック メソッドで取得できるようにします。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.CountSocketAsyncEventArgs.Offsetプロパティは、バッファー内のデータの配置場所と、データの量を決定します。The SocketAsyncEventArgs.Count and SocketAsyncEventArgs.Offset properties determine where in the buffer the data is placed and the amount of data.

ReceiveMessageFromAsyncメソッドが自動的に設定、PacketInformationソケット オプションtrue初めて呼び出された、指定されたSocketします。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オブジェクトが正しいこと、アプリケーションを設定する必要があります、PacketInformationソケット オプションtrueを使用して、ローカル エンドポイントにバインドされる前に、SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean)メソッド。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.

適用対象

こちらもご覧ください