Socket.BeginReceive Method (IList(ArraySegment(Byte)), SocketFlags, AsyncCallback, Object) (System.Net.Sockets)

BeginReceive Method (IList(ArraySeg...

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework 3.0

.NET Framework Class Library

Socket..::.BeginReceive Method (IList<(Of <(ArraySegment<(Of <(Byte>)>)>)>), SocketFlags, AsyncCallback, Object)

Updated: November 2007

Begins to asynchronously receive data from a connected Socket.

This API is not CLS-compliant.

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

Syntax

Visual Basic (Declaration)

<CLSCompliantAttribute(False)> _
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)> _
Public Function BeginReceive ( _
    buffers As IList(Of ArraySegment(Of Byte)), _
    socketFlags As SocketFlags, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

Visual Basic (Usage)

Dim instance As Socket
Dim buffers As IList(Of ArraySegment(Of Byte))
Dim socketFlags As SocketFlags
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginReceive(buffers, _
    socketFlags, callback, state)

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

Visual C++

[CLSCompliantAttribute(false)]
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
IAsyncResult^ BeginReceive(
    IList<ArraySegment<unsigned char>>^ buffers, 
    SocketFlags socketFlags, 
    AsyncCallback^ callback, 
    Object^ state
)

/** @attribute CLSCompliantAttribute(false) */
/** @attribute HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true) */
public IAsyncResult BeginReceive(
    IList<ArraySegment<byte>> buffers,
    SocketFlags socketFlags,
    AsyncCallback callback,
    Object state
)

JScript

public function BeginReceive(
    buffers : IList<ArraySegment<byte>>, 
    socketFlags : SocketFlags, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

Parameters

buffers: Type: System.Collections.Generic..::.IList<(Of <(ArraySegment<(Of <(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.

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.

Exceptions

Exception	Condition
ArgumentNullException	buffer is nullNothingnullptra null reference (Nothing in Visual Basic).
SocketException	An error occurred when attempting to access the socket. See the Remarks section for more information.
ObjectDisposedException	Socket has been closed.

Remarks

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

Note:

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.

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

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

Note:
state is an instantiation of a user-defined class.

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

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

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, 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.

Version Information