This topic has not yet been rated - Rate this topic

TcpClient.Available Property

.NET Framework 4.5

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.

Exceptions

Exception	Condition
SocketException	An error occurred when attempting to access the socket. See the Remarks section for more information.
ObjectDisposedException	The Socket has been closed.

Remarks

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.

Examples

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

C++

static void GetAvailable()
{
    // Find out how many bytes are ready to be read.
    Console.WriteLine("Availabe value is {0}", t.Available);
}

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

TcpClient Class

System.Net.Sockets Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)