PingOptions

.NET Framework クラス ライブラリ リファレンス

PingOptions クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

Ping データ パケットの送信方法を制御するために使用します。

名前空間: System.Net.NetworkInformation
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Class PingOptions

Visual Basic (使用法)

Dim instance As PingOptions

C#

public class PingOptions

C++

public ref class PingOptions

J#

public class PingOptions

JScript

public class PingOptions

解説

PingOptions クラスには、インターネット コントロール メッセージ プロトコル (ICMP: Internet Control Message Protocol) のエコー要求パケットの送信方法を制御するための、Ttl プロパティと DontFragment プロパティが用意されています。

Ttl プロパティは、Ping クラスによって送信されるパケットの有効期間 (TTL: Time to Live) を指定します。この値は、Ping パケットが破棄される前に、そのパケットを転送できるルーティング ノードの数を示しています。このオプションを設定すると、送信元コンピュータから送信先コンピュータにパケットを送信するために必要となる転送の回数 (ホップ) のテストに役立ちます。

DontFragment プロパティは、リモート ホストに送信するデータを複数のパケットに分割できるかどうかを制御します。このオプションは、パケットの送信に使用するルーターやゲートウェイの MTU (Maximum Transmission Unit) のテストに役立ちます。

PingOptions クラスのインスタンスは、Send メソッドおよび SendAsync メソッドに渡されます。また、PingReply クラスは、Options プロパティを通じて PingOptions のインスタンスを返します。

PingOptions のインスタンスの初期プロパティ値の一覧については、PingOptions コンストラクタのトピックを参照してください。

使用例

Ping、PingOptions、および PingReply の各クラスを使用して、コマンド ラインで指定したホストに ICMP エコー要求を送信するコード例を次に示します。

C#

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

継承階層

System.Object
  System.Net.NetworkInformation.PingOptions

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
PingOptions メンバ
System.Net.NetworkInformation 名前空間

PingOptions コンストラクタ ()

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

PingOptions クラスの新しいインスタンスを初期化します。

名前空間: System.Net.NetworkInformation
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New PingOptions

C#

public PingOptions ()

C++

public:
PingOptions ()

J#

public PingOptions ()

JScript

public function PingOptions ()

解説

PingOptions のインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
Ttl	128
DontFragment	false

Send または SendAsync を呼び出す前に、プロパティに新しい値を設定できます。

使用例

このコンストラクタを実際に呼び出すコード例を次に示します。

C#

Ping pingSender = new Ping ();
PingOptions options = new PingOptions ();

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
PingOptions クラス
PingOptions メンバ
System.Net.NetworkInformation 名前空間

PingOptions コンストラクタ

PingOptions クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
PingOptions ()	PingOptions クラスの新しいインスタンスを初期化します。
PingOptions (Int32, Boolean)	PingOptions クラスの新しいインスタンスを初期化し、有効期間 (TTL) とフラグメンテーションの値を設定します。

参照

関連項目

PingOptions クラス
PingOptions メンバ
System.Net.NetworkInformation 名前空間

PingOptions コンストラクタ (Int32, Boolean)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

PingOptions クラスの新しいインスタンスを初期化し、有効期間 (TTL) とフラグメンテーションの値を設定します。

名前空間: System.Net.NetworkInformation
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    ttl As Integer, _
    dontFragment As Boolean _
)

Visual Basic (使用法)

Dim ttl As Integer
Dim dontFragment As Boolean

Dim instance As New PingOptions(ttl,
 dontFragment)

C#

public PingOptions (
    int ttl,
    bool dontFragment
)

C++

public:
PingOptions (
    int ttl, 
    bool dontFragment
)

J#

public PingOptions (
    int ttl, 
    boolean dontFragment
)

JScript

public function PingOptions (
    ttl : int, 
    dontFragment : boolean
)

パラメータ

ttl

Ping データ パケットを転送できる回数を指定する 1 以上の Int32 値。

dontFragment

リモート ホストに送信するデータが断片化されないようにするには true。それ以外の場合は false。

例外

例外の種類	条件
ArgumentOutOfRangeException	ttl が 0 以下です。

解説

ttl パラメータは、データを転送できるルーターやゲートウェイの数を制限します。これは、ローカル コンピュータとリモート コンピュータの間のルートの長さのテストに役立ちます。dontFragment パラメータによって、パケットの送信に使用するルーターやゲートウェイの MTU (Maximum Transmission Unit) をテストできます。

使用例

このコンストラクタを呼び出し、新しいインスタンスのプロパティ値を表示するコード例を次に示します。

C#

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
PingOptions クラス
PingOptions メンバ
System.Net.NetworkInformation 名前空間

PingOptions プロパティ

パブリック プロパティ

	名前	説明
	DontFragment	リモート ホストに送信するデータのフラグメンテーションを制御する Boolean 値を取得または設定します。
	Ttl	Ping データが破棄される前に、そのデータを転送できるルーティング ノードの数を取得または設定します。

参照

関連項目

PingOptions クラス
System.Net.NetworkInformation 名前空間

PingOptions メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

PingOptions クラス
System.Net.NetworkInformation 名前空間

PingOptions メンバ

Ping データ パケットの送信方法を制御するために使用します。

PingOptions データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	PingOptions	オーバーロードされます。 PingOptions クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	DontFragment	リモート ホストに送信するデータのフラグメンテーションを制御する Boolean 値を取得または設定します。
	Ttl	Ping データが破棄される前に、そのデータを転送できるルーティング ノードの数を取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

PingOptions クラス
System.Net.NetworkInformation 名前空間