SocketOptionName 列挙体とは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

SocketOptionName 列挙体

構成オプション名を定義します。

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

Visual Basic (宣言)

Public Enumeration SocketOptionName

Visual Basic (使用法)

Dim instance As SocketOptionName

public enum SocketOptionName

C++

public enum class SocketOptionName

public enum SocketOptionName

JScript

public enum SocketOptionName

メンバ

	メンバ名	説明
	AcceptConnection	ソケットは待機しています。
	AddMembership	IP グループメンバシップを追加します。
	AddSourceMembership	ソースグループを結合します。
	BlockSource	ソースからデータをブロックします。
	Broadcast	ソケットでのブロードキャストメッセージの送信を許可します。
	BsdUrgent	RFC-1222 の定義に従って、緊急データを使用します。このオプションは 1 回だけ設定できます。いったん設定すると、オフにすることはできません。
	ChecksumCoverage	UDP チェックサムカバレッジを設定または取得します。
	Debug	デバッグ情報を記録します。
	DontFragment	IP データグラムを断片化しないようにします。
	DontLinger	接続を維持せずに、ソケットを適切に閉じます。
	DontRoute	インターフェイスアドレスにルーティングしたり、直接パケットを送信したりしません。
	DropMembership	IP グループメンバシップを無効にします。
	DropSourceMembership	ソースグループを無効にします。
	Error	エラーステータスを取得し、クリアします。
	ExclusiveAddressUse	ソケットを排他アクセス用にバインドできるようにします。
	Expedited	RFC-1222 の定義に従って、優先データを使用します。このオプションは 1 回だけ設定できます。いったん設定すると、オフにすることはできません。
	HeaderIncluded	アプリケーションが発信データグラムに IP ヘッダーを提供していることを示します。
	HopLimit	インターネットプロトコル Version 6 (IPv6) パケットのルーターの最大ホップ数を指定します。これは、インターネットプロトコル Version 4 の有効期間 (TTL) と同様です。
	IPOptions	発信データグラムに挿入する IP オプションを指定します。
	IpTimeToLive	IP ヘッダーの Time-to-Live フィールドを設定します。
	KeepAlive	Keep-alive を使用します。
	Linger	未送信のデータが存在する場合は、閉じた後も接続を維持します。
	MaxConnections	サポートされていません。使用すると SocketException がスローされます。
	MulticastInterface	発信マルチキャストパケットのインターフェイスを設定します。
	MulticastLoopback	IP マルチキャストループバック。
	MulticastTimeToLive	IP マルチキャストの有効期間。
	NoChecksum	チェックサムを 0 に設定して UDP データグラムを送信します。
	NoDelay	送信結合用の Nagle アルゴリズムを無効にします。
	OutOfBandInline	通常のデータストリーム内の帯域外データを受信します。
	PacketInformation	受信パケットに関する情報を返します。
	ReceiveBuffer	受信用に予約するソケット単位の合計バッファ領域を指定します。これは最大メッセージサイズまたは TCP ウィンドウのサイズとは関係ありません。
	ReceiveLowWater	Receive 操作の下限値を指定します。
	ReceiveTimeout	タイムアウトを受信します。このオプションは、同期メソッドにだけ適用されます。BeginSend などの非同期メソッドに対しては機能しません。
	ReuseAddress	既に使用されているアドレスにソケットをバインドすることを許可します。
	SendBuffer	送信用に予約するソケット単位の合計バッファ領域を指定します。これは最大メッセージサイズまたは TCP ウィンドウのサイズとは関係ありません。
	SendLowWater	Send 操作の下限値を指定します。
	SendTimeout	タイムアウトを送信します。このオプションは、同期メソッドにだけ適用されます。BeginSend などの非同期メソッドに対しては機能しません。
	Type	ソケットタイプを取得します。
	TypeOfService	IP ヘッダーの Type of Service フィールドを変更します。
	UnblockSource	以前にブロックしたソースのブロックを解除します。
	UpdateAcceptContext	既存のソケットを使用して、受け入れられたソケットのプロパティを更新します。これは、Winsock2 SO_UPDATE_ACCEPT_CONTEXT ソケットオプションを使用することに相当し、コネクション指向のソケットでだけサポートされています。
	UpdateConnectContext	既存のソケットを使用して、接続されたソケットのプロパティを更新します。これは、Winsock2 SO_UPDATE_CONNECT_CONTEXT ソケットオプションを使用することに相当し、コネクション指向のソケットでだけサポートされています。
	UseLoopback	可能な場合はハードウェアをバイパスします。

解説

SocketOptionName 列挙体は、各 Socket 構成オプションの名前を定義します。ソケットは、Socket.SetSocketOption メソッドを使用して構成されます。

Windows Mobile for Pocket PC、Windows Mobile for Smartphone、Windows CE プラットフォームメモ : .NET Compact Framework アプリケーションでは、次のオプションがサポートされていますが、将来使用するために予約されており現在は使用できません。サポートされているオプションは、AcceptConnection、ReceiveLowWater、ReceiveTimeout、SendLowWater、SendTimeout、および Type です。これらのオプションの詳細については、「ソケットプログラミング」を参照してください。

使用例

この列挙体を使用してソケットオプションを設定するコード例を次に示します。

Visual Basic

'Send operations will time-out if confirmation is 
' not received within 1000 milliseconds.
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 1000)

' The socket will linger for 10 seconds after Socket.Close is called.
Dim lingerOption As New
 LingerOption(True, 10)
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption)

// Send operations will time-out if confirmation 
// is not received within 1000 milliseconds.
s.SetSocketOption (SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 1000);

// The socket will linger for 10 seconds after Socket.Close is called.
LingerOption lingerOption = new LingerOption (true,
 10);

s.SetSocketOption (SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption);

C++

// Specifies that send operations will time-out 
// if confirmation is not received within 1000 milliseconds.
s->SetSocketOption( SocketOptionLevel::Socket, SocketOptionName::SendTimeout,
 1000 );

// Specifies that the Socket will linger for 10 seconds after Close
 is called.
LingerOption^ lingerOption = gcnew LingerOption( true,10 );

s->SetSocketOption( SocketOptionLevel::Socket, SocketOptionName::Linger, lingerOption
 );

// Send operations will time-out if confirmation 
// is not received within 1000 milliseconds.
s.SetSocketOption(SocketOptionLevel.Socket, 
    SocketOptionName.SendTimeout, 1000);
// The socket will linger for 10 seconds after Socket.Close is called.
LingerOption lingerOption = new LingerOption(true,
 10);

s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, 
    lingerOption);