Skip to main content

Module pid

Module pid 

Source
Expand description

Standard-Parameter-IDs (Spec §9.6.4 + Tabelle 9.13).

Die 12 QoS-Policy-PIDs aus DDS 1.4 §2.2.3 werden aus zerodds_qos::Pid re-exportiert (Single-Source-of-Truth). rtps-spezifische PIDs (Locators, GUIDs, Security-Tokens, …) bleiben hier deklariert, da sie ausserhalb des QoS-Policy-Subsets sind.

Constants§

BUILTIN_ENDPOINT_SET
Builtin-Endpoint-Set (4 byte u32 Bitmask).
COHERENT_SET
PID_COHERENT_SET (DDSI-RTPS 2.5 §9.6.4.2): 8 byte SequenceNumber = sequence_number des ersten Sample im Coherent-Set. Alle DATA/ DATA_FRAG eines Sets tragen diesen PID in Inline-QoS. Set-Ende signalisiert eine DATA mit PID_COHERENT_SET=neue_sn oder ohne PID. Implementiert WP 2.9 (C2.9 Coherent-Sets).
CONTENT_FILTER_PROPERTY
Content-Filter-Property (Spec §9.6.3.4 Table 9.14): Topic- Filter-Name (String) + related-Topic-Name (String) + Filter- Class-Name (String) + Filter-Expression (String) + Expression-Parameters (sequence).
DATA_REPRESENTATION
Data-Representation (sequence) — XCDR1/XCDR2-Negotiation (XTypes §7.6.3.2.2).
DEADLINE
Deadline QoS. (Re-export aus zerodds_qos::Pid::DEADLINE.)
DEFAULT_MULTICAST_LOCATOR
Default-Multicast-Locator (24 byte).
DEFAULT_UNICAST_LOCATOR
Default-Unicast-Locator (24 byte) — fuer User-Daten.
DIRECTED_WRITE
PID_DIRECTED_WRITE (DDSI-RTPS 2.5 §8.7.7 / §9.6.2.2.5). Inline-QoS auf einer DATA/DATA_FRAG, die exakt einen Ziel-Reader (per GUID, 16 byte) adressiert. Andere Reader, die das Sample empfangen, MUESSEN es verwerfen. Ermoeglicht Punkt-zu-Punkt-Pfade ueber einen Multicast-Writer (z.B. Auth-Handshake).
DOMAIN_ID
Domain-Id (4 byte u32) — Participant-Domain.
DURABILITY
Durability QoS. (Re-export aus zerodds_qos::Pid::DURABILITY.)
ENDPOINT_GUID
Endpoint-Guid (16 byte) — fuer Publication/Subscription-Discovery.
ENDPOINT_SECURITY_INFO
Endpoint-Security-Info (Spec OMG DDS-Security 1.1 §7.4.1.5). 2x u32 Masken: endpoint_security_attributes + plugin_endpoint_security_attributes. Traeger fuer Endpoint- Level-Protection-Flags (WP 4H-c).
ENDPOINT_SYMMETRIC_CIPHER_ALGORITHM_INFO
PID_ENDPOINT_SYMMETRIC_CIPHER_ALGORITHM_INFO (DDS-Security 1.2 §7.3.15 + §7.5.1.5). 4 byte: required_mask. Pro DataWriter/ DataReader im Pub/SubscriptionBuiltinTopicData.
GROUP_COHERENT_SET
PID_GROUP_COHERENT_SET (DDSI-RTPS 2.5 §9.6.4.3): 8 byte SequenceNumber = group_sequence_number des ersten Sample im Group-Coherent-Set (PRESENTATION.access_scope = GROUP).
GROUP_DATA
GroupData QoS. (Re-export aus zerodds_qos::Pid::GROUP_DATA.)
GROUP_SEQ_NUM
PID_GROUP_SEQ_NUM (DDSI-RTPS 2.5 §9.6.4.4): 8 byte SequenceNumber = group sequence number des Sample. Pflicht-Tag fuer Publisher mit access_scope=GROUP.
IDENTITY_STATUS_TOKEN
PID_IDENTITY_STATUS_TOKEN (DDS-Security 1.2 §7.4.1.6, §10.3.2 Tab.53). Wert ist CDR-encoded DataHolder. Traeger fuer OCSP- Live-Status (AuthenticationListener.on_revoke_identity etc.).
IDENTITY_TOKEN
PID_IDENTITY_TOKEN (DDS-Security 1.2 §7.4.1.4 Tab.16). Wert ist ein CDR-encoded DataHolder (class_id="DDS:Auth:PKI-DH:1.2" + Properties dds.cert.sn, dds.cert.algo, dds.ca.sn, dds.ca.algo). Erlaubt Discovery-Routing und Cert-Chain- Bind ohne Voll-Cert im SPDP-Announce. Pflicht ab DDS-Security 1.2 — Cyclone DDS / FastDDS verlassen sich auf diesen PID.
IGNORE
PID_IGNORE (XTypes 1.3 §7.4.1.2.1). Padding-/Filler-PID. Receiver MUSS Wert ueberlesen und nicht in die ParameterList aufnehmen (Spec: “Used to ignore parameters which can be safely ignored”). Wird von Encodern als Padding zwischen variablen-laengen Parametern verwendet, ohne den Decoder zu stoeren.
KEY_HASH
PID_KEY_HASH (DDSI-RTPS 2.5 §9.6.4.8 + XTypes 1.3 §7.6.8): 16-Byte Instance-Identifier in Inline-QoS einer DATA/DATA_FRAG. Reader und Persistence-Service korrelieren Samples derselben Instanz ueber diesen Hash. Berechnung: PLAIN_CDR2-BE des @key-Holders, bei max_size <= 16 zero-padded, sonst MD5(stream).
LIFESPAN
Lifespan QoS. (Re-export aus zerodds_qos::Pid::LIFESPAN.)
LIVELINESS
Liveliness QoS. (Re-export aus zerodds_qos::Pid::LIVELINESS.)
METATRAFFIC_MULTICAST_LOCATOR
Metatraffic-Multicast-Locator (24 byte) — wohin Peers SPDP/SEDP Multicast schicken.
METATRAFFIC_UNICAST_LOCATOR
Metatraffic-Unicast-Locator (24 byte) — wohin Peers SEDP-Unicast schicken. Unverzichtbar fuer Cyclone-Interop.
ORIGINAL_WRITER_INFO
PID_ORIGINAL_WRITER_INFO (Spec §8.7.9). 24 byte: GUID + SequenceNumber des urspruenglichen Writers. Wird vom Persistence-Service als Inline-QoS gesetzt, wenn er ein gespeichertes Sample im Auftrag eines anderen Writers weiterleitet (Late-Joiner-Replay).
OWNERSHIP
Ownership QoS. (Re-export aus zerodds_qos::Pid::OWNERSHIP.)
OWNERSHIP_STRENGTH
Ownership-Strength QoS. (Re-export aus zerodds_qos::Pid::OWNERSHIP_STRENGTH.)
PARTICIPANT_GUID
Participant-Guid (16 byte).
PARTICIPANT_LEASE_DURATION
Participant lease duration (Duration_t = i32 sec + u32 nanosec).
PARTICIPANT_SECURITY_DIGITAL_SIGNATURE_ALGORITHM_INFO
PID_PARTICIPANT_SECURITY_DIGITAL_SIGNATURE_ALGORITHM_INFO (DDS-Security 1.2 §7.3.11 + §7.5.1.4). 16 byte: 2 × AlgorithmRequirements (trust_chain + message_auth). Spec- Default: RSASSA-PSS + ECDSA-P256.
PARTICIPANT_SECURITY_INFO
Participant-Security-Info (Spec DDS-Security 1.2 §7.4.1.6 Tab.18+19). 2x u32 Masken auf Participant-Level — participant_security_attributes + plugin_participant_security_ attributes. Steuert RTPS-Submessage / Discovery / Liveliness- Protection-Flags fuer den ganzen Participant.
PARTICIPANT_SECURITY_KEY_ESTABLISHMENT_ALGORITHM_INFO
PID_PARTICIPANT_SECURITY_KEY_ESTABLISHMENT_ALGORITHM_INFO (DDS-Security 1.2 §7.3.12 + §7.5.1.4). 8 byte: AlgorithmRequirements fuer DH/ECDH. Spec-Default: DHE-MODP-2048 + ECDHE-CEUM-P256.
PARTICIPANT_SECURITY_SYMMETRIC_CIPHER_ALGORITHM_INFO
PID_PARTICIPANT_SECURITY_SYMMETRIC_CIPHER_ALGORITHM_INFO (DDS-Security 1.2 §7.3.13 + §7.5.1.4). 16 byte: 4 × u32 (supported + 3 required-Masks). Spec-Default: AES128 | AES256 supported, AES128 fuer alle Endpoint-Klassen required.
PARTITION
Partition QoS. (Re-export aus zerodds_qos::Pid::PARTITION.)
PERMISSIONS_TOKEN
PID_PERMISSIONS_TOKEN (DDS-Security 1.2 §7.4.1.5 Tab.17). Wert ist CDR-encoded DataHolder (class_id="DDS:Access:Permissions:1.2" + Properties dds.perm_ca.sn, dds.perm_ca.algo).
PROPERTY_LIST
Property-List (Spec OMG DDS-Security 1.1 §7.2.1). Sequence von (name, value)-String-Paaren plus einer leeren oder gefuellten BinaryPropertySeq. Traeger fuer Security-Plugin-Klassen, Permissions-Tokens und ZeroDDS-Heterogeneous-Security-Caps (WP 4H-b).
PROTOCOL_VERSION
ProtocolVersion (2 byte + 2 padding).
RELATED_ENTITY_GUID
PID_RELATED_ENTITY_GUID (DDS-RPC 1.0 §7.8.2). 16 byte = GUID des Pendant-Endpoints (Request-Writer ↔ Reply-Reader bzw. Request-Reader ↔ Reply-Writer). Bindet die zwei Topics zu einem logischen RPC-Endpoint-Pair.
RELATED_SAMPLE_IDENTITY
PID_RELATED_SAMPLE_IDENTITY (DDS-RPC 1.0 §7.8.2). Inline-QoS-PID auf einer Reply-DATA-Submessage. 24 byte XCDR2-SampleIdentity = request_id der korrelierten Request, damit der Requester den Reply der zugehoerigen Anfrage zuordnen kann.
RELIABILITY
Reliability QoS. (Re-export aus zerodds_qos::Pid::RELIABILITY.)
SENTINEL
Sentinel — Terminator der ParameterList. (Re-export aus zerodds_qos::Pid::SENTINEL.)
SERVICE_INSTANCE_NAME
PID_SERVICE_INSTANCE_NAME (DDS-RPC 1.0 §7.8.2). CDR-String = logischer Service-Instance-Name. Erlaubt mehrere Instanzen desselben Service-Typs auf einem Participant.
SHM_LOCATOR
PID_SHM_LOCATOR (ZeroDDS Vendor-PID 0x8001, zerodds-flatdata-1.0 §3.1). Wert: u32 hostname_hash + u32 uid + u32 slot_count + u32 slot_size + CDR-String segment_path. Vom Writer im Discovery-Sample, Reader auf demselben Host (uid + hostname_hash match) attached an SHM-Segment. Vendor-PID OHNE MUST_UNDERSTAND-Bit — fremde Vendoren ignorieren.
STATUS_INFO
PID_STATUS_INFO (DDSI-RTPS 2.5 §9.6.3.9): 4 byte Statusword; Bit 0 = DISPOSED, Bit 1 = UNREGISTERED, Bit 2 = FILTERED. Wird als Inline-QoS gesendet, wenn der Sample-Lifecycle das verlangt (DataWriter::dispose / unregister oder ContentFilter-Match=False).
TOPIC_ALIASES
PID_TOPIC_ALIASES (DDS-RPC 1.0 §7.8.2). sequence<string> = alternative Topic-Namen fuer Routing/Compat. Reihenfolge ist signifikant (erstes Element = bevorzugter Alias).
TOPIC_DATA
TopicData QoS. (Re-export aus zerodds_qos::Pid::TOPIC_DATA.)
TOPIC_NAME
Topic-Name (CDR-String).
TYPE_CONSISTENCY_ENFORCEMENT
Type-Consistency-Enforcement (4 byte kind + flags) — XTypes §7.6.3.7.
TYPE_INFORMATION
Type-Information (TypeInformation payload) — XTypes §7.6.3.2.2.
TYPE_MAX_SIZE_SERIALIZED
PID_TYPE_MAX_SIZE_SERIALIZED (Spec §9.6.4.7). 4 byte u32 — die max-Wire-Groesse eines Samples-Payloads in CDR. Wird fuer Subscriber genutzt, um vorab zu pruefen, ob die Payload in max_dataMaxSize paesst (DoS-Schutz).
TYPE_NAME
Type-Name (CDR-String).
USER_DATA
UserData QoS. (Re-export aus zerodds_qos::Pid::USER_DATA.)
VENDOR_ID
VendorId (2 byte + 2 padding).
VENDOR_TRACE_CONTEXT
PID_VENDOR_TRACE_CONTEXT (zerodds-monitor-1.0 §4): Inline-QoS-PID fuer W3C-Trace-Context-Propagation. Wert: 2 CDR-Strings (traceparent + tracestate). Steht im Standard-PID-Range, weil Cross-Vendor-Adoption gewuenscht ist; Empfaenger ohne PID-Kenntnis ignorieren transparent (kein MUST_UNDERSTAND-Bit). Encoder/Decoder im Spec-konsumierenden zerodds-monitor::TraceContextPid.
WRITER_GROUP_INFO
PID_WRITER_GROUP_INFO (Spec §8.7.5 + §9.6.2.2.6). Group-Sequence- Nummer des Writers innerhalb eines Publisher-Group-Coherent- Sets. Wird in HEARTBEAT.GroupInfo + InlineQoS getragen.
ZERODDS_TYPE_ID
PID_ZERODDS_TYPE_ID (ZeroDDS Vendor-PID 0x8002). Wert: CDR-encoded zerodds_types::TypeIdentifier (XTypes §7.3.4.2), Little-Endian (Submessage-Endianness). Trägt die TypeIdentifier- Diskrimination der Topic-Type fuer XTypes-aware Reader-Writer- Matching (XTypes §7.6.3.7 + DDS 1.4 §2.2.3 TypeConsistencyEnforcement). Vendor-PID OHNE MUST_UNDERSTAND-Bit — fremde Vendoren ignorieren und der Reader-Match faellt zurueck auf reinen type_name-Vergleich (DDS 1.4 §2.2.3 Default-Path).