org.omg.dds.core.policy

Enum Liveliness.Kind

java.lang.Object

java.lang.Enum<Liveliness.Kind>

org.omg.dds.core.policy.Liveliness.Kind

All Implemented Interfaces:

Serializable, Comparable<Liveliness.Kind>

Enclosing interface:

Liveliness

public static enum Liveliness.Kind
extends Enum<Liveliness.Kind>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOMATIC The infrastructure will automatically signal liveliness for the DataWriters at least as often as required by the leaseDuration.
MANUAL_BY_PARTICIPANT The user application takes responsibility to signal liveliness to the Service.
MANUAL_BY_TOPIC The user application takes responsibility to signal liveliness to the Service.

Method Summary

Methods

Modifier and Type	Method and Description
static Liveliness.Kind	valueOf(String name) Returns the enum constant of this type with the specified name.
static Liveliness.Kind[]	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

AUTOMATIC

public static final Liveliness.Kind AUTOMATIC

The infrastructure will automatically signal liveliness for the DataWriters at least as often as required by the leaseDuration.

MANUAL_BY_PARTICIPANT

public static final Liveliness.Kind MANUAL_BY_PARTICIPANT

The user application takes responsibility to signal liveliness to the Service. Liveliness must be asserted at least once every leaseDuration otherwise the Service will assume the corresponding Entity is no longer "active/alive." The Service will assume that as long as at least one Entity within the DomainParticipant has asserted its liveliness the other Entities in that same DomainParticipant are also alive.

MANUAL_BY_TOPIC

public static final Liveliness.Kind MANUAL_BY_TOPIC

The user application takes responsibility to signal liveliness to the Service. Liveliness must be asserted at least once every leaseDuration otherwise the Service will assume the corresponding Entity is no longer "active/alive." The Service will only assume liveliness of the DataWriter if the application has asserted liveliness of that DataWriter itself.

Method Detail

values

public static Liveliness.Kind[] 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 (Liveliness.Kind c : Liveliness.Kind.values())
    System.out.println(c);

Returns:

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

valueOf

public static Liveliness.Kind 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