Fast DDS  Version 3.0.0
Fast DDS
Loading...
Searching...
No Matches

All QoS policies and parameters are included here. More...

Collaboration diagram for Qos Module:

Classes

class  Parameter_t
 Base Parameter class with parameter PID and parameter length in bytes. More...
 
class  ParameterKey_t
 
class  ParameterLocator_t
 
class  ParameterString_t
 
class  ParameterPort_t
 
class  ParameterGuid_t
 
class  ParameterDomainId_t
 
class  ParameterProtocolVersion_t
 
class  ParameterVendorId_t
 
class  ParameterProductVersion_t
 
class  ParameterIP4Address_t
 
class  ParameterBool_t
 
class  ParameterStatusInfo_t
 
class  ParameterCount_t
 
class  ParameterEntityId_t
 
class  ParameterTime_t
 
class  ParameterBuiltinEndpointSet_t
 
class  ParameterNetworkConfigSet_t
 
class  ParameterProperty_t
 
class  ParameterPropertyList_t
 
class  ParameterSampleIdentity_t
 

Macros

#define PARAMETER_KEY_HASH_LENGTH   16
 
#define PARAMETER_LOCATOR_LENGTH   24
 
#define PARAMETER_PORT_LENGTH   4
 
#define PARAMETER_GUID_LENGTH   16
 
#define PARAMETER_DOMAINID_LENGTH   4
 
#define PARAMETER_PROTOCOL_LENGTH   4
 
#define PARAMETER_VENDOR_LENGTH   4
 
#define PARAMETER_PRODUCT_VERSION_LENGTH   4
 
#define PARAMETER_IP4_LENGTH   4
 
#define PARAMETER_BOOL_LENGTH   4
 
#define PARAMETER_STATUS_INFO_LENGTH   4
 
#define PARAMETER_COUNT_LENGTH   4
 
#define PARAMETER_ENTITYID_LENGTH   4
 
#define PARAMETER_TIME_LENGTH   8
 
#define PARAMETER_BUILTINENDPOINTSET_LENGTH   4
 
#define PARAMETER_NETWORKCONFIGSET_LENGTH   4
 
#define PARAMETER_SAMPLEIDENTITY_LENGTH   24
 

Enumerations

enum  ParameterId_t : uint16_t {
  PID_PAD = 0x0000 , PID_SENTINEL = 0x0001 , PID_USER_DATA = 0x002c , PID_TOPIC_NAME = 0x0005 ,
  PID_TYPE_NAME = 0x0007 , PID_GROUP_DATA = 0x002d , PID_TOPIC_DATA = 0x002e , PID_DURABILITY = 0x001d ,
  PID_DURABILITY_SERVICE = 0x001e , PID_DEADLINE = 0x0023 , PID_LATENCY_BUDGET = 0x0027 , PID_LIVELINESS = 0x001b ,
  PID_RELIABILITY = 0x001a , PID_LIFESPAN = 0x002b , PID_DESTINATION_ORDER = 0x0025 , PID_HISTORY = 0x0040 ,
  PID_RESOURCE_LIMITS = 0x0041 , PID_OWNERSHIP = 0x001f , PID_OWNERSHIP_STRENGTH = 0x0006 , PID_PRESENTATION = 0x0021 ,
  PID_PARTITION = 0x0029 , PID_TIME_BASED_FILTER = 0x0004 , PID_TRANSPORT_PRIORITY = 0x0049 , PID_DOMAIN_ID = 0x000f ,
  PID_DOMAIN_TAG = 0x4014 , PID_PROTOCOL_VERSION = 0x0015 , PID_VENDORID = 0x0016 , PID_UNICAST_LOCATOR = 0x002f ,
  PID_MULTICAST_LOCATOR = 0x0030 , PID_DEFAULT_UNICAST_LOCATOR = 0x0031 , PID_DEFAULT_MULTICAST_LOCATOR = 0x0048 , PID_METATRAFFIC_UNICAST_LOCATOR = 0x0032 ,
  PID_METATRAFFIC_MULTICAST_LOCATOR = 0x0033 , PID_EXPECTS_INLINE_QOS = 0x0043 , PID_PARTICIPANT_MANUAL_LIVELINESS_COUNT = 0x0034 , PID_PARTICIPANT_LEASE_DURATION = 0x0002 ,
  PID_CONTENT_FILTER_PROPERTY = 0x0035 , PID_PARTICIPANT_GUID = 0x0050 , PID_GROUP_GUID = 0x0052 , PID_GROUP_ENTITYID = 0x0053 ,
  PID_BUILTIN_ENDPOINT_SET = 0x0058 , PID_BUILTIN_ENDPOINT_QOS = 0x0077 , PID_PROPERTY_LIST = 0x0059 , PID_TYPE_MAX_SIZE_SERIALIZED = 0x0060 ,
  PID_ENTITY_NAME = 0x0062 , PID_ENDPOINT_GUID = 0x005a , PID_CONTENT_FILTER_INFO = 0x0055 , PID_COHERENT_SET = 0x0056 ,
  PID_DIRECTED_WRITE = 0x0057 , PID_ORIGINAL_WRITER_INFO = 0x0061 , PID_GROUP_COHERENT_SET = 0x0063 , PID_GROUP_SEQ_NUM = 0x0064 ,
  PID_WRITER_GROUP_INFO = 0x0065 , PID_SECURE_WRITER_GROUP_INFO = 0x0066 , PID_KEY_HASH = 0x0070 , PID_STATUS_INFO = 0x0071 ,
  PID_TYPE_IDV1 = 0x0069 , PID_TYPE_OBJECTV1 = 0x0072 , PID_DATA_REPRESENTATION = 0x0073 , PID_TYPE_CONSISTENCY_ENFORCEMENT = 0x0074 ,
  PID_TYPE_INFORMATION = 0x0075 , PID_IDENTITY_TOKEN = 0x1001 , PID_PERMISSIONS_TOKEN = 0x1002 , PID_PARTICIPANT_SECURITY_INFO = 0x1005 ,
  PID_ENDPOINT_SECURITY_INFO = 0x1004 , PID_IDENTITY_STATUS_TOKEN = 0x1006 , PID_DATA_TAGS = 0x1003 , PID_SERVICE_INSTANCE_NAME = 0x0080 ,
  PID_RELATED_ENTITY_GUID = 0x0081 , PID_TOPIC_ALIASES = 0x0082 , PID_RELATED_SAMPLE_IDENTITY = 0x0083 , PID_PRODUCT_VERSION = 0x8000 ,
  PID_PERSISTENCE_GUID = 0x8002 , PID_DISABLE_POSITIVE_ACKS = 0x8005 , PID_DATASHARING = 0x8006 , PID_NETWORK_CONFIGURATION_SET = 0x8007 ,
  PID_CUSTOM_RELATED_SAMPLE_IDENTITY = 0x800f
}
 Enum for the unique parameter identifier. More...
 

