This documentation is archived and is not being maintained.

TcpClient.Available Property

Gets the amount of data that has been received from the network and is available to be 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 and available to be read.

ExceptionCondition
SocketException

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

ObjectDisposedException

The Socket has been closed.

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

If the remote host shuts down or closes the connection, Available may throw a SocketException. If you receive a SocketException, use SocketException.ErrorCode to obtain the specific error code. After you have obtained this code, you can 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.

static void GetAvailable()
{
    // Find out how many bytes are ready to be read.
    Console.WriteLine("Availabe value is {0}", t.Available);
}
static void GetAvailable(TcpClient *t)
{
    // Find out how many bytes are ready to be read.
    Console::WriteLine(S"Available value is {0}", 
        __box(t->Available)->ToString());;
}

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: