Socket.BeginReceiveMessageFrom Method

Begins to asynchronously receive the specified number of bytes of data into the specified location of the data buffer, using the specified SocketFlags, and stores the endpoint and packet information..

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

public IAsyncResult BeginReceiveMessageFrom(
	byte[] buffer,
	int offset,
	int size,
	SocketFlags socketFlags,
	ref EndPoint remoteEP,
	AsyncCallback callback,
	Object state
)

Parameters

buffer
Type: System.Byte[]

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

offset
Type: System.Int32

The zero-based position in the buffer parameter at which to store the data.

size
Type: System.Int32

The number of bytes to receive.

socketFlags
Type: System.Net.Sockets.SocketFlags

A bitwise combination of the SocketFlags values.

remoteEP
Type: System.Net.EndPoint

An EndPoint that represents the source of the data.

callback
Type: System.AsyncCallback

The AsyncCallback delegate.

state
Type: System.Object

An object that contains state information for this request.

Return Value

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

ExceptionCondition
ArgumentNullException

buffer is null.

-or-

remoteEP is null.

SocketException

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

ArgumentOutOfRangeException

offset is less than 0.

-or-

offset is greater than the length of buffer.

-or-

size is less than 0.

-or-

size is greater than the length of buffer minus the value of the offset parameter.

ObjectDisposedException

The Socket has been closed.

NotSupportedException

The operating system is Windows 2000 or earlier, and this method requires Windows XP.

The asynchronous receive operation must be completed by calling the EndReceiveMessageFrom method. Typically, the method is invoked by the asyncCallback delegate.

This method does not block until the operation completes. To block until the operation completes, use the ReceiveMessageFrom method.

To cancel a pending BeginReceiveMessageFrom, call the Close method.

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

This method reads data into the buffer parameter, and captures the remote host endpoint from which the data is sent, as well as information about the received packet. For information on how to retrieve this endpoint, refer to EndReceiveFrom. This method is most useful if you intend to asynchronously receive connectionless datagrams from an unknown host or multiple hosts.

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

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 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.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft