Socket.BeginReceive Method (Byte, Int32, Int32, SocketFlags, AsyncCallback, Object)
Begins to asynchronously receive data from a connected Socket.
Assembly: System (in System.dll)
[<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>] member BeginReceive : buffer:byte * offset:int * size:int * socketFlags:SocketFlags * callback:AsyncCallback * state:Object -> IAsyncResult
- Type: System.Int32
The zero-based position in the buffer parameter at which to store the received data.
- Type: System.Int32
The number of bytes to receive.
- Type: System.AsyncCallback
An AsyncCallback delegate that references the method to invoke when the operation is complete.
buffer is a null reference (Nothing in Visual Basic).
An error occurred when attempting to access the socket. See the Remarks section for more information.
Socket has been closed.
offset is less than 0.
offset is greater than the length of buffer.
size is less than 0.
size is greater than the length of buffer minus the value of the offset parameter.
This method does not block until the operation is complete. To block until the operation is complete, use one of the Receive method overloads.
For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously.
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.
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.
state is an instantiation of a user-defined class.
This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.
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.
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 following code example begins to asynchronously receive data from a connected Socket.