Socket.SetSocketOption メソッド

ソース:

Socket.cs

ソース:

Socket.cs

ソース:

Socket.cs

public:
 void SetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, bool optionValue);

public void SetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, bool optionValue);

member this.SetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * bool -> unit

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

パラメーター

例外

例

次のコード例では、ソケットを開き、 DontLinger と ソケット オプションを OutOfBandInline 有効にします。

// Establish the local endpoint for the socket.
IPHostEntry^ ipHost = Dns::GetHostEntry( Dns::GetHostName() );
IPAddress^ ipAddr = ipHost->AddressList[ 0 ];
IPEndPoint^ ipEndPoint = gcnew IPEndPoint( ipAddr,11000 );

// Create a TCP socket.
Socket^ client = gcnew 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 );

// Establish the local endpoint for the socket.
IPHostEntry ipHost = Dns.GetHostEntry(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);

注釈

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

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 参照してください。

ソース:

Socket.cs

ソース:

Socket.cs

ソース:

Socket.cs

public:
 void SetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, cli::array <System::Byte> ^ optionValue);

public void SetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, byte[] optionValue);

member this.SetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * byte[] -> unit

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

パラメーター

例外

例

次のコード例では、 LingerOption と Send のタイムアウト値を設定します。

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

// The socket will linger for 10 seconds after Socket.Close is called.
var lingerOption = new LingerOption(true, 10);
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption);

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

注釈

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

こちらもご覧ください

• SocketOptionName
• SocketOptionLevel
• GetSocketOption(SocketOptionLevel, SocketOptionName)

ソース:

Socket.cs

ソース:

Socket.cs

ソース:

Socket.cs

public:
 void SetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, int optionValue);

public void SetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, int optionValue);

member this.SetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * int -> unit

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

パラメーター

例外

例

次のコード例では、 LingerOption と Send のタイムアウト値を設定します。

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

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

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

注釈

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

このオーバーロードを使用して設定できるさまざまな Socket オプションを次に示します。 これらのオプションは、適切な SocketOptionLevelによってグループ化されます。 これらのオプションのいずれかを設定する場合は、 パラメーターに適切な SocketOptionLeveloptionLevel を使用してください。 設定するオプションは、 パラメーターで指定する 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 参照してください。

こちらもご覧ください

• SocketOptionName
• SocketOptionLevel
• GetSocketOption(SocketOptionLevel, SocketOptionName)

ソース:

Socket.cs

ソース:

Socket.cs

ソース:

Socket.cs

public:
 void SetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, System::Object ^ optionValue);

public void SetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, object optionValue);

member this.SetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * obj -> unit

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

パラメーター

例外

例

次のコード例では、 と Send のタイムアウト値をLingerOption設定します。

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

// The socket will linger for 10 seconds after Socket.Close is called.
var lingerOption = new LingerOption(true, 10);
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption);

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

注釈

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

こちらもご覧ください

• SocketOptionName
• SocketOptionLevel
• GetSocketOption(SocketOptionLevel, SocketOptionName)