Struct Node

pub struct Node<Service: Service> { /* private fields */ }

The Node is the entry point to the whole iceoryx2 infrastructure and owns all entities.

As soon as a process crashes other processes can detect dead Nodes via Node::list() and clean up the stale resources - the entities that were created via the Node.

Can be created via the NodeBuilder.

Implementations

impl<Service: Service> Node<Service>

pub fn name(&self) -> &NodeName

Returns the NodeName.

pub fn config(&self) -> &Config

Returns the Config that the Node will use to create any iceoryx2 entity.

pub fn id(&self) -> &NodeId

Returns the NodeId of the Node.

pub fn service_builder(&self, name: &ServiceName) -> Builder<Service>

Instantiates a ServiceBuilder for a service with the provided name.

pub fn list<F: FnMut(NodeState<Service>) -> CallbackProgression>( config: &Config, callback: F, ) -> Result<(), NodeListFailure>

Calls the provided callback for all Nodes in the system under a given Config and provides NodeState<Service> as input argument. With every iteration the callback has to return CallbackProgression::Continue to perform the next iteration or CallbackProgression::Stop to stop the iteration immediately.

Node::<ipc::Service>::list(Config::global_config(), |node_state| {
    println!("found node {:?}", node_state);
    CallbackProgression::Continue
});

pub fn wait(&self, cycle_time: Duration) -> Result<(), NodeWaitFailure>

Waits until the cycle time has passed. It returns NodeWaitFailure::TerminationRequest when a SIGTERM signal was received or NodeWaitFailure::Interrupt when a SIGINT signal was received.

pub fn signal_handling_mode(&self) -> SignalHandlingMode

Returns the SignalHandlingMode with which the Node was created.

pub fn cleanup_dead_nodes(config: &Config) -> CleanupState

Removes the stale system resources of all dead Nodes. The dead Nodes are also removed from all registered Services.

If a Node cannot be cleaned up since the process has insufficient permissions then the Node is skipped.

Trait Implementations

impl<Service: Debug + Service> Debug for Node<Service>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Service: Service> Send for Node<Service>