Socket.Receive Method (IList<ArraySegment<Byte>>, SocketFlags)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.


Receives data from a bound Socket into the list of receive buffers, using the specified SocketFlags.

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

member Receive : 
        buffers:IList<ArraySegment<byte>> *
        socketFlags:SocketFlags -> int


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

A list of ArraySegment<'T>s of type Byte that contains the received data.

Type: System.Net.Sockets.SocketFlags

A bitwise combination of the SocketFlags values.

Return Value

Type: System.Int32

The number of bytes received.

Exception Condition

buffers is null.


buffers.Count is zero.


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


The Socket has been closed.

This method reads data into the buffers parameter and returns the number of bytes successfully read. You can call from both connection-oriented and connectionless sockets.

This overload requires you to provide one or more receive buffers. The SocketFlags value defaults to None.

If you are using a connection-oriented protocol, you must either call Connect to establish a remote host connection, or Accept to accept an incoming connection prior to calling Receive. The Receive method will only read data that arrives from the remote host connection established in the Connect or Accept method. If you are using a connectionless protocol, you can also use the ReceiveFrom method. ReceiveFrom will allow you to receive data arriving from any host.

If no data is available for reading, the Receive method will block until data is available, unless a time-out value was set by using Socket.ReceiveTimeout. If the time-out value was exceeded, the Receive call throws a SocketException. If you are in non-blocking mode, and there is no data available in the in the protocol stack buffer, the Receive method will complete immediately and throw a SocketException. You can use the Available property to determine if data is available for reading. When Available is non-zero, retry the receive operation.

If you are using a connection-oriented Socket, the Receive method will read as much data as is available, up to the size of the buffer. If the remote host shuts down the Socket connection with the Shutdown method, and all available data has been received, the Receive method will complete immediately and return zero bytes.

If you are using a connectionless Socket, Receive will read the first enqueued datagram from the destination address you specify in the Connect method. If the datagram you receive is larger than the size of the buffers parameter, buffers gets filled with the first part of the message, the excess data is lost and a SocketException is thrown.


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.


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

The following code example demonstrates how to receive data on a connected Socket.

No code example is currently available or this language may not be supported.


for accepting connections from the network. Associated enumeration: Accept.

.NET Framework
Available since 2.0
Return to top