Class ParticipantProxyData
Defined in File ParticipantProxyData.h
Class Documentation
-
class ParticipantProxyData
ParticipantProxyData class is used to store and convert the information Participants send to each other during the PDP phase.
Public Functions
-
RTPS_DllAPI ParticipantProxyData(const RTPSParticipantAllocationAttributes &allocation)
-
RTPS_DllAPI ParticipantProxyData(const ParticipantProxyData &pdata)
-
virtual RTPS_DllAPI ~ParticipantProxyData()
- RTPS_DllAPI bool updateData (ParticipantProxyData &pdata)
Update the data.
- Parameters:
pdata – Object to copy the data from
- Returns:
True on success
- RTPS_DllAPI uint32_t get_serialized_size (bool include_encapsulation) const
Get the size in bytes of the CDR serialization of this object.
- Parameters:
include_encapsulation – Whether to include the size of the encapsulation info.
- Returns:
size in bytes of the CDR serialization.
- RTPS_DllAPI bool writeToCDRMessage (CDRMessage_t *msg, bool write_encapsulation)
Write as a parameter list on a CDRMessage_t
- Returns:
True on success
- RTPS_DllAPI bool readFromCDRMessage (CDRMessage_t *msg, bool use_encapsulation, const NetworkFactory &network, bool is_shm_transport_available, bool should_filter_locators, fastdds::rtps::VendorId_t source_vendor_id=c_VendorId_eProsima)
Read the parameter list from a received CDRMessage_t
- Returns:
True on success
- RTPS_DllAPI void clear ()
Clear the data (restore to default state).
- RTPS_DllAPI void copy (const ParticipantProxyData &pdata)
Copy the data from another object.
- Parameters:
pdata – Object to copy the data from
- RTPS_DllAPI void set_persistence_guid (const GUID_t &guid)
Set participant persistent GUID_t
- Parameters:
guid – valid GUID_t
- RTPS_DllAPI GUID_t get_persistence_guid () const
Retrieve participant persistent GUID_t
- Returns:
guid persistent GUID_t or c_Guid_Unknown
- RTPS_DllAPI void set_sample_identity (const SampleIdentity &sid)
Set participant client server sample identity
- Parameters:
sid – valid SampleIdentity
- RTPS_DllAPI SampleIdentity get_sample_identity () const
Retrieve participant SampleIdentity
- Returns:
- RTPS_DllAPI void set_backup_stamp (const GUID_t &guid)
Identifies the participant as client of the given server
- Parameters:
guid – valid backup server GUID
- RTPS_DllAPI GUID_t get_backup_stamp () const
Retrieves BACKUP server stamp. On deserialization hints if lease duration must be enforced
- Returns:
GUID
- RTPS_DllAPI void assert_liveliness ()
- inline RTPS_DllAPI const std::chrono::steady_clock::time_point & last_received_message_tm () const
- inline RTPS_DllAPI const std::chrono::microseconds & lease_duration () const
Public Members
-
ProtocolVersion_t m_protocolVersion
Protocol version.
-
fastdds::rtps::VendorId_t m_VendorId
Vendor ID.
-
bool m_expectsInlineQos
Expects Inline QOS.
-
BuiltinEndpointSet_t m_availableBuiltinEndpoints
Available builtin endpoints.
-
NetworkConfigSet_t m_networkConfiguration
Network configuration.
-
RemoteLocatorList metatraffic_locators
Metatraffic locators.
-
RemoteLocatorList default_locators
Default locators.
-
string_255 m_participantName
Participant name.
-
InstanceHandle_t m_key
-
Duration_t m_leaseDuration
-
bool isAlive
-
ParameterPropertyList_t m_properties
-
UserDataQosPolicy m_userData
-
TimedEvent *lease_duration_event
-
bool should_check_lease_duration
-
ProxyHashTable<ReaderProxyData> *m_readers = nullptr
-
ProxyHashTable<WriterProxyData> *m_writers = nullptr
-
SampleIdentity m_sample_identity
-
RTPS_DllAPI ParticipantProxyData(const RTPSParticipantAllocationAttributes &allocation)