Export (0) Print
Expand All

TcpListener.AcceptTcpClientAsync Method

.NET Framework 4.5

Accepts a pending connection request as an asynchronous operation.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public Task<TcpClient> AcceptTcpClientAsync()

Return Value

Type: System.Threading.Tasks.Task<TcpClient>
Returns Task<TResult>
The task object representing the asynchronous operation. The Result property on the task object returns a TcpClient used to send and receive data.

ExceptionCondition
InvalidOperationException

The listener has not been started with a call to Start.

SocketException

Use the SocketException.ErrorCode property to obtain the specific error code. When you have obtained this code, you can refer to the Windows Sockets version 2 API error code documentation in MSDN for a detailed description of the error.

This operation will not block. The returned Task<TResult> object will complete after the TCP connection has been accepted.

Use the TcpClient.GetStream method to obtain the underlying NetworkStream of the returned TcpClient in the Task<TResult>. The NetworkStream will provide you with methods for sending and receiving with the remote host. When you are through with the TcpClient, be sure to call its Close method. If you want greater flexibility than a TcpClient offers, consider using AcceptSocket or AcceptSocketAsync.

NoteNote

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.6, 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft