Skip to main content

NrosRmwSessionOptions

Type Alias NrosRmwSessionOptions 

Source
pub type NrosRmwSessionOptions = rmw_session_options_t;
Expand description

issue 0808 — session creation options; NULL means every default.

Aliased Type§

#[repr(C)]
pub struct NrosRmwSessionOptions { pub localhost_only: u8, pub _reserved: [u8; 7], pub enclave: *const i8, pub properties: *const rmw_session_property_t, pub property_count: usize, }

Fields§

§localhost_only: u8

Restrict discovery to this host. Upstream rmw_localhost_only_t, narrowed to a flag: 0 = the system default, non-zero = localhost only.

A backend that cannot restrict discovery must IGNORE this rather than fail — same contract as mode. Cyclone is the one that can honour it.

§_reserved: [u8; 7]

< Reserved; must be zero.

§enclave: *const i8

The security enclave this session belongs to, or NULL.

Borrowed for the duration of the call. Carried so rmw_get_node_names_with_enclaves stops being a HOLLOW grouping: the visitor’s enclave argument was structurally always NULL because nothing in this ABI accepted one (issue 0785). A backend that does not track enclaves still reports NULL, which is now a fact about the backend rather than about the seam.

§properties: *const rmw_session_property_t

Backend-specific configuration properties, or NULL.

Borrowed for the duration of the call, as is every string they point at. property_count must be 0 when this is NULL, and must not exceed RMW_SESSION_MAX_PROPERTIES; a violation is RMW_RET_INVALID_ARGUMENT, not a truncation.

§property_count: usize

< Number of entries in properties.