CleanupState Struct Reference

#include <cleanup_state.hpp>

Public Attributes
uint64_t	cleanups
	The number of successful dead node cleanups.
uint64_t	failed_cleanups
	The number of failed dead node cleanups.

Detailed Description

Returned by [Node::try_cleanup_dead_nodes()]. Contains the cleanup report of the call and contains the number of dead nodes that were successfully cleaned up and how many could not be cleaned up. This does not have to be an error, for instance when the current process does not have the permission to access the corresponding resources.

Definition at line 23 of file cleanup_state.hpp.

Member Data Documentation

cleanups

uint64_t CleanupState::cleanups

The number of successful dead node cleanups.

Definition at line 25 of file cleanup_state.hpp.

Referenced by iox2::PortFactoryBlackboard< S, KeyType >::blocking_cleanup_dead_nodes(), iox2::PortFactoryPublishSubscribe< S, Payload, UserHeader >::blocking_cleanup_dead_nodes(), iox2::PortFactoryRequestResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::blocking_cleanup_dead_nodes(), iox2::PortFactoryBlackboard< S, KeyType >::try_cleanup_dead_nodes(), iox2::PortFactoryPublishSubscribe< S, Payload, UserHeader >::try_cleanup_dead_nodes(), and iox2::PortFactoryRequestResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::try_cleanup_dead_nodes().

failed_cleanups

uint64_t CleanupState::failed_cleanups

The number of failed dead node cleanups.

Definition at line 27 of file cleanup_state.hpp.

---

The documentation for this struct was generated from the following file:

• iox2/cleanup_state.hpp