Socket.DisconnectAsync メソッド

定義

名前空間:

System.Net.Sockets

アセンブリ:

System.Net.Sockets.dll

オーバーロード

DisconnectAsync(SocketAsyncEventArgs)	リモート エンドポイントからの切断の非同期要求を開始します。
DisconnectAsync(Boolean, CancellationToken)	接続されているソケットをリモート ホストから切断します。

DisconnectAsync(SocketAsyncEventArgs)

ソース:

Socket.cs

リモート エンドポイントからの切断の非同期要求を開始します。

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

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

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

Public Function DisconnectAsync (e As SocketAsyncEventArgs) As Boolean

パラメーター

e

SocketAsyncEventArgs

この非同期ソケット操作に使用する SocketAsyncEventArgs オブジェクト。

戻り値

Boolean

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

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

例外

ArgumentNullException

e パラメーターを null 値にすることはできません。

InvalidOperationException

e パラメーターに指定された SocketAsyncEventArgs オブジェクトを使用してソケット操作が既に進行していました。

ObjectDisposedException

Socket が閉じられました。

SocketException

ソケットへのアクセスを試行しているときにエラーが発生しました。

注釈

接続指向プロトコルを使用する場合、 メソッドを DisconnectAsync 呼び出すと、リモート エンドポイントからの切断が要求されます。 パラメーターで を e にtrue設定SocketAsyncEventArgs.DisconnectReuseSocketすると、ソケットを再利用できます。

こちらもご覧ください

• SocketAsyncEventArgs
• Completed
• DisconnectReuseSocket

DisconnectAsync(Boolean, CancellationToken)

ソース:

Socket.Tasks.cs

接続されているソケットをリモート ホストから切断します。

public System.Threading.Tasks.ValueTask DisconnectAsync (bool reuseSocket, System.Threading.CancellationToken cancellationToken = default);

member this.DisconnectAsync : bool * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function DisconnectAsync (reuseSocket As Boolean, Optional cancellationToken As CancellationToken = Nothing) As ValueTask

パラメーター

reuseSocket

Boolean

切断後にソケットを再利用できるようにする必要があるかどうかを示します。

cancellationToken

CancellationToken

非同期操作を取り消すために使用できるキャンセル トークン。

戻り値

ValueTask

ソケットが切断されたときに完了する非同期タスク。

例外

ObjectDisposedException

Socket オブジェクトは閉じられています。

SocketException

ソケットへのアクセスを試行しているときにエラーが発生しました。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Disconnect(Boolean)スローされる例外に関するページを参照してください。