TcpClient.ConnectAsync メソッド

リファレンス

定義

名前空間:: System.Net.Sockets

アセンブリ:: System.Net.Sockets.dll

アセンブリ:: System.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

指定されたホスト名とポート番号を使用して、非同期操作としてクライアントをリモート TCP ホストに接続します。

オーバーロード

ConnectAsync(String, Int32, CancellationToken)	非同期操作として、クライアントを、指定したホストの指定した TCP ポートに接続します。
ConnectAsync(IPAddress[], Int32, CancellationToken)	指定された IP アドレスとポート番号を使用して、非同期操作としてクライアントをリモート TCP ホストに接続します。
ConnectAsync(IPAddress, Int32, CancellationToken)	指定された IP アドレスとポート番号を使用して、非同期操作としてクライアントをリモート TCP ホストに接続します。
ConnectAsync(String, Int32)	非同期操作として、クライアントを、指定したホストの指定した TCP ポートに接続します。
ConnectAsync(IPEndPoint, CancellationToken)	指定したエンドポイントを非同期操作として使用して、クライアントをリモート TCP ホストに接続します。
ConnectAsync(IPAddress[], Int32)	指定された IP アドレスとポート番号を使用して、非同期操作としてクライアントをリモート TCP ホストに接続します。
ConnectAsync(IPAddress, Int32)	指定された IP アドレスとポート番号を使用して、非同期操作としてクライアントをリモート TCP ホストに接続します。
ConnectAsync(IPEndPoint)	指定したエンドポイントを非同期操作として使用して、クライアントをリモート TCP ホストに接続します。

ConnectAsync(String, Int32, CancellationToken)

ソース:: TCPClient.cs

ソース:: TCPClient.cs

ソース:: TCPClient.cs

非同期操作として、クライアントを、指定したホストの指定した TCP ポートに接続します。

