com.gemstone.gemfire.internal.shared

Enum TCPSocketOptions

java.lang.Object

java.lang.Enum<TCPSocketOptions>

com.gemstone.gemfire.internal.shared.TCPSocketOptions

All Implemented Interfaces:

Serializable, Comparable<TCPSocketOptions>

public enum TCPSocketOptions
extends Enum<TCPSocketOptions>

Extended TCP socket options to set socket-specific KEEPALIVE settings etc. Passed to NativeCalls API to set these options on the Java Socket using native OS specific calls.

Since:

7.5

Enum Constant Summary

Enum Constants

Enum Constant and Description
OPT_KEEPCNT number of retransmissions to be sent before declaring the other end to be dead
OPT_KEEPIDLE TCP keepalive time between two transmissions on socket in idle condition (in seconds)
OPT_KEEPINTVL TCP keepalive duration between successive transmissions on socket if no reply to packet sent after idle timeout (in seconds)

Method Summary

Modifier and Type	Method and Description
static TCPSocketOptions	valueOf(String name) Returns the enum constant of this type with the specified name.
static TCPSocketOptions[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPT_KEEPIDLE

public static final TCPSocketOptions OPT_KEEPIDLE

TCP keepalive time between two transmissions on socket in idle condition (in seconds)

OPT_KEEPINTVL

public static final TCPSocketOptions OPT_KEEPINTVL

TCP keepalive duration between successive transmissions on socket if no reply to packet sent after idle timeout (in seconds)

OPT_KEEPCNT

public static final TCPSocketOptions OPT_KEEPCNT

number of retransmissions to be sent before declaring the other end to be dead

Method Detail

values

public static TCPSocketOptions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TCPSocketOptions c : TCPSocketOptions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TCPSocketOptions valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null