AcceptAsync Method

Socket.AcceptAsync Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Begins an asynchronous operation to accept an incoming connection attempt.

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

public bool AcceptAsync(
	SocketAsyncEventArgs e
)

Parameters

e
Type: System.Net.Sockets.SocketAsyncEventArgs
The SocketAsyncEventArgs object to use for this asynchronous socket operation.

Return Value

Type: System.Boolean
Returns true if the operation is pending. The Completed event on the e parameter will be raised upon completion of the operation. Returns false if the operation completed synchronously. 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.

ExceptionCondition
ArgumentException

An argument is not valid. This exception occurs if the buffer provided is not large enough. The buffer must be at least 2 * (sizeof(SOCKADDR_STORAGE + 16) bytes.

This exception also occurs if multiple buffers are specified, the SocketAsyncEventArgs.BufferList property is not null.

ArgumentOutOfRangeException

An argument is out of range. The exception occurs if the Count is less than 0.

InvalidOperationException

An invalid operation was requested. This exception occurs if the accepting Socket is not listening for connections or the accepted socket is bound.

You must call the Bind and Listen methods before calling the AcceptAsync(SocketAsyncEventArgs) method.

This exception also occurs if the socket is already connected or a socket operation was already in progress using the specified e parameter.

SocketException

An error occurred when attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

Connection-oriented protocols can use the AcceptAsync method to asynchronously process incoming connection attempts. Accepting connections asynchronously gives you the ability to send and receive data within a separate execution thread. Before calling the AcceptAsync method, you must call the Listen method to listen for and queue incoming connection requests.

To be notified of completion, you must create a callback method that implements the EventHandler<SocketAsyncEventArgs> delegate and hook it to the Completed event.The following properties and events on the SocketAsyncEventArgs object are required:

The caller can optionally specify an existing Socket to use for the incoming connection by specifying the Socket to use with the AcceptSocket property. If the AcceptSocket property is null, a new Socket is constructed with the same AddressFamily, SocketType, and ProtocolType as the current Socket and set as the AcceptSocket property.

The caller may set the UserToken property to any user state object desired before calling the AcceptAsync method, so that the information will be retrievable in the callback method. 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.

Optionally, a buffer may be provided in which to receive the initial block of data on the socket after the ConnectAsync method succeeds. In this case, the Buffer property needs to be set to the buffer containing the data to receive and the Count property needs to be set to the maximum number of bytes of data to receive in the buffer. These properties can be set using the SetBuffer method. Part of the buffer passed in will be consumed internally for use by the the underlying Winsock AcceptEx call. This means that the amount of data returned will always be less than the value of the Count property on the SocketAsyncEventArgs instance provided. The amount of the buffer used internally varies based on the address family of the socket. The minimum buffer size required is 288 bytes. If a larger buffer size is specified, then the Socket will expect some extra data other than the address data received by the Winsock AcceptEx call and will wait until this extra data is received. If a timeout occurs, the connection is reset. So if extra data is expected of a specific amount, then the buffer size should be set to the minimum buffer size plus this amount.The completion callback method should examine the SocketError property to determine if the AcceptAsync operation was successful.The Completed event can occur in some cases when no connection has been accepted and cause the SocketError property to be set to ConnectionReset. This can occur as a result of port scanning using a half-open SYN type scan (a SYN -> SYN-ACK -> RST sequence). Applications using the AcceptAsync method should be prepared to handle this condition.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2017 Microsoft