Socket.Available Propriedade

Definição

Namespace:

System.Net.Sockets

Assembly:

System.Net.Sockets.dll

Origem:

Socket.cs

Obtém a quantidade de dados recebidos da rede e disponíveis para leitura.

public:
 property int Available { int get(); };

public int Available { get; }

member this.Available : int

Public ReadOnly Property Available As Integer

Valor da propriedade

Int32

O número de bytes de dados recebidos da rede e disponíveis para serem lidos.

Exceções

SocketException

Ocorreu um erro ao tentar acessar o soquete.

ObjectDisposedException

O Socket foi fechado.

Exemplos

O exemplo de código a seguir compara os resultados da chamada de IOControl com FIONREAD e a propriedade Available.

// FIONREAD is also available as the "Available" property.
const int FIONREAD = 0x4004667F;

void DisplayPendingByteCount( Socket^ s )
{
   array<Byte>^ outValue = BitConverter::GetBytes( 0 );
   
   // Check how many bytes have been received.
   s->IOControl( FIONREAD, nullptr, outValue );

   UInt32 bytesAvailable = BitConverter::ToUInt32( outValue, 0 );
   Console::WriteLine( "server has {0} bytes pending. Available property says {1}.",
      bytesAvailable, s->Available );

   return;
}

 // FIONREAD is also available as the "Available" property.
public const int FIONREAD   = 0x4004667F;

static void DisplayPendingByteCount(Socket s)
 {
     byte[] outValue = BitConverter.GetBytes(0);

     // Check how many bytes have been received.
     s.IOControl(FIONREAD, null, outValue);

     uint bytesAvailable = BitConverter.ToUInt32(outValue, 0);
     Console.WriteLine("server has {0} bytes pending. Available property says {1}.",
         bytesAvailable, s.Available);

     return;
 }

Comentários

Se você estiver usando um sem bloqueio Socket, Available será uma boa maneira de determinar se os dados estão na fila para leitura, antes de chamar Receive. Os dados disponíveis são a quantidade total de dados enfileirados no buffer de rede para leitura. Se nenhum dado estiver na fila no buffer de rede, Available retornará 0.

Se o host remoto desligar ou fechar a conexão, Available poderá gerar um SocketException. Se você receber um SocketException, use a SocketException.ErrorCode propriedade para obter o código de erro específico. Depois de obter esse código, consulte a documentação do código de erro da API do Windows Sockets versão 2 para obter uma descrição detalhada do erro.

Observação

Esse membro emite o rastreamento de informações quando você ativa o rastreamento de rede em seu aplicativo. Para obter mais informações, consulte Rastreamento de rede em .NET Framework.

Confira também

• Receive(Byte[], Int32, SocketFlags)
• Stream
• Dgram