LingerOption

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

LingerOption クラス

Close を呼び出した後で Socket の接続を維持するかどうかを指定します。また、送信するデータが残っている場合は、接続を維持する時間を指定します。

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

Visual Basic (宣言)

Public Class LingerOption

Visual Basic (使用法)

Dim instance As LingerOption

C#

public class LingerOption

C++

public ref class LingerOption

J#

public class LingerOption

JScript

public class LingerOption

解説

Socket を閉じた後もまだ、発信ネットワーク バッファ内に使用可能なデータがある場合があります。Socket を閉じた後の、未送信データを転送する時間を指定する場合は、LingerOption を作成し、enable パラメータを true に設定し、seconds パラメータを、希望する時間に設定します。seconds パラメータは、Socket の接続を維持する時間を示します。この時間が経過するとタイムアウトが発生します。Socket を閉じることによって接続を切断する場合は、LingerOption を作成するときに、enable パラメータを true に設定し、seconds パラメータを 0 に設定します。この場合、Socket はすぐに閉じられ、未送信のデータは失われます。LingerOption を作成したら、Socket.SetSocketOption メソッドに渡します。TcpClient とデータの送受信を行っている場合は、LingerOption を TcpClient.LingerState メソッドに渡します。

既定では、接続の維持はタイムアウト 0 で有効になっています。そのため、Socket は、発信ネットワーク バッファに残っているデータがなくなるまで保留データを送信しようとします。

使用例

作成済みの Socket に対し、Close メソッドが呼び出されてから 1 秒間接続を維持するように設定する例を次に示します。

Visual Basic

Dim myOpts As New LingerOption(True,
 1)
       
mySocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, _
   myOpts)

C#

LingerOption myOpts = new LingerOption(true
,1);

mySocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, myOpts);

C++

LingerOption^ myOpts = gcnew LingerOption( true,1 );
mySocket->SetSocketOption( SocketOptionLevel::Socket, SocketOptionName::Linger,
 myOpts );

J#

LingerOption myOpts = new LingerOption(true
,1);
mySocket.SetSocketOption(SocketOptionLevel.Socket,
    SocketOptionName.Linger, myOpts);

継承階層

System.Object
  System.Net.Sockets.LingerOption

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
LingerOption メンバ
System.Net.Sockets 名前空間

LingerOption コンストラクタ

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

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

Visual Basic (宣言)

Public Sub New ( _
    enable As Boolean, _
    seconds As Integer _
)

Visual Basic (使用法)

Dim enable As Boolean
Dim seconds As Integer

Dim instance As New LingerOption(enable,
 seconds)

C#

public LingerOption (
    bool enable,
    int seconds
)

C++

public:
LingerOption (
    bool enable, 
    int seconds
)

J#

public LingerOption (
    boolean enable, 
    int seconds
)

JScript

public function LingerOption (
    enable : boolean, 
    seconds : int
)

パラメータ

enable

Socket.Close メソッドが呼び出された後も接続を維持する場合は true。それ以外の場合は false。

seconds

Socket.Close メソッドが呼び出された後、接続を維持する秒数。

解説

Socket を閉じた後もまだ、発信ネットワーク バッファ内に使用可能なデータがある場合があります。enable パラメータを使用して、Socket が close メソッドの呼び出し後も未送信のデータを転送し続けるかどうかを指定します。seconds パラメータは、Socket がタイムアウト前に未送信のデータを転送しようとする時間を示します。enable パラメータを true に設定し、seconds パラメータを 0 に設定すると、Socket は発信ネットワーク バッファに残っているデータがなくなるまでデータを送信しようとします。enable を false に設定した場合は、Socket はすぐに閉じられ、未送信のデータは失われます。

使用例

作成済みの Socket に対し、Close メソッドが呼び出されてから 1 秒間接続を維持するように設定する例を次に示します。

Visual Basic

Dim myOpts As New LingerOption(True,
 1)
       
mySocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, _
   myOpts)

C#

LingerOption myOpts = new LingerOption(true
,1);

mySocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, myOpts);

C++

LingerOption^ myOpts = gcnew LingerOption( true,1 );
mySocket->SetSocketOption( SocketOptionLevel::Socket, SocketOptionName::Linger,
 myOpts );

J#

LingerOption myOpts = new LingerOption(true
,1);
mySocket.SetSocketOption(SocketOptionLevel.Socket,
    SocketOptionName.Linger, myOpts);

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

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

LingerOption プロパティ

パブリック プロパティ

	名前	説明
	LingerTime	送信するデータが残っている場合に、Socket.Close メソッドを呼び出した後で接続を維持する時間を取得または設定します。

参照

関連項目

LingerOption クラス
System.Net.Sockets 名前空間

LingerOption メソッド

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

LingerOption クラス
System.Net.Sockets 名前空間

LingerOption メンバ

Close を呼び出した後で Socket の接続を維持するかどうかを指定します。また、送信するデータが残っている場合は、接続を維持する時間を指定します。

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

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

	名前	説明
	LingerOption	LingerOption クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	LingerTime	送信するデータが残っている場合に、Socket.Close メソッドを呼び出した後で接続を維持する時間を取得または設定します。

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

LingerOption クラス
System.Net.Sockets 名前空間