Ping クラス

定義

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

public ref class Ping : IDisposable

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

public class Ping : System.ComponentModel.Component

public class Ping : IDisposable

public class Ping : System.ComponentModel.Component, IDisposable

type Ping = class
    inherit Component

type Ping = class
    interface IDisposable

type Ping = class
    inherit Component
    interface IDisposable

Public Class Ping
Inherits Component

Public Class Ping
Implements IDisposable

Public Class Ping
Inherits Component
Implements IDisposable

継承

Object

MarshalByRefObject

Component

Ping

継承

Object

Ping

実装

IDisposable

例

次のコード例では、 Ping クラスを同期的に使用する方法を示します。

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

次のコード例は、 Ping クラスを非同期的に使用する方法を示しています。

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);
            }
        }
    }
}

注釈

アプリケーションは、 Ping クラスを使用して、リモート コンピューターに到達できるかどうかを検出します。

ネットワーク トポロジは、 Ping がリモート ホストに正常に接続できるかどうかを判断できます。 プロキシ、ネットワーク アドレス変換 (NAT) 機器、またはファイアウォールの存在と構成により、 Ping が成功しなくなる可能性があります。 成功した Ping は、ネットワーク上でリモート ホストに到達できることのみを示します。リモート ホスト上に上位レベルのサービス (Web サーバーなど) が存在することは保証されません。

このクラスは、Ping.exe コマンド ライン ツールと同様の機能を提供します。 SendおよびSendAsyncメソッドは、インターネット制御メッセージ プロトコル (ICMP) エコー要求メッセージをリモート コンピューターに送信し、そのコンピューターからの ICMP エコー応答メッセージを待機します。 ICMP メッセージの詳細については、 https://www.ietf.orgで利用可能な RFC 792 を参照してください。

次の型は、 Ping クラスで使用され、以下で詳しく説明します。

SendメソッドとSendAsync メソッドは、PingReply オブジェクトで応答を返します。 PingReply.Status プロパティは、要求の結果を示すIPStatus値を返します。

要求を送信するときは、リモート コンピューターを指定する必要があります。 これを行うには、ホスト名の文字列、文字列形式の IP アドレス、または IPAddress オブジェクトを指定します。

次のいずれかの種類の情報を指定することもできます。

• 要求に付随するデータ。 bufferを指定すると、リモート ホストとの間で送受信される特定のサイズのパケットに必要な時間と、ネットワーク パスの最大伝送単位を学習できます。 (buffer パラメーターを受け取るSendまたはSendAsyncオーバーロードを参照してください)。

• ICMP エコー パケットを転送中にフラグメント化できるかどうか。 (options パラメーターを受け取るDontFragment プロパティとSendまたはSendAsyncオーバーロードを参照してください)。

• ルーティング ノード (ルーターやゲートウェイなど) が宛先コンピューターに到達するか破棄されるまでにパケットを転送できる回数。 (options パラメーターを受け取るTtlおよびSendまたはSendAsyncオーバーロードを参照してください)。

• 応答を受信する必要がある時間制限。 (timeout パラメーターを受け取るSendまたはSendAsyncオーバーロードを参照してください。

Ping クラスは、要求を送信するための同期メソッドと非同期メソッドの両方を提供します。 応答の待機中にアプリケーションがブロックする必要がある場合は、 Send メソッドを使用します。これらのメソッドは同期的です。 アプリケーションでブロックしない場合は、非同期 SendAsync メソッドを使用します。 SendAsyncの呼び出しは、スレッド プールから自動的に割り当てられる独自のスレッドで実行されます。 非同期操作が完了すると、 PingCompleted イベントが発生します。 アプリケーションでは、 PingCompletedEventHandler デリゲートを使用して、 PingCompleted イベントに対して呼び出されるメソッドを指定します。 SendAsyncを呼び出す前に、PingCompletedEventHandler デリゲートをイベントに追加する必要があります。 デリゲートのメソッドは、SendAsync呼び出しの結果を記述するPingReply オブジェクトを含むPingCompletedEventArgs オブジェクトを受け取ります。

Ping クラスの同じインスタンスを使用して、複数の同時 ICMP エコー要求を生成することはできません。 SendAsync呼び出しの進行中にSendを呼び出すか、以前のすべての呼び出しが完了する前にSendAsyncを複数回呼び出すと、InvalidOperationExceptionが発生します。

こちらもご覧ください

• 方法: ホストに ping を実行する
• .NET Framework でのネットワーク プログラミング
• ネットワーク プログラミングのサンプル
• NetworkInformation