Socket.Available Propriété

Définition

Obtient la quantité de données reçues du réseau et disponibles pour la lecture.

public:
 property int Available { int get(); };
public int Available { get; }
member this.Available : int
Public ReadOnly Property Available As Integer

Valeur de propriété

Nombre d'octets de données reçus du réseau et disponibles pour la lecture.

Exceptions

Une erreur s’est produite pendant la tentative d’accès au socket.

Exemples

L’exemple de code suivant compare les résultats de l’appel d’IOControl avec FIONREAD et la propriété 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;
 }

Remarques

Si vous utilisez un élément non bloquant Socket, Available est un bon moyen de déterminer si les données sont mises en file d’attente pour lecture, avant d’appeler Receive. Les données disponibles sont la quantité totale de données mises en file d’attente dans la mémoire tampon réseau pour la lecture. Si aucune donnée n’est mise en file d’attente dans la mémoire tampon réseau, Available retourne 0.

Si l’hôte distant s’arrête ou ferme la connexion, Available peut lever un SocketException. Si vous recevez un SocketException, utilisez la SocketException.ErrorCode propriété pour obtenir le code d’erreur spécifique. Une fois ce code obtenu, reportez-vous à la documentation du code d’erreur de l’API Windows Sockets version 2 pour obtenir une description détaillée de l’erreur.

Notes

Ce membre génère des informations de traçage lorsque vous activez le traçage réseau dans votre application. Pour plus d’informations, consultez Suivi réseau dans .NET Framework.

S’applique à

Voir aussi