UdpClient.Available Property

 

Gets the amount of data received from the network that is available to read.

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

public int Available { get; }

Property Value

Type: System.Int32

The number of bytes of data received from the network.

Exception Condition
SocketException

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

ObjectDisposedException

The Socket has been closed.

The Available property is used to determine the amount of data queued in the network buffer for reading. If data is available, call Read to get the data. If no data is available, the Available property returns 0.

If the remote host shuts down or closes the connection, the Available property throws a SocketException.

System_CAPS_noteNote

If you receive a SocketException, use SocketException.ErrorCode to obtain the specific error code and refer to the Windows Sockets version 2 API error code documentation in the MSDN library at http://msdn.microsoft.com/library/ for a detailed description of the error.

The following code example shows the use of the Available property.

public static void GetAvailable(UdpClient u)
{
    // Get the number of bytes available for reading.
    Console.WriteLine("Available value is {0}",
        u.Available);
}

.NET Framework
Available since 2.0
Return to top
Show: