Socket.SetSocketOption メソッドとは何？わかりやすく解説 Weblio辞書

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

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

Socket.SetSocketOption メソッド (SocketOptionLevel, SocketOptionName, Int32)

指定した Socket オプションを、指定した値に設定します。

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

Visual Basic (宣言)

Public Sub SetSocketOption ( _
    optionLevel As SocketOptionLevel, _
    optionName As SocketOptionName, _
    optionValue As Integer _
)

Visual Basic (使用法)

Dim instance As Socket
Dim optionLevel As SocketOptionLevel
Dim optionName As SocketOptionName
Dim optionValue As Integer

instance.SetSocketOption(optionLevel, optionName, optionValue)

public void SetSocketOption (
    SocketOptionLevel optionLevel,
    SocketOptionName optionName,
    int optionValue
)

C++

public:
void SetSocketOption (
    SocketOptionLevel optionLevel, 
    SocketOptionName optionName, 
    int optionValue
)

public void SetSocketOption (
    SocketOptionLevel optionLevel, 
    SocketOptionName optionName, 
    int optionValue
)

JScript

public function SetSocketOption (
    optionLevel : SocketOptionLevel, 
    optionName : SocketOptionName, 
    optionValue : int
)

パラメータ

optionLevel: SocketOptionLevel 値の 1 つ。

optionName: SocketOptionName 値の 1 つ。

optionValue: オプションの値。

例外

例外の種類	条件
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。

解説

Socket オプションは、現在の Socket の動作を決定します。Boolean データ型のオプションの場合は、0 以外の値を指定するとオプションが有効になり、0 を指定するとオプションが無効になります。整数型のオプションの場合は、適切な値を指定します。Socket オプションはプロトコルサポートのレベルによってグループ化されています。

このオーバーロードを使用して設定できるさまざまな Socket オプションを次に示します。これらのオプションは適切な SocketOptionLevel によってグループ化されます。これらのオプションのいずれかを設定する場合、適切な SocketOptionLevel を optionLevel パラメータに使用してください。設定するオプションは、optionName パラメータで指定する必要があります。これらのオプションの現在の値を取得するには、GetSocketOption メソッドを使用します。

このオーバーロードを使用して設定できる SocketOptionLevel.Socket オプション。

Broadcast
DontLinger
Debug
Error
KeepAlive
OutOfBandInline
ReceiveBuffer
ReceiveTimeout
ReuseAddress
SendBuffer
SendTimeout
Type

このオーバーロードを使用して設定できる SocketOptionLevel.IP オプション。

HeaderIncluded
IPOptions
IpTimeToLive
MulticastInterface
MulticastLoopback
MulticastTimeToLive
TypeOfService
UseLoopback

このオーバーロードを使用して設定できる SocketOptionLevel.Tcp オプション。

BsdUrgent
Expedited
NoDelay

このオーバーロードを使用して設定できる SocketOptionLevel.Udp オプション。

ChecksumCoverage
NoChecksum

このオーバーロードを使用して設定できる SocketOptionLevel.IPv6 オプション。

HopLimit

これらのオプションの詳細については、SocketOptionName 列挙体のトピックを参照してください。

メモ
SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラーコードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラーコードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ
このメンバは、アプリケーションでネットワークトレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

Windows 98, Windows NT 4.0 プラットフォームメモ : optionName パラメータとして AddMembership を使用する前に、Bind メソッドを呼び出す必要があります。

使用例

LingerOption タイムアウト値と Send タイムアウト値を設定するコード例を次に示します。

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

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間
SocketOptionName
SocketOptionLevel
GetSocketOption

Socket.SetSocketOption メソッド (SocketOptionLevel, SocketOptionName, Boolean)

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

指定した Socket オプションを、指定した Boolean 値に設定します。

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

Visual Basic (宣言)

Public Sub SetSocketOption ( _
    optionLevel As SocketOptionLevel, _
    optionName As SocketOptionName, _
    optionValue As Boolean _
)

Visual Basic (使用法)

Dim instance As Socket
Dim optionLevel As SocketOptionLevel
Dim optionName As SocketOptionName
Dim optionValue As Boolean

instance.SetSocketOption(optionLevel, optionName, optionValue)

public void SetSocketOption (
    SocketOptionLevel optionLevel,
    SocketOptionName optionName,
    bool optionValue
)

C++

public:
void SetSocketOption (
    SocketOptionLevel optionLevel, 
    SocketOptionName optionName, 
    bool optionValue
)

public void SetSocketOption (
    SocketOptionLevel optionLevel, 
    SocketOptionName optionName, 
    boolean optionValue
)

JScript

public function SetSocketOption (
    optionLevel : SocketOptionLevel, 
    optionName : SocketOptionName, 
    optionValue : boolean
)

パラメータ

optionLevel: SocketOptionLevel 値の 1 つ。

optionName: SocketOptionName 値の 1 つ。

optionValue: Boolean として表されるオプションの値。

例外

例外の種類	条件
ObjectDisposedException	Socket オブジェクトは閉じられています。
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。

解説

Socket オプションは、現在の Socket の動作を決定します。optionValue を true に設定してオプションを有効にするか、false に設定してオプションを無効にします。

Socket オプションは、プロトコルサポートのレベルによってグループ化されます。

このオーバーロードを使用して設定できるさまざまな Socket オプションを次に示します。これらのオプションは適切な SocketOptionLevel 値によってグループ化されます。これらのオプションのいずれかを設定する場合、適切な SocketOptionLevel 値を optionLevel パラメータに使用してください。設定するオプションは、optionName パラメータで指定する必要があります。これらのオプションの現在の値を取得するには、GetSocketOption メソッドを使用します。

このオーバーロードを使用して設定できる SocketOptionLevel.Socket オプション。

AcceptConnection
Broadcast
DontLinger
Debug
KeepAlive
OutOfBandInline
ReuseAddress

このオーバーロードを使用して設定できる SocketOptionLevel.IP オプション。

HeaderIncluded
MulticastLoopback
UseLoopback

このオーバーロードを使用して設定できる SocketOptionLevel.Tcp オプション。

BsdUrgent
Expedited
NoDelay

このオーバーロードを使用して設定できる SocketOptionLevel.Udp オプション。

NoChecksum

これらのオプションの詳細については、SocketOptionName 列挙体のトピックを参照してください。

メモ
SocketException 例外が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラーコードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラーコードのマニュアルからエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

使用例

ソケットを開いて、DontLinger ソケットオプションと OutOfBandInline ソケットオプションを有効にするコード例を次に示します。

// Establish the local endpoint for the socket.
IPHostEntry ipHost = Dns.Resolve(Dns.GetHostName());
IPAddress  ipAddr = ipHost.AddressList[0];
IPEndPoint ipEndPoint = new IPEndPoint(ipAddr, 11000);

// Create a TCP socket.
Socket client = new Socket(AddressFamily.InterNetwork,
    SocketType.Stream, ProtocolType.Tcp);

// Connect the socket to the remote endpoint.
client.Connect(ipEndPoint);

// Set option that allows socket to close gracefully without lingering.
client.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.DontLinger, true);

// Set option that allows socket to receive out-of-band information
 in the data stream.
client.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.OutOfBandInline,
 true);

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

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

Socket.SetSocketOption メソッド (SocketOptionLevel, SocketOptionName, Object)

指定した Socket オプションを、指定した値に設定します。この値はオブジェクトで表されます。

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

Visual Basic (宣言)

Public Sub SetSocketOption ( _
    optionLevel As SocketOptionLevel, _
    optionName As SocketOptionName, _
    optionValue As Object _
)

Visual Basic (使用法)

Dim instance As Socket
Dim optionLevel As SocketOptionLevel
Dim optionName As SocketOptionName
Dim optionValue As Object

instance.SetSocketOption(optionLevel, optionName, optionValue)

public void SetSocketOption (
    SocketOptionLevel optionLevel,
    SocketOptionName optionName,
    Object optionValue
)

C++

public:
void SetSocketOption (
    SocketOptionLevel optionLevel, 
    SocketOptionName optionName, 
    Object^ optionValue
)

public void SetSocketOption (
    SocketOptionLevel optionLevel, 
    SocketOptionName optionName, 
    Object optionValue
)

JScript

public function SetSocketOption (
    optionLevel : SocketOptionLevel, 
    optionName : SocketOptionName, 
    optionValue : Object
)

パラメータ

optionLevel: SocketOptionLevel 値の 1 つ。

optionName: SocketOptionName 値の 1 つ。

optionValue: オプションの値を格納する LingerOption または MulticastOption。

例外

例外の種類	条件
ArgumentNullException	optionValue が null 参照 (Visual Basic では Nothing) です。
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。

解説

Socket オプションは、現在の Socket の動作を決定します。このオーバーロードを使用して、Linger オプション、AddMembership オプション、および DropMembershipSocket オプションを設定します。Linger オプションの場合は、optionLevel パラメータで Socket を使用します。AddMembership オプションおよび DropMembership オプションについては、IP を使用します。上記のオプションの現在の値を取得するには、GetSocketOption メソッドを使用します。

メモ
SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラーコードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラーコードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

Windows 98, Windows NT 4.0 プラットフォームメモ : optionName パラメータとして AddMembership を使用する前に、Bind メソッドを呼び出す必要があります。

使用例

LingerOption タイムアウト値と Send タイムアウト値を設定するコード例を次に示します。

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

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間
SocketOptionName
SocketOptionLevel
GetSocketOption

Socket.SetSocketOption メソッド

Socket オプションを設定します。
オーバーロードの一覧

名前	説明
Socket.SetSocketOption (SocketOptionLevel, SocketOptionName, Boolean)	指定した Socket オプションを、指定した Boolean 値に設定します。
Socket.SetSocketOption (SocketOptionLevel, SocketOptionName, Byte[])	指定した Socket オプションを、指定した値に設定します。この値はバイト配列で表されます。 .NET Compact Framework によってサポートされています。
Socket.SetSocketOption (SocketOptionLevel, SocketOptionName, Int32)	指定した Socket オプションを、指定した値に設定します。 .NET Compact Framework によってサポートされています。
Socket.SetSocketOption (SocketOptionLevel, SocketOptionName, Object)	指定した Socket オプションを、指定した値に設定します。この値はオブジェクトで表されます。 .NET Compact Framework によってサポートされています。

参照

Socket.SetSocketOption メソッド (SocketOptionLevel, SocketOptionName, Byte[])

指定した Socket オプションを、指定した値に設定します。この値はバイト配列で表されます。

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

Visual Basic (宣言)

Public Sub SetSocketOption ( _
    optionLevel As SocketOptionLevel, _
    optionName As SocketOptionName, _
    optionValue As Byte() _
)

Visual Basic (使用法)

Dim instance As Socket
Dim optionLevel As SocketOptionLevel
Dim optionName As SocketOptionName
Dim optionValue As Byte()

instance.SetSocketOption(optionLevel, optionName, optionValue)

public void SetSocketOption (
    SocketOptionLevel optionLevel,
    SocketOptionName optionName,
    byte[] optionValue
)

C++

public:
void SetSocketOption (
    SocketOptionLevel optionLevel, 
    SocketOptionName optionName, 
    array<unsigned char>^ optionValue
)

public void SetSocketOption (
    SocketOptionLevel optionLevel, 
    SocketOptionName optionName, 
    byte[] optionValue
)

JScript

public function SetSocketOption (
    optionLevel : SocketOptionLevel, 
    optionName : SocketOptionName, 
    optionValue : byte[]
)

パラメータ

optionLevel: SocketOptionLevel 値の 1 つ。

optionName: SocketOptionName 値の 1 つ。

optionValue: オプションの値を表す Byte 型の配列。

例外

例外の種類	条件
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。

解説

Socket オプションは、現在の Socket の動作を決定します。このオーバーロードを使用して、オプション値としてバイト配列を必要とする Socket オプションを設定します。

メモ
SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラーコードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラーコードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ
このメンバは、アプリケーションでネットワークトレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

Windows 98, Windows NT 4.0 プラットフォームメモ : optionName パラメータとして AddMembership を使用する前に、Bind メソッドを呼び出す必要があります。

使用例

LingerOption タイムアウト値と Send タイムアウト値を設定するコード例を次に示します。

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