Package com.zeroc.Ice

Enum Class ConnectionClose

java.lang.Object

java.lang.Enum<ConnectionClose>

com.zeroc.Ice.ConnectionClose

All Implemented Interfaces:

Serializable, Comparable<ConnectionClose>, Constable

public enum ConnectionClose
extends Enum<ConnectionClose>

Determines the behavior when manually closing a connection.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Forcefully	Close the connection immediately without sending a close connection protocol message to the peer and waiting for the peer to acknowledge it.
Gracefully	Close the connection by notifying the peer but do not wait for pending outgoing invocations to complete.
GracefullyWithWait	Wait for all pending invocations to complete before closing the connection.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Forcefully

public static final ConnectionClose Forcefully

Close the connection immediately without sending a close connection protocol message to the peer and waiting for the peer to acknowledge it.

Gracefully

public static final ConnectionClose Gracefully

Close the connection by notifying the peer but do not wait for pending outgoing invocations to complete. On the server side, the connection will not be closed until all incoming invocations have completed.

GracefullyWithWait

public static final ConnectionClose GracefullyWithWait

Wait for all pending invocations to complete before closing the connection.

Method Details

values

public static ConnectionClose[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ConnectionClose valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

value

public int value()

valueOf

public static ConnectionClose valueOf(int v)

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

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null