internal¶

As the name suggests, the functionality in this module is meant for internal package use only.

class cyclonedds.internal.DDS(reference)[source]¶

Common class for all DDS related classes. This class enables the c_call magic.

Parameters: reference (int) –
Return type: None

class cyclonedds.internal.SampleInfo[source]¶

Contains information about the associated data value

Parameters

sample_state (int) –
view_state (int) –
instance_state (int) –
valid_data (bool) –
source_timestamp (int) –
instance_handle (int) –
publication_handle (int) –
disposed_generation_count (int) –
no_writers_generation_count (int) –
sample_rank (int) –
generation_rank (int) –
absolute_generation_rank (int) –

Return type

None

sample_state¶

Possible values: SampleState

Type: int

view_state¶

Possible values: ViewState

Type: int

instance_state¶

Possible values: InstanceState

Type: int

source_timestamp¶

The time (in unix nanoseconds) that the associated sample was written.

Type: int

instance_handle¶

Handle to the data instance (if this is a keyed topic)

Type: int

cyclonedds.internal.load_cyclonedds()[source]¶

Internal method to load the Cyclone DDS Dynamic Library. Handles platform specific naming/configuration.

Return type: ctypes.CDLL

@cyclonedds.internal.c_call[source]¶: Decorator. Convert a function into call into the class associated dll.

cyclonedds.internal.c_callable(return_type, argument_types)[source]¶

Decorator. Make a C function type based on python type annotations.

Return type: ctypes.CFUNCTYPE

class cyclonedds.internal.dds_c_t[source]¶

entity¶: alias of ctypes.c_int

time¶: alias of ctypes.c_long

duration¶: alias of ctypes.c_long

instance_handle¶: alias of ctypes.c_long

domainid¶: alias of ctypes.c_uint

sample_state¶: alias of ctypes.c_int

view_state¶: alias of ctypes.c_int

instance_state¶: alias of ctypes.c_int

reliability¶: alias of ctypes.c_int

durability¶: alias of ctypes.c_int

history¶: alias of ctypes.c_int

presentation_access_scope¶: alias of ctypes.c_int

type_consistency¶: alias of ctypes.c_int

ingnorelocal¶: alias of ctypes.c_int

ownership¶: alias of ctypes.c_int

liveliness¶: alias of ctypes.c_int

destination_order¶: alias of ctypes.c_int

data_representation_id¶: alias of ctypes.c_short

qos_p¶: alias of ctypes.c_void_p

attach¶: alias of ctypes.c_void_p

listener_p¶: alias of ctypes.c_void_p

topic_descriptor_p¶: alias of ctypes.c_void_p

returnv¶: alias of ctypes.c_int

class inconsistent_topic_status[source]¶

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class liveliness_lost_status[source]¶

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class liveliness_changed_status[source]¶

alive_count¶: Structure/Union member

alive_count_change¶: Structure/Union member

last_publication_handle¶: Structure/Union member

not_alive_count¶: Structure/Union member

not_alive_count_change¶: Structure/Union member

class offered_deadline_missed_status[source]¶

last_instance_handle¶: Structure/Union member

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class offered_incompatible_qos_status[source]¶

last_policy_id¶: Structure/Union member

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class sample_lost_status[source]¶

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class sample_rejected_status[source]¶

last_instance_handle¶: Structure/Union member

last_reason¶: Structure/Union member

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class requested_deadline_missed_status[source]¶

last_instance_handle¶: Structure/Union member

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class requested_incompatible_qos_status[source]¶

last_policy_id¶: Structure/Union member

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class publication_matched_status[source]¶

current_count¶: Structure/Union member

current_count_change¶: Structure/Union member

last_subscription_handle¶: Structure/Union member

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class subscription_matched_status[source]¶

current_count¶: Structure/Union member

current_count_change¶: Structure/Union member

last_publication_handle¶: Structure/Union member

total_count¶: Structure/Union member

total_count_change¶: Structure/Union member

class guid[source]¶

as_python_guid()[source]¶

Return type: uuid.UUID

v¶: Structure/Union member

class sample_info[source]¶

absolute_generation_rank¶: Structure/Union member

disposed_generation_count¶: Structure/Union member

generation_rank¶: Structure/Union member

instance_handle¶: Structure/Union member

instance_state¶: Structure/Union member

no_writers_generation_count¶: Structure/Union member

publication_handle¶: Structure/Union member

sample_rank¶: Structure/Union member

sample_state¶: Structure/Union member

source_timestamp¶: Structure/Union member

valid_data¶: Structure/Union member

view_state¶: Structure/Union member

class sample_buffer[source]¶

buf¶: Structure/Union member

len¶: Structure/Union member