ISocketOptions.SetOption(Int32, Object) Method

Reference

Definition

Namespace:: Java.Net

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Enable/disable the option specified by optID.

[Android.Runtime.Register("setOption", "(ILjava/lang/Object;)V", "GetSetOption_ILjava_lang_Object_Handler:Java.Net.ISocketOptionsInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public void SetOption (int optID, Java.Lang.Object? value);

[<Android.Runtime.Register("setOption", "(ILjava/lang/Object;)V", "GetSetOption_ILjava_lang_Object_Handler:Java.Net.ISocketOptionsInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member SetOption : int * Java.Lang.Object -> unit

Parameters

optID: Int32

identifies the option

value: Object

the parameter of the socket option

Attributes: RegisterAttribute

Exceptions

SocketException

if an error occurs setting the option value.

Remarks

Enable/disable the option specified by optID. If the option is to be enabled, and it takes an option-specific "value", this is passed in value. The actual type of value is option-specific, and it is an error to pass something that isn't of the expected type:

SocketImpl s;
            ...
            s.setOption(SO_LINGER, new Integer(10));
               // OK - set SO_LINGER w/ timeout of 10 sec.
            s.setOption(SO_LINGER, new Double(10));
               // ERROR - expects java.lang.Integer

If the requested option is binary, it can be set using this method by a java.lang.Boolean:

s.setOption(TCP_NODELAY, Boolean.TRUE);
               // OK - enables TCP_NODELAY, a binary option

Any option can be disabled using this method with a Boolean.FALSE:

s.setOption(TCP_NODELAY, Boolean.FALSE);
               // OK - disables TCP_NODELAY
            s.setOption(SO_LINGER, Boolean.FALSE);
               // OK - disables SO_LINGER

For an option that has a notion of on and off, and requires a non-boolean parameter, setting its value to anything other than Boolean.FALSE implicitly enables it. Throws SocketException if the option is unrecognized, the socket is closed, or some low-level error occurred

Java documentation for java.net.SocketOptions.setOption(int, java.lang.Object).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to