This topic has not yet been rated - Rate this topic

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.

Note Note

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

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