public:
 System::Threading::Tasks::ValueTask ConnectAsync(System::String ^ host, int port, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.ValueTask ConnectAsync (string host, int port, System.Threading.CancellationToken cancellationToken);

member this.ConnectAsync : string * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function ConnectAsync (host As String, port As Integer, cancellationToken As CancellationToken) As ValueTask

パラメーター

host: String

リモートホストの DNS 名。

port: Int32

リモートホストのポート番号。

cancellationToken: CancellationToken

非同期操作のキャンセルが必要であることを示すために使用できるキャンセルトークン。

戻り値

ValueTask

非同期接続操作を表すタスク。

例外

ArgumentNullException

host パラメーターが null です。

ArgumentOutOfRangeException

port パラメーターが MinPort と MaxPort の間にありません。

SocketException

ソケットへのアクセス中にエラーが発生しました。

ObjectDisposedException

TcpClient は閉じています。

OperationCanceledException

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

注釈

この操作はブロックされません。返されたタスクは、TCP 接続が確立された後に完了します。このメソッドは、接続要求の進行中に呼び出し元のスレッドをブロックしません。

指定したホスト名とポート番号への同期リモートホスト接続を非同期操作として確立するには、このメソッドを呼び出します。リモートホストと接続した後、メソッドを GetStream 使用して基になる NetworkStreamを取得します。これを NetworkStream 使用して、データの送受信を行います。

IPv6 が有効で、メソッドが呼び出されて ConnectAsync(String, Int32) IPv6 アドレスと IPv4 アドレスの両方に解決されるホストに接続する場合、IPv4 アドレスの前に IPv6 アドレスへの接続が最初に試行されます。これは、ホストが IPv6 アドレスでリッスンしていない場合に、接続を確立する時間を遅らせる効果がある可能性があります。

注意

を受け取った場合は、 SocketExceptionを使用 SocketException.ErrorCode して特定のエラーコードを取得します。このコードを取得したら、エラーの詳細な説明については、 Windows ソケットバージョン 2 API エラーコードのドキュメントを参照してください。

Note

このメンバーは、アプリケーションでネットワークトレースが有効にされている場合にトレース情報を出力します。詳細については、「.NET Frameworkのネットワークトレース」を参照してください。

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

こちらもご覧ください

適用対象

ConnectAsync(IPAddress[], Int32, CancellationToken)

ソース:: TCPClient.cs

ソース:: TCPClient.cs

ソース:: TCPClient.cs

指定された IP アドレスとポート番号を使用して、非同期操作としてクライアントをリモート TCP ホストに接続します。

public:
 System::Threading::Tasks::ValueTask ConnectAsync(cli::array <System::Net::IPAddress ^> ^ addresses, int port, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.ValueTask ConnectAsync (System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken);

member this.ConnectAsync : System.Net.IPAddress[] * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function ConnectAsync (addresses As IPAddress(), port As Integer, cancellationToken As CancellationToken) As ValueTask

パラメーター

addresses: IPAddress[]

リモートホストの IP アドレスの配列。

port: Int32

リモートホストのポート番号。

cancellationToken: CancellationToken

非同期操作のキャンセルが必要であることを示すために使用できるキャンセルトークン。

戻り値

ValueTask

非同期接続操作を表すタスク。

例外

ArgumentNullException

ipAddresses パラメーターが null です。

ArgumentOutOfRangeException

ポート番号が無効です。

SocketException

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

ObjectDisposedException

Socket が閉じられました。

SecurityException

呼び出し履歴の上位にある呼び出し元には、要求された操作に対するアクセス許可がありません。

NotSupportedException

このメソッドは、InterNetwork フラグまたは InterNetworkV6 フラグを使用するソケットで有効です。

OperationCanceledException

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

注釈

このメソッドは通常、メソッドの呼び出しの直後に BeginGetHostAddresses 使用されます。このメソッドは、1 つのホストに対して複数の IP アドレスを返すことができます。 IP アドレスの配列とポート番号で指定されたホストへの同期リモートホスト接続を非同期操作として確立するには、このメソッドを呼び出します。リモートホストと接続した後、メソッドを GetStream 使用して基になる NetworkStreamを取得します。これを NetworkStream 使用して、データの送受信を行います。

注意

Note

注意

IPv6 アドレスの使用中に NotSupportedException とメッセージ This protocol version is not supported が表示される場合は、を渡 InterNetworkV6してコンストラクターで IPv6 を有効にしていることを確認します。

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

こちらもご覧ください

TcpListener

適用対象

ConnectAsync(IPAddress, Int32, CancellationToken)

ソース:: TCPClient.cs

ソース:: TCPClient.cs

ソース:: TCPClient.cs

指定された IP アドレスとポート番号を使用して、非同期操作としてクライアントをリモート TCP ホストに接続します。

public:
 System::Threading::Tasks::ValueTask ConnectAsync(System::Net::IPAddress ^ address, int port, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.ValueTask ConnectAsync (System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken);

member this.ConnectAsync : System.Net.IPAddress * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function ConnectAsync (address As IPAddress, port As Integer, cancellationToken As CancellationToken) As ValueTask

パラメーター

address: IPAddress

リモートホストの IP アドレス。

port: Int32

リモートホストのポート番号。

cancellationToken: CancellationToken

非同期操作のキャンセルが必要であることを示すために使用できるキャンセルトークン。

戻り値

ValueTask

非同期接続操作を表すタスク。

例外

ArgumentNullException

address パラメーターが null です。

ArgumentOutOfRangeException

port が MinPort と MaxPort の間の値ではありません。

SocketException

ソケットへのアクセス中にエラーが発生しました。

ObjectDisposedException

TcpClient は閉じています。

OperationCanceledException

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

注釈

指定した IP アドレスとポート番号への同期リモートホスト接続を非同期操作として確立するには、このメソッドを呼び出します。リモートホストと接続した後、メソッドを GetStream 使用して基になる NetworkStreamを取得します。これを NetworkStream 使用して、データの送受信を行います。

注意

Note

注意

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

こちらもご覧ください

GetStream()

適用対象

ConnectAsync(String, Int32)

ソース:: TCPClient.cs

ソース:: TCPClient.cs

ソース:: TCPClient.cs

非同期操作として、クライアントを、指定したホストの指定した TCP ポートに接続します。

public:
 System::Threading::Tasks::Task ^ ConnectAsync(System::String ^ host, int port);

public System.Threading.Tasks.Task ConnectAsync (string host, int port);

member this.ConnectAsync : string * int -> System.Threading.Tasks.Task

Public Function ConnectAsync (host As String, port As Integer) As Task

パラメーター

host: String

接続先のリモートホストの DNS 名。

port: Int32

接続先のリモートホストのポート番号。

戻り値

Task

非同期操作を表すタスクオブジェクト。

例外

ArgumentNullException

host パラメーターが null です。

ArgumentOutOfRangeException

port パラメーターが MinPort と MaxPort の間にありません。

SocketException

ソケットへのアクセス中にエラーが発生しました。

ObjectDisposedException

TcpClient は閉じています。

注釈

この操作はブロックされません。返された Returns Task オブジェクトは、TCP 接続が確立された後に完了します。このメソッドは、接続要求の進行中に呼び出し元のスレッドをブロックしません。

このメソッドを呼び出して、指定したホスト名とポート番号への同期リモートホスト接続を非同期操作として確立します。リモートホストに接続した後、メソッドを GetStream 使用して基になる NetworkStreamを取得します。これを NetworkStream 使用して、データの送受信を行います。

IPv6 が有効で、メソッドが呼び出されて ConnectAsync(String, Int32) IPv6 アドレスと IPv4 アドレスの両方に解決されるホストに接続する場合、IPv6 アドレスへの接続は最初に IPv4 アドレスの前に試行されます。これは、ホストが IPv6 アドレスでリッスンしていない場合に、接続を確立する時間を遅らせる効果がある可能性があります。

注意

を受け取った場合は、 SocketExceptionを使用 SocketException.ErrorCode して特定のエラーコードを取得します。このコードを取得したら、エラーの詳細な説明については、Windows ソケットバージョン 2 API エラーコードのドキュメントを参照してください。

Note

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

こちらもご覧ください

適用対象

ConnectAsync(IPEndPoint, CancellationToken)

ソース:: TCPClient.cs

ソース:: TCPClient.cs

ソース:: TCPClient.cs

指定したエンドポイントを非同期操作として使用して、クライアントをリモート TCP ホストに接続します。

public:
 System::Threading::Tasks::ValueTask ConnectAsync(System::Net::IPEndPoint ^ remoteEP, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.ValueTask ConnectAsync (System.Net.IPEndPoint remoteEP, System.Threading.CancellationToken cancellationToken);

member this.ConnectAsync : System.Net.IPEndPoint * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function ConnectAsync (remoteEP As IPEndPoint, cancellationToken As CancellationToken) As ValueTask

パラメーター

remoteEP: IPEndPoint

接続先の IPEndPoint。

cancellationToken: CancellationToken

この操作を取り消す必要があることを示す通知を伝達するために使用するキャンセルトークン。

戻り値

ValueTask

非同期操作を表すタスク。

例外

OperationCanceledException

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

注釈

指定したへの同期リモートホスト接続を確立するには、このメソッドを呼び出します IPEndPoint。を呼び出す Connect前に、IP アドレスとポート番号を IPEndPoint 使用してクラスのインスタンスを作成する必要があります。これは IPEndPoint パラメーターとして remoteEP 使用します。メソッドは Connect 、接続するか失敗するまでブロックします。リモートホストに接続した後、メソッドを GetStream 使用して基になる NetworkStreamを取得します。これを NetworkStream 使用して、データの送受信を行います。

注意

を受け取った場合は、 SocketExceptionを使用 SocketException.ErrorCode して特定のエラーコードを取得します。このコードを取得したら、エラーの詳細な説明については、Windows ソケットバージョン 2 API エラーコードのドキュメントを参照してください。

Note

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

適用対象

ConnectAsync(IPAddress[], Int32)

ソース:: TCPClient.cs

ソース:: TCPClient.cs

ソース:: TCPClient.cs

指定された IP アドレスとポート番号を使用して、非同期操作としてクライアントをリモート TCP ホストに接続します。

public:
 System::Threading::Tasks::Task ^ ConnectAsync(cli::array <System::Net::IPAddress ^> ^ addresses, int port);

public System.Threading.Tasks.Task ConnectAsync (System.Net.IPAddress[] addresses, int port);

member this.ConnectAsync : System.Net.IPAddress[] * int -> System.Threading.Tasks.Task

Public Function ConnectAsync (addresses As IPAddress(), port As Integer) As Task

パラメーター

addresses: IPAddress[]

接続先ホストの IPAddress 配列。

port: Int32

接続先のポート番号。

戻り値

Task

非同期操作を表すタスクオブジェクト。

例外

ArgumentNullException

ipAddresses パラメーターが null です。

ArgumentOutOfRangeException

ポート番号が無効です。

SocketException

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

ObjectDisposedException

Socket が閉じられました。

SecurityException

呼び出し履歴の上位にある呼び出し元には、要求された操作に対するアクセス許可がありません。

NotSupportedException

このメソッドは、InterNetwork フラグまたは InterNetworkV6 フラグを使用するソケットで有効です。

注釈

このメソッドは通常、メソッドの呼び出しの直後に BeginGetHostAddresses 使用されます。このメソッドは、1 つのホストに対して複数の IP アドレスを返すことができます。要素の配列 IPAddress とポート番号で指定されたホストへの同期リモートホスト接続を非同期操作として確立するには、このメソッドを呼び出します。リモートホストに接続した後、メソッドを GetStream 使用して基になる NetworkStreamを取得します。これを NetworkStream 使用して、データの送受信を行います。

注意

を受け取った場合は、 SocketExceptionを使用 SocketException.ErrorCode して特定のエラーコードを取得します。このコードを取得したら、エラーの詳細な説明については、Windows ソケットバージョン 2 API エラーコードのドキュメントを参照してください。

Note

注意

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

こちらもご覧ください

TcpListener

適用対象

ConnectAsync(IPAddress, Int32)

ソース:: TCPClient.cs

ソース:: TCPClient.cs

ソース:: TCPClient.cs

指定された IP アドレスとポート番号を使用して、非同期操作としてクライアントをリモート TCP ホストに接続します。

public:
 System::Threading::Tasks::Task ^ ConnectAsync(System::Net::IPAddress ^ address, int port);

public System.Threading.Tasks.Task ConnectAsync (System.Net.IPAddress address, int port);

member this.ConnectAsync : System.Net.IPAddress * int -> System.Threading.Tasks.Task

Public Function ConnectAsync (address As IPAddress, port As Integer) As Task

パラメーター

address: IPAddress

接続先ホストの IPAddress。

port: Int32

接続先のポート番号。

戻り値

Task

非同期操作を表すタスクオブジェクト。

例外

ArgumentNullException

address パラメーターが null です。

ArgumentOutOfRangeException

port が MinPort と MaxPort の間の値ではありません。

SocketException

ソケットへのアクセス中にエラーが発生しました。

ObjectDisposedException

TcpClient は閉じています。

注釈

指定した IPAddress ポート番号とポート番号への同期リモートホスト接続を非同期操作として確立するには、このメソッドを呼び出します。リモートホストと接続した後、メソッドを GetStream 使用して基になる NetworkStreamを取得します。これを NetworkStream 使用して、データの送受信を行います。

Note

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

こちらもご覧ください

GetStream()

適用対象

ConnectAsync(IPEndPoint)

ソース:: TCPClient.cs

ソース:: TCPClient.cs

ソース:: TCPClient.cs

指定したエンドポイントを非同期操作として使用して、クライアントをリモート TCP ホストに接続します。

public:
 System::Threading::Tasks::Task ^ ConnectAsync(System::Net::IPEndPoint ^ remoteEP);

public System.Threading.Tasks.Task ConnectAsync (System.Net.IPEndPoint remoteEP);

member this.ConnectAsync : System.Net.IPEndPoint -> System.Threading.Tasks.Task

Public Function ConnectAsync (remoteEP As IPEndPoint) As Task

パラメーター

remoteEP: IPEndPoint

接続先の IPEndPoint。

戻り値

Task

非同期操作を表すタスク。

注釈

この操作はブロックされません。返された Task オブジェクトは、TCP 接続が確立された後に完了します。このメソッドは、接続要求の進行中に呼び出し元のスレッドをブロックしません。

指定したへの同期リモートホスト接続を確立するには、このメソッドを呼び出します IPEndPoint。を呼び出す Connect前に、IP アドレスとポート番号を IPEndPoint 使用してクラスのインスタンスを作成する必要があります。これを IPEndPoint パラメーターとして remoteEP 使用します。メソッドは Connect 、接続するか失敗するまでブロックします。リモートホストと接続した後、メソッドを GetStream 使用して基になる NetworkStreamを取得します。これを NetworkStream 使用して、データの送受信を行います。

注意

Note

注意

IPv6 アドレスの使用中に "このプロトコルバージョンはサポートされていません" というメッセージが表示されたを受け取った NotSupportedException 場合は、を渡 InterNetworkV6してコンストラクターで IPv6 を有効にしてください。

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

適用対象

TcpClient.ConnectAsync メソッド

定義

オーバーロード

ConnectAsync(String, Int32, CancellationToken)

パラメーター

戻り値

例外

注釈

こちらもご覧ください

適用対象

ConnectAsync(IPAddress[], Int32, CancellationToken)

パラメーター

戻り値

例外

注釈

こちらもご覧ください

適用対象

ConnectAsync(IPAddress, Int32, CancellationToken)

パラメーター

戻り値

例外

注釈

こちらもご覧ください

適用対象

ConnectAsync(String, Int32)

パラメーター

戻り値

例外

注釈

こちらもご覧ください

適用対象

ConnectAsync(IPEndPoint, CancellationToken)

パラメーター

戻り値

例外

注釈

適用対象

ConnectAsync(IPAddress[], Int32)

パラメーター

戻り値

例外

注釈

こちらもご覧ください

適用対象

ConnectAsync(IPAddress, Int32)

パラメーター

戻り値

例外

注釈

こちらもご覧ください

適用対象

ConnectAsync(IPEndPoint)

パラメーター

戻り値

注釈

適用対象

フィードバック

その他のリソース