Export (0) Print
Expand All

Socket.BeginReceive Method (IList<ArraySegment<Byte>>, SocketFlags, SocketError%, AsyncCallback, Object)

Begins to asynchronously receive data from a connected Socket.

This API is not CLS-compliant. 

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

[CLSCompliantAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public IAsyncResult BeginReceive(
	IList<ArraySegment<byte>> buffers,
	SocketFlags socketFlags,
	out SocketError errorCode,
	AsyncCallback callback,
	Object state
)

Parameters

buffers
Type: System.Collections.Generic.IList<ArraySegment<Byte>>

An array of type Byte that is the storage location for the received data.

socketFlags
Type: System.Net.Sockets.SocketFlags

A bitwise combination of the SocketFlags values.

errorCode
Type: System.Net.Sockets.SocketError%

A SocketError object that stores the socket error.

callback
Type: System.AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state
Type: System.Object

A user-defined object that contains information about the receive operation. This object is passed to the EndReceive delegate when the operation is complete.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references the asynchronous read.

ExceptionCondition
ArgumentNullException

buffer is null.

SocketException

An error occurred when attempting to access the socket. See the Remarks section for more information.

ObjectDisposedException

Socket has been closed.

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.

The asynchronous BeginReceive operation must be completed by calling the EndReceive method. Typically, the method is invoked by the callback delegate.

This method does not block until the operation is complete. To block until the operation is complete, use one of the Receive method overloads.

To cancel a pending BeginReceive, call the Close method.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously.

NoteNote:

If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error.

NoteNote:

All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes.

NoteNote:

state is an instantiation of a user-defined class.

NoteNote:

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

NoteNote:

The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous Socket methods. After the first use of a particular context (a specific asynchronous Socket method, a specific Socket instance, and a specific callback), subsequent uses of that context will see a performance improvement.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft