Ping Classe

Définition

Espace de noms:

System.Net.NetworkInformation

Assemblys:

netstandard.dll, System.Net.Ping.dll

Source:

Ping.cs

Permet à une application de déterminer si un ordinateur distant est accessible sur le réseau.

public ref class Ping : System::ComponentModel::Component

public class Ping : System.ComponentModel.Component

type Ping = class
    inherit Component

Public Class Ping
Inherits Component

Héritage

Object

MarshalByRefObject

Component

Ping

Exemples

L’exemple de code suivant illustre l’utilisation synchrone de la Ping classe.

using System;
using System.Net;
using System.Net.NetworkInformation;
using System.Text;

namespace Examples.System.Net.NetworkInformation.PingTest
{
    public class PingExample
    {
        // args[0] can be an IPaddress or host name.
        public static void Main (string[] args)
        {
            Ping pingSender = new Ping ();
            PingOptions options = new PingOptions ();

            // Use the default Ttl value which is 128,
            // but change the fragmentation behavior.
            options.DontFragment = true;

            // Create a buffer of 32 bytes of data to be transmitted.
            string data = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
            byte[] buffer = Encoding.ASCII.GetBytes (data);
            int timeout = 120;
            PingReply reply = pingSender.Send (args[0], timeout, buffer, options);
            if (reply.Status == IPStatus.Success)
            {
                Console.WriteLine ("Address: {0}", reply.Address.ToString ());
                Console.WriteLine ("RoundTrip time: {0}", reply.RoundtripTime);
                Console.WriteLine ("Time to live: {0}", reply.Options.Ttl);
                Console.WriteLine ("Don't fragment: {0}", reply.Options.DontFragment);
                Console.WriteLine ("Buffer size: {0}", reply.Buffer.Length);
            }
        }
    }
}

open System.Net.NetworkInformation
open System.Text

// args[0] can be an IPaddress or host name.
[<EntryPoint>]
let main args =
    let pingSender = new Ping()

    // Use the default Ttl value which is 128,
    // but change the fragmentation behavior.
    let options = PingOptions()
    options.DontFragment <- true

    // Create a buffer of 32 bytes of data to be transmitted.
    let data = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    let buffer = Encoding.ASCII.GetBytes data
    let timeout = 120
    let reply: PingReply = pingSender.Send(args.[0], timeout, buffer, options)

    match reply.Status with
    | IPStatus.Success ->
        printfn "Address: %O" reply.Address
        printfn "RoundTrip time: %d" reply.RoundtripTime
        printfn "Time to live: %d" reply.Options.Ttl
        printfn "Don't fragment: %b" reply.Options.DontFragment
        printfn "Buffer size: %d" reply.Buffer.Length
        0
    | _ ->
        eprintfn "Error sending ping: %O" reply
        eprintfn "Error was: %O" reply.Status
        1

L’exemple de code suivant illustre l’utilisation asynchrone de la Ping classe.

using System;
using System.Text;
using System.Net;
using System.Net.NetworkInformation;
using System.ComponentModel;
using System.Threading;

namespace Examples.System.Net.NetworkInformation.PingTest
{
    public class PingExample
    {
        public static void Main (string[] args)
        {
            if (args.Length == 0)
                throw new ArgumentException ("Ping needs a host or IP Address.");

            string who = args[0];
            AutoResetEvent waiter = new AutoResetEvent (false);

            Ping pingSender = new Ping ();

            // When the PingCompleted event is raised,
            // the PingCompletedCallback method is called.
            pingSender.PingCompleted += new PingCompletedEventHandler (PingCompletedCallback);

            // Create a buffer of 32 bytes of data to be transmitted.
            string data = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
            byte[] buffer = Encoding.ASCII.GetBytes (data);

            // Wait 12 seconds for a reply.
            int timeout = 12000;

            // Set options for transmission:
            // The data can go through 64 gateways or routers
            // before it is destroyed, and the data packet
            // cannot be fragmented.
            PingOptions options = new PingOptions (64, true);

            Console.WriteLine ("Time to live: {0}", options.Ttl);
            Console.WriteLine ("Don't fragment: {0}", options.DontFragment);

            // Send the ping asynchronously.
            // Use the waiter as the user token.
            // When the callback completes, it can wake up this thread.
            pingSender.SendAsync(who, timeout, buffer, options, waiter);

            // Prevent this example application from ending.
            // A real application should do something useful
            // when possible.
            waiter.WaitOne ();
            Console.WriteLine ("Ping example completed.");
        }

        private static void PingCompletedCallback (object sender, PingCompletedEventArgs e)
        {
            // If the operation was canceled, display a message to the user.
            if (e.Cancelled)
            {
                Console.WriteLine ("Ping canceled.");

                // Let the main thread resume.
                // UserToken is the AutoResetEvent object that the main thread
                // is waiting for.
                ((AutoResetEvent)e.UserState).Set ();
            }

            // If an error occurred, display the exception to the user.
            if (e.Error != null)
            {
                Console.WriteLine ("Ping failed:");
                Console.WriteLine (e.Error.ToString ());

                // Let the main thread resume.
                ((AutoResetEvent)e.UserState).Set();
            }

            PingReply reply = e.Reply;

            DisplayReply (reply);

            // Let the main thread resume.
            ((AutoResetEvent)e.UserState).Set();
        }

        public static void DisplayReply (PingReply reply)
        {
            if (reply == null)
                return;

            Console.WriteLine ("ping status: {0}", reply.Status);
            if (reply.Status == IPStatus.Success)
            {
                Console.WriteLine ("Address: {0}", reply.Address.ToString ());
                Console.WriteLine ("RoundTrip time: {0}", reply.RoundtripTime);
                Console.WriteLine ("Time to live: {0}", reply.Options.Ttl);
                Console.WriteLine ("Don't fragment: {0}", reply.Options.DontFragment);
                Console.WriteLine ("Buffer size: {0}", reply.Buffer.Length);
            }
        }
    }
}

Remarques

Les applications utilisent la Ping classe pour détecter si un ordinateur distant est accessible.

La topologie de réseau peut déterminer si Ping elle peut contacter correctement un hôte distant. La présence et la configuration des proxys, de l’équipement NAT (Network Address Translation) ou des pare-feu peuvent empêcher Ping la réussite. Une réussite Ping indique uniquement que l’hôte distant peut être atteint sur le réseau ; la présence de services de niveau supérieur (par exemple, un serveur web) sur l’hôte distant n’est pas garantie.

Cette classe fournit des fonctionnalités similaires à l’outil en ligne de commande Ping.exe. Les Send méthodes et SendAsync méthodes envoient un message de demande d’écho ICMP (Internet Control Message Protocol) à un ordinateur distant et attendent un message de réponse d’écho ICMP de cet ordinateur. Pour obtenir une description détaillée des messages ICMP, consultez RFC 792, disponible à l’adresse https://www.ietf.org.

Les types suivants sont utilisés avec la Ping classe et sont décrits en détail ci-dessous.

Nom du type	Description
IPStatus	Définit les codes d’état qui décrivent le résultat d’un message de demande d’écho ICMP.
PingOptions	Vous permet de configurer ou de récupérer les paramètres qui contrôlent le nombre de fois où le paquet de requête peut être transféré (Ttl), et s’il peut être fragmenté (DontFragment ).
PingReply	Contient les résultats d’une demande d’écho ICMP.
PingException	Levée si une erreur irrécupérable se produit.
PingCompletedEventArgs	Contient les données associées aux PingCompleted événements, qui sont déclenchées lorsqu’un SendAsync appel se termine ou est annulé.
PingCompletedEventHandler	Délégué qui fournit la méthode de rappel appelée lorsqu’un SendAsync appel se termine ou est annulé.

Les Send méthodes et SendAsync retournent la réponse dans un PingReply objet. La PingReply.Status propriété retourne une IPStatus valeur pour indiquer le résultat de la requête.

Lors de l’envoi de la demande, vous devez spécifier l’ordinateur distant. Pour ce faire, fournissez une chaîne de nom d’hôte, une adresse IP au format de chaîne ou un IPAddress objet.

Vous pouvez également spécifier l’un des types d’informations suivants :

• Données pour accompagner la demande. La spécification buffer vous permet d’apprendre le temps nécessaire à un paquet d’une taille particulière pour se déplacer vers et depuis l’hôte distant et l’unité de transmission maximale du chemin d’accès réseau. (Consultez les Send surcharges SendAsync qui prennent un buffer paramètre.)

• Indique si le paquet Echo ICMP peut être fragmenté en transit. (Consultez la DontFragment propriété et les Send surcharges SendAsync qui prennent un options paramètre.)

• Combien de fois les nœuds de routage, tels que les routeurs ou les passerelles, peuvent transférer le paquet avant qu’il atteigne l’ordinateur de destination ou soit ignoré. (Voir Ttl et les SendSendAsync surcharges qui prennent un options paramètre.)

