RemoteParticipantPurgeKind Class Reference

Available behaviors for halting communication with remote participants (and their contained entities) with which discovery communication has been lost. More...

Inheritance diagram for RemoteParticipantPurgeKind:

Static Public Attributes
static final RemoteParticipantPurgeKind	LIVELINESS_BASED_REMOTE_PARTICIPANT_PURGE
	[default] Maintain knowledge of the remote participant for as long as it maintains its liveliness contract.
static final RemoteParticipantPurgeKind	NO_REMOTE_PARTICIPANT_PURGE
	Never "forget" a remote participant with which discovery communication has been lost.

Additional Inherited Members
Public Member Functions inherited from Enum
final int	ordinal ()
	The integral value of this enumerated constant.
Object	copy_from (Object src)
final String	name ()
	The name of this enum constant, as declared in the enum declaration.
final String	toString ()
	The string value of this enum constant.
Protected Member Functions inherited from Enum
	Enum (String name, int ordinal)
	The constructor.

Detailed Description

Available behaviors for halting communication with remote participants (and their contained entities) with which discovery communication has been lost.

When discovery communication with a remote participant has been lost, the local participant must make a decision about whether to continue attempting to communicate with that participant and its contained entities. This "kind" is used to select the desired behavior.

This "kind" does not pertain to the situation in which a remote participant has been gracefully deleted and notification of that deletion have been successfully received by its peers. In that case, the local participant will immediately stop attempting to communicate with those entities and will remove the associated remote entity records from its internal database.

See Also

com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.remote_participant_purge_kind

Member Data Documentation

final RemoteParticipantPurgeKind LIVELINESS_BASED_REMOTE_PARTICIPANT_PURGE

static

Initial value:

= new RemoteParticipantPurgeKind(
                "LIVELINESS_BASED_REMOTE_PARTICIPANT_PURGE", 0)

[default] Maintain knowledge of the remote participant for as long as it maintains its liveliness contract.

A participant will continue attempting communication with its peers, even if discovery communication with them is lost, as long as the remote participants maintain their liveliness. If both discovery communication and participant liveliness are lost, however, the local participant will remove all records of the remote participant and its contained endpoints, and no further data communication with them will occur until and unless they are rediscovered.

The liveliness contract a participant promises to its peers – its "liveliness lease duration" – is specified in its com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.participant_liveliness_lease_duration QoS field. It maintains that contract by writing data to those other participants with a writer that has a com.rti.dds.infrastructure.LivelinessQosPolicyKind of com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.AUTOMATIC_LIVELINESS_QOS or com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANUAL_BY_PARTICIPANT_LIVELINESS_QOS and by asserting itself (at the com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.participant_liveliness_assert_period) over the Simple Discovery Protocol.

final RemoteParticipantPurgeKind NO_REMOTE_PARTICIPANT_PURGE

static

Initial value:

= new RemoteParticipantPurgeKind(
                "NO_REMOTE_PARTICIPANT_PURGE", 1)

Never "forget" a remote participant with which discovery communication has been lost.

If a participant with this behavior loses discovery communication with a remote participant, it will nevertheless remember that remote participant and its endpoints and continue attempting to communicate with them indefinitely.

This value has consequences for a participant's resource usage. If discovery communication with a remote participant is lost, but the same participant is later rediscovered, any relevant records that remain in the database will be reused. However, if it is not rediscovered, the records will continue to take up space in the database for as long as the local participant remains in existence.