Socket.ReceiveFromAsync メソッド

ソース:

Socket.cs

ソース:

Socket.cs

ソース:

Socket.cs

public:
 bool ReceiveFromAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);

public bool ReceiveFromAsync (System.Net.Sockets.SocketAsyncEventArgs e);

member this.ReceiveFromAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool

Public Function ReceiveFromAsync (e As SocketAsyncEventArgs) As Boolean

パラメーター

戻り値

I/O 操作が保留中の場合は true。 操作の完了時に、e パラメーターの Completed イベントが発生します。

I/O 操作が同期的に完了した場合は false。 この場合、e パラメーターの Completed イベントは発生しません。メソッド呼び出しから制御が戻った直後に、パラメーターとして渡された e オブジェクトを調べて操作の結果を取得できます。

例外

注釈

メソッドは ReceiveFromAsync 、主にコネクションレス ソケットでデータを受信するために使用されます。 ソケットのローカル アドレスは既知である必要があります。

呼び出し元は、 プロパティをSocketAsyncEventArgs.RemoteEndPointEndPointリモート ホストのエンドポイントと同じ型の に設定する必要があります。 プロパティは、実際のリモート エンドポイントへの正常な受信時に更新されます。

パラメーターの e プロパティはSocketAsyncEventArgs.SocketFlags、Window Sockets サービス プロバイダーに読み取り要求に関する追加情報を提供します。 このパラメーターの使用方法の詳細については、「」を参照してください System.Net.Sockets.SocketFlags。

このメソッドを正常に呼び出すには、オブジェクトの System.Net.Sockets.SocketAsyncEventArgs 次のプロパティとイベントが必要です。

• SocketAsyncEventArgs.Buffer

• SocketAsyncEventArgs.Count

• SocketAsyncEventArgs.Offset

• SocketAsyncEventArgs.RemoteEndPoint

• SocketAsyncEventArgs.Completed

呼び出し元は、コールバック メソッドで情報を取得できるように、メソッドをReceiveFromAsync呼び出す前に必要な任意のユーザー状態オブジェクトに プロパティを設定SocketAsyncEventArgs.UserTokenできます。 コールバックに 1 つのオブジェクトよりも多くの情報が必要な場合は、他の必要な状態情報をメンバーとして保持する小さなクラスを作成できます。

メッセージ指向ソケットの場合、受信メッセージはバッファーの合計サイズまでバッファーに配置されます。 プロパティと SocketAsyncEventArgs.Offset プロパティはSocketAsyncEventArgs.Count、バッファー内のデータの配置場所とデータ量を決定します。

バイト ストリーム スタイルのソケットの場合、バッファーがいっぱいになるまで、接続が閉じられるか、内部的にバッファーに格納されたデータが使い果たされるまで、受信データがバッファーに配置されます。 プロパティと SocketAsyncEventArgs.Offset プロパティはSocketAsyncEventArgs.Count、バッファー内のデータの配置場所とデータ量を決定します。

こちらもご覧ください

• SocketAsyncEventArgs
• Buffer
• Completed
• Count
• Offset
• RemoteEndPoint
• UserToken

ソース:

Socket.Tasks.cs

ソース:

Socket.Tasks.cs

ソース:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task<System::Net::Sockets::SocketReceiveFromResult> ^ ReceiveFromAsync(ArraySegment<System::Byte> buffer, System::Net::EndPoint ^ remoteEndPoint);

public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync (ArraySegment<byte> buffer, System.Net.EndPoint remoteEndPoint);

member this.ReceiveFromAsync : ArraySegment<byte> * System.Net.EndPoint -> System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult>

Public Function ReceiveFromAsync (buffer As ArraySegment(Of Byte), remoteEndPoint As EndPoint) As Task(Of SocketReceiveFromResult)

パラメーター

戻り値

受信したバイト数と SocketReceiveFromResult 送信側ホストのエンドポイントを含む を使用して完了する非同期タスク。

例外

ソース:

Socket.Tasks.cs

ソース:

Socket.Tasks.cs

ソース:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task<System::Net::Sockets::SocketReceiveFromResult> ^ ReceiveFromAsync(ArraySegment<System::Byte> buffer, System::Net::Sockets::SocketFlags socketFlags, System::Net::EndPoint ^ remoteEndPoint);

public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync (ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint);

member this.ReceiveFromAsync : ArraySegment<byte> * System.Net.Sockets.SocketFlags * System.Net.EndPoint -> System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult>

Public Function ReceiveFromAsync (buffer As ArraySegment(Of Byte), socketFlags As SocketFlags, remoteEndPoint As EndPoint) As Task(Of SocketReceiveFromResult)

パラメーター

戻り値

受信したバイト数と SocketReceiveFromResult 送信側ホストのエンドポイントを含む を使用して完了する非同期タスク。

例外

ソース:

Socket.Tasks.cs

ソース:

Socket.Tasks.cs

ソース:

Socket.Tasks.cs

public System.Threading.Tasks.ValueTask<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync (Memory<byte> buffer, System.Net.EndPoint remoteEndPoint, System.Threading.CancellationToken cancellationToken = default);

member this.ReceiveFromAsync : Memory<byte> * System.Net.EndPoint * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Net.Sockets.SocketReceiveFromResult>

Public Function ReceiveFromAsync (buffer As Memory(Of Byte), remoteEndPoint As EndPoint, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of SocketReceiveFromResult)

パラメーター

戻り値

受信したバイト数と SocketReceiveFromResult 送信側ホストのエンドポイントを含む を使用して完了する非同期タスク。

例外

ソース:

Socket.Tasks.cs

ソース:

Socket.Tasks.cs

ソース:

Socket.Tasks.cs

public System.Threading.Tasks.ValueTask<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync (Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint, System.Threading.CancellationToken cancellationToken = default);

member this.ReceiveFromAsync : Memory<byte> * System.Net.Sockets.SocketFlags * System.Net.EndPoint * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Net.Sockets.SocketReceiveFromResult>

Public Function ReceiveFromAsync (buffer As Memory(Of Byte), socketFlags As SocketFlags, remoteEndPoint As EndPoint, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of SocketReceiveFromResult)

パラメーター

戻り値

受信したバイト数と SocketReceiveFromResult 送信側ホストのエンドポイントを含む を使用して完了する非同期タスク。

例外

ソース:

Socket.Tasks.cs

ソース:

Socket.Tasks.cs

public System.Threading.Tasks.ValueTask<int> ReceiveFromAsync (Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.SocketAddress receivedAddress, System.Threading.CancellationToken cancellationToken = default);

member this.ReceiveFromAsync : Memory<byte> * System.Net.Sockets.SocketFlags * System.Net.SocketAddress * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Function ReceiveFromAsync (buffer As Memory(Of Byte), socketFlags As SocketFlags, receivedAddress As SocketAddress, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

パラメーター

戻り値

受信したバイト数と SocketReceiveFromResult 送信側ホストのエンドポイントを含む を使用して完了する非同期タスク。

例外