• Délai dans lequel la réponse doit être reçue. (Consultez les Send surcharges SendAsync qui prennent un timeout paramètre.

La Ping classe offre des méthodes synchrones et asynchrones pour l’envoi de la requête. Si votre application doit bloquer en attendant une réponse, utilisez les Send méthodes ; ces méthodes sont synchrones. Si votre application ne doit pas bloquer, utilisez les méthodes asynchrones SendAsync . Un appel à SendAsync exécuter dans son propre thread qui est automatiquement alloué à partir du pool de threads. Une fois l’opération asynchrone terminée, elle déclenche l’événement PingCompleted . Les applications utilisent un PingCompletedEventHandler délégué pour spécifier la méthode appelée pour PingCompleted les événements. Vous devez ajouter un PingCompletedEventHandler délégué à l’événement avant d’appeler SendAsync. La méthode du délégué reçoit un PingCompletedEventArgs objet qui contient un PingReply objet qui décrit le résultat de l’appel SendAsync .

Vous ne pouvez pas utiliser la même instance de la Ping classe pour générer plusieurs requêtes ICMP Echo simultanées. L’appel Send pendant qu’un SendAsync appel est en cours ou l’appel SendAsync plusieurs fois avant que tous les appels précédents n’aient terminé provoque un InvalidOperationException.

Constructeurs

Nom	Description
Ping()	Initialise une nouvelle instance de la classe Ping.

Propriétés

Nom	Description
CanRaiseEvents	Obtient une valeur indiquant si le composant peut déclencher un événement. (Hérité de Component)
Container	Obtient le IContainer fichier qui contient le Component. (Hérité de Component)
DesignMode	Obtient une valeur qui indique si la Component valeur est actuellement en mode création. (Hérité de Component)
Events	Obtient la liste des gestionnaires d’événements qui sont attachés à ce Component. (Hérité de Component)
Site	Obtient ou définit le ISiteComponent. (Hérité de Component)

Méthodes

Nom	Description
Dispose()	Libère toutes les ressources utilisées par le Component. (Hérité de Component)
Dispose(Boolean)	Libère les ressources non managées utilisées par l’objet Ping et supprime éventuellement les ressources managées.
Equals(Object)	Détermine si l’objet spécifié est égal à l’objet actuel. (Hérité de Object)
GetHashCode()	Sert de fonction de hachage par défaut. (Hérité de Object)
GetLifetimeService()	Obsolète. Récupère l’objet de service de durée de vie actuel qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
GetService(Type)	Retourne un objet qui représente un service fourni par le Component ou par son Container. (Hérité de Component)
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
InitializeLifetimeService()	Obsolète. Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
MemberwiseClone(Boolean)	Crée une copie superficielle de l’objet actuel MarshalByRefObject . (Hérité de MarshalByRefObject)
OnPingCompleted(PingCompletedEventArgs)	Déclenche l’événement PingCompleted.
Send(IPAddress, Int32, Byte[], PingOptions)	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de réponse d’écho ICMP correspondant et qui reçoit un message de réponse d’écho ICMP correspondant IPAddress de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération et de contrôler la fragmentation et les valeurs Time-to-Live pour le paquet de message d’écho ICMP.
Send(IPAddress, Int32, Byte[])	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération.
Send(IPAddress, Int32)	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur. Cette méthode vous permet de spécifier une valeur de délai d’attente pour l’opération.
Send(IPAddress, TimeSpan, Byte[], PingOptions)	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur.
Send(IPAddress)	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur.
Send(String, Int32, Byte[], PingOptions)	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération et de contrôler la fragmentation et les valeurs de durée de vie pour le paquet ICMP.
Send(String, Int32, Byte[])	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération.
Send(String, Int32)	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur. Cette méthode vous permet de spécifier une valeur de délai d’attente pour l’opération.
Send(String, TimeSpan, Byte[], PingOptions)	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) à l’ordinateur spécifié et de recevoir un message de réponse d’écho ICMP correspondant de cet ordinateur.
Send(String)	Tente d’envoyer un message d’écho ICMP (Internet Control Message Protocol) à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur.
SendAsync(IPAddress, Int32, Byte[], Object)	Tente de manière asynchrone d’envoyer un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de IPAddressréponse d’écho ICMP correspondant à partir de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération.
SendAsync(IPAddress, Int32, Byte[], PingOptions, Object)	Tente de manière asynchrone d’envoyer un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de IPAddressréponse d’écho ICMP correspondant à partir de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération et de contrôler la fragmentation et les valeurs Time-to-Live pour le paquet de message d’écho ICMP.
SendAsync(IPAddress, Int32, Object)	Tente de manière asynchrone d’envoyer un message d’écho ICMP (Internet Control Message Protocol) à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération.
SendAsync(IPAddress, Object)	Tente de manière asynchrone d’envoyer un message d’écho ICMP (Internet Control Message Protocol) à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur.
SendAsync(String, Int32, Byte[], Object)	Tente de manière asynchrone d’envoyer un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération.
SendAsync(String, Int32, Byte[], PingOptions, Object)	Tente de manière asynchrone d’envoyer un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération et de contrôler la fragmentation et les valeurs de durée de vie pour le paquet ICMP.
SendAsync(String, Int32, Object)	Tente de manière asynchrone d’envoyer un message d’écho ICMP (Internet Control Message Protocol) à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération.
SendAsync(String, Object)	Tente de manière asynchrone d’envoyer un message d’écho ICMP (Internet Control Message Protocol) à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur.
SendAsyncCancel()	Annule toutes les demandes asynchrones en attente pour envoyer un message d’écho ICMP (Internet Control Message Protocol) et reçoit un message de réponse d’écho ICMP correspondant.
SendPingAsync(IPAddress, Int32, Byte[], PingOptions)	Envoie un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur en tant qu’opération asynchrone. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération, une mémoire tampon à utiliser pour l’envoi et la réception, et contrôler la fragmentation et les valeurs de temps à vie pour le paquet de message d’écho ICMP.
SendPingAsync(IPAddress, Int32, Byte[])	Envoyez un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur en tant qu’opération asynchrone. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération et une mémoire tampon à utiliser pour l’envoi et la réception.
SendPingAsync(IPAddress, Int32)	Envoyez un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur en tant qu’opération asynchrone. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération.
SendPingAsync(IPAddress, TimeSpan, Byte[], PingOptions, CancellationToken)	Envoie un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur en tant qu’opération asynchrone. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération, une mémoire tampon à utiliser pour l’envoi et la réception, la fragmentation et les valeurs time-to-Live et a pour CancellationToken le paquet de message d’écho ICMP.
SendPingAsync(IPAddress)	Envoyez un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur qui a le message de réponse d’écho ICMP correspondant IPAddressà partir de cet ordinateur en tant qu’opération asynchrone.
SendPingAsync(String, Int32, Byte[], PingOptions)	Envoie un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur en tant qu’opération asynchrone. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération, une mémoire tampon à utiliser pour l’envoi et la réception, et contrôler la fragmentation et les valeurs de temps à vie pour le paquet de message d’écho ICMP.
SendPingAsync(String, Int32, Byte[])	Envoie un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur en tant qu’opération asynchrone. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération et une mémoire tampon à utiliser pour l’envoi et la réception.
SendPingAsync(String, Int32)	Envoie un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur en tant qu’opération asynchrone. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération.
SendPingAsync(String, TimeSpan, Byte[], PingOptions, CancellationToken)	Envoie un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur en tant qu’opération asynchrone. Cette surcharge vous permet de spécifier une valeur de délai d’attente pour l’opération, une mémoire tampon à utiliser pour l’envoi et la réception, la fragmentation et les valeurs time-to-Live et a pour CancellationToken le paquet de message d’écho ICMP.
SendPingAsync(String)	Envoie un message d’écho ICMP (Internet Control Message Protocol) avec la mémoire tampon de données spécifiée à l’ordinateur spécifié et reçoit un message de réponse d’écho ICMP correspondant de cet ordinateur en tant qu’opération asynchrone.
ToString()	Retourne un String nom contenant le nom du Component, le cas échéant. Cette méthode ne doit pas être remplacée. (Hérité de Component)

Événements

Nom	Description
Disposed	Se produit lorsque le composant est supprimé par un appel à la Dispose() méthode. (Hérité de Component)
PingCompleted	Se produit lorsqu’une opération asynchrone pour envoyer un message d’écho ICMP (Internet Control Message Protocol) et recevoir le message de réponse d’écho ICMP correspondant se termine ou est annulé.

Voir aussi

• Guide pratique pour effectuer un test ping sur un hôte
• Programmation réseau dans le .NET Framework
• Exemples de programmation réseau
• NetworkInformation