Variables

const std::string parameter_property_persistence_guid = "PID_PERSISTENCE_GUID"
 Parameter property ID for persistence GUID.
 
const std::string parameter_property_participant_type = "PARTICIPANT_TYPE"
 Parameter property ID for participant type.
 
const std::string parameter_property_ds_version = "DS_VERSION"
 Parameter property ID for Discovery Server version.
 
const std::string parameter_property_current_ds_version = "2.0"
 Parameter property value for Discovery Server version.
 
const char *const parameter_policy_physical_data_host = "fastdds.physical_data.host"
 Parameter property value for Host physical data.
 
const char *const parameter_policy_physical_data_user = "fastdds.physical_data.user"
 Parameter property value for User physical data.
 
const char *const parameter_policy_physical_data_process = "fastdds.physical_data.process"
 Parameter property value for Process physical data.
 
const char *const parameter_enable_monitor_service = "fastdds.enable_monitor_service"
 Parameter property value for enabling the monitor service.
 
const char *const parameter_policy_type_propagation = "fastdds.type_propagation"
 Parameter property value for configuring type propagation.
 

Detailed Description

All QoS policies and parameters are included here.

Macro Definition Documentation

◆ PARAMETER_BOOL_LENGTH

#define PARAMETER_BOOL_LENGTH   4

◆ PARAMETER_BUILTINENDPOINTSET_LENGTH

#define PARAMETER_BUILTINENDPOINTSET_LENGTH   4

◆ PARAMETER_COUNT_LENGTH

#define PARAMETER_COUNT_LENGTH   4

◆ PARAMETER_DOMAINID_LENGTH

#define PARAMETER_DOMAINID_LENGTH   4

◆ PARAMETER_ENTITYID_LENGTH

#define PARAMETER_ENTITYID_LENGTH   4

◆ PARAMETER_GUID_LENGTH

#define PARAMETER_GUID_LENGTH   16

◆ PARAMETER_IP4_LENGTH

#define PARAMETER_IP4_LENGTH   4

◆ PARAMETER_KEY_HASH_LENGTH

#define PARAMETER_KEY_HASH_LENGTH   16

◆ PARAMETER_LOCATOR_LENGTH

#define PARAMETER_LOCATOR_LENGTH   24

◆ PARAMETER_NETWORKCONFIGSET_LENGTH

#define PARAMETER_NETWORKCONFIGSET_LENGTH   4

◆ PARAMETER_PORT_LENGTH

#define PARAMETER_PORT_LENGTH   4

◆ PARAMETER_PRODUCT_VERSION_LENGTH

#define PARAMETER_PRODUCT_VERSION_LENGTH   4

◆ PARAMETER_PROTOCOL_LENGTH

#define PARAMETER_PROTOCOL_LENGTH   4

◆ PARAMETER_SAMPLEIDENTITY_LENGTH

#define PARAMETER_SAMPLEIDENTITY_LENGTH   24

◆ PARAMETER_STATUS_INFO_LENGTH

#define PARAMETER_STATUS_INFO_LENGTH   4

◆ PARAMETER_TIME_LENGTH

#define PARAMETER_TIME_LENGTH   8

◆ PARAMETER_VENDOR_LENGTH

#define PARAMETER_VENDOR_LENGTH   4

Enumeration Type Documentation

◆ ParameterId_t

enum ParameterId_t : uint16_t

Enum for the unique parameter identifier.

Alias of uint16_t.

Enumerator
PID_PAD 
PID_SENTINEL 
PID_USER_DATA 
PID_TOPIC_NAME 
PID_TYPE_NAME 
PID_GROUP_DATA 
PID_TOPIC_DATA 
PID_DURABILITY 
PID_DURABILITY_SERVICE 
PID_DEADLINE 
PID_LATENCY_BUDGET 
PID_LIVELINESS 
PID_RELIABILITY 
PID_LIFESPAN 
PID_DESTINATION_ORDER 
PID_HISTORY 
PID_RESOURCE_LIMITS 
PID_OWNERSHIP 
PID_OWNERSHIP_STRENGTH 
PID_PRESENTATION 
PID_PARTITION 
PID_TIME_BASED_FILTER 
PID_TRANSPORT_PRIORITY 
PID_DOMAIN_ID 
PID_DOMAIN_TAG 
PID_PROTOCOL_VERSION 
PID_VENDORID 
PID_UNICAST_LOCATOR 
PID_MULTICAST_LOCATOR 
PID_DEFAULT_UNICAST_LOCATOR 
PID_DEFAULT_MULTICAST_LOCATOR 
PID_METATRAFFIC_UNICAST_LOCATOR 
PID_METATRAFFIC_MULTICAST_LOCATOR 
PID_EXPECTS_INLINE_QOS 
PID_PARTICIPANT_MANUAL_LIVELINESS_COUNT 
PID_PARTICIPANT_LEASE_DURATION 
PID_CONTENT_FILTER_PROPERTY 
PID_PARTICIPANT_GUID 
PID_GROUP_GUID 
PID_GROUP_ENTITYID 
PID_BUILTIN_ENDPOINT_SET 
PID_BUILTIN_ENDPOINT_QOS 
PID_PROPERTY_LIST 
PID_TYPE_MAX_SIZE_SERIALIZED 
PID_ENTITY_NAME 
PID_ENDPOINT_GUID 
PID_CONTENT_FILTER_INFO 
PID_COHERENT_SET 
PID_DIRECTED_WRITE 
PID_ORIGINAL_WRITER_INFO 
PID_GROUP_COHERENT_SET 
PID_GROUP_SEQ_NUM 
PID_WRITER_GROUP_INFO 
PID_SECURE_WRITER_GROUP_INFO 
PID_KEY_HASH 
PID_STATUS_INFO 
PID_TYPE_IDV1 
PID_TYPE_OBJECTV1 
PID_DATA_REPRESENTATION 
PID_TYPE_CONSISTENCY_ENFORCEMENT 
PID_TYPE_INFORMATION 
PID_IDENTITY_TOKEN 
PID_PERMISSIONS_TOKEN 
PID_PARTICIPANT_SECURITY_INFO 
PID_ENDPOINT_SECURITY_INFO 
PID_IDENTITY_STATUS_TOKEN 
PID_DATA_TAGS 
PID_SERVICE_INSTANCE_NAME 
PID_RELATED_ENTITY_GUID 
PID_TOPIC_ALIASES 
PID_RELATED_SAMPLE_IDENTITY 
PID_PRODUCT_VERSION 
PID_PERSISTENCE_GUID 
PID_DISABLE_POSITIVE_ACKS 
PID_DATASHARING 
PID_NETWORK_CONFIGURATION_SET 
PID_CUSTOM_RELATED_SAMPLE_IDENTITY 

Variable Documentation

◆ parameter_enable_monitor_service

const char* const parameter_enable_monitor_service = "fastdds.enable_monitor_service"

Parameter property value for enabling the monitor service.

◆ parameter_policy_physical_data_host

const char* const parameter_policy_physical_data_host = "fastdds.physical_data.host"

Parameter property value for Host physical data.

◆ parameter_policy_physical_data_process

const char* const parameter_policy_physical_data_process = "fastdds.physical_data.process"

Parameter property value for Process physical data.

◆ parameter_policy_physical_data_user

const char* const parameter_policy_physical_data_user = "fastdds.physical_data.user"

Parameter property value for User physical data.

◆ parameter_policy_type_propagation

const char* const parameter_policy_type_propagation = "fastdds.type_propagation"

Parameter property value for configuring type propagation.

◆ parameter_property_current_ds_version

const std::string parameter_property_current_ds_version = "2.0"

Parameter property value for Discovery Server version.

◆ parameter_property_ds_version

const std::string parameter_property_ds_version = "DS_VERSION"

Parameter property ID for Discovery Server version.

◆ parameter_property_participant_type

const std::string parameter_property_participant_type = "PARTICIPANT_TYPE"

Parameter property ID for participant type.

◆ parameter_property_persistence_guid

const std::string parameter_property_persistence_guid = "PID_PERSISTENCE_GUID"

Parameter property ID for persistence GUID.