iox::runtime🔗
Classes🔗
| Name | |
|---|---|
| class | iox::runtime::IpcInterfaceBase Base-Class should never be used by the end-user. Handles the common properties and methods for the childs. The handling of the IPC channels must be done by the children. |
| class | iox::runtime::IpcInterfaceCreator Class for creating and handling a IPC channel. |
| class | iox::runtime::IpcInterfaceUser Class for using a IPC channel. |
| class | iox::runtime::IpcMessage |
| class | iox::runtime::IpcRuntimeInterface |
| class | iox::runtime::Node class which represents a node |
| class | iox::runtime::NodeData struct which contains all the members of an object of type Node |
| struct | iox::runtime::NodeProperty helper struct which is convertable to string and constructable from a string which is required to send the createNode request over the IPC channel |
| struct | iox::runtime::PortConfigInfo Stores information necessary to create the right type of port on RouDi side. Different types of ports are required if e.g. different types of shared memory are used (e.g. on GPU). |
| class | iox::runtime::PoshRuntime The runtime that is needed for each application to communicate with the RouDi daemon. |
| class | iox::runtime::PoshRuntimeSingleProcess |
| class | iox::runtime::SharedMemoryUser shared memory setup for the management segment user side |
Types🔗
| Name | |
|---|---|
| enum int32_t | IpcMessageType |
| enum int32_t | IpcMessageErrorType { BEGIN, INVALID_STATE, NOTYPE, NO_UNIQUE_CREATED, REQUEST_PUBLISHER_WRONG_IPC_MESSAGE_RESPONSE, REQUEST_PUBLISHER_NO_WRITABLE_SHM_SEGMENT, REQUEST_SUBSCRIBER_WRONG_IPC_MESSAGE_RESPONSE, REQUEST_CONDITION_VARIABLE_WRONG_IPC_MESSAGE_RESPONSE, REQUEST_EVENT_VARIABLE_WRONG_IPC_MESSAGE_RESPONSE, PUBLISHER_LIST_FULL, SUBSCRIBER_LIST_FULL, CONDITION_VARIABLE_LIST_FULL, EVENT_VARIABLE_LIST_FULL, NODE_DATA_LIST_FULL, END } If IpcMessageType::ERROR, this is the sub type for details about the error. |
| enum | FindServiceError |
| using iox::cxx::vector< capro::IdString_t, MAX_NUMBER_OF_INSTANCES > | InstanceContainer |
Functions🔗
| Name | |
|---|---|
| IpcMessageType | stringToIpcMessageType(const char * str) Converts a string to the message type enumeration. |
| std::string | IpcMessageTypeToString(const IpcMessageType msg) Converts a message type enumeration value into a string. |
| IpcMessageErrorType | stringToIpcMessageErrorType(const char * str) Converts a string to the message error type enumeration. |
| std::string | IpcMessageErrorTypeToString(const IpcMessageErrorType msg) Converts a message error type enumeration value into a string. |
Attributes🔗
| Name | |
|---|---|
| constexpr units::Duration | PROCESS_WAITING_FOR_ROUDI_TIMEOUT |
| constexpr units::Duration | PROCESS_KEEP_ALIVE_INTERVAL |
| constexpr units::Duration | PROCESS_KEEP_ALIVE_TIMEOUT |
Types Documentation🔗
enum IpcMessageType🔗
| Enumerator | Value | Description |
|---|---|---|
| BEGIN | -1 | |
| NOTYPE | 0 | |
| REG | ||
| REG_ACK | ||
| CREATE_PUBLISHER | ||
| CREATE_PUBLISHER_ACK | ||
| CREATE_SUBSCRIBER | ||
| CREATE_SUBSCRIBER_ACK | ||
| CREATE_INTERFACE | ||
| CREATE_INTERFACE_ACK | ||
| CREATE_APPLICATION | ||
| CREATE_APPLICATION_ACK | ||
| CREATE_CONDITION_VARIABLE | ||
| CREATE_CONDITION_VARIABLE_ACK | ||
| CREATE_NODE | ||
| CREATE_NODE_ACK | ||
| FIND_SERVICE | ||
| KEEPALIVE | ||
| TERMINATION | ||
| TERMINATION_ACK | ||
| PREPARE_APP_TERMINATION | ||
| PREPARE_APP_TERMINATION_ACK | ||
| ERROR | ||
| APP_WAIT | ||
| WAKEUP_TRIGGER | ||
| REPLAY | ||
| SERVICE_REGISTRY_CHANGE_COUNTER | ||
| MESSAGE_NOT_SUPPORTED | ||
| END |
enum IpcMessageErrorType🔗
| Enumerator | Value | Description |
|---|---|---|
| BEGIN | ||
| INVALID_STATE | ||
| NOTYPE | ||
| NO_UNIQUE_CREATED | A publisher could not be created unique. | |
| REQUEST_PUBLISHER_WRONG_IPC_MESSAGE_RESPONSE | ||
| REQUEST_PUBLISHER_NO_WRITABLE_SHM_SEGMENT | ||
| REQUEST_SUBSCRIBER_WRONG_IPC_MESSAGE_RESPONSE | ||
| REQUEST_CONDITION_VARIABLE_WRONG_IPC_MESSAGE_RESPONSE | ||
| REQUEST_EVENT_VARIABLE_WRONG_IPC_MESSAGE_RESPONSE | ||
| PUBLISHER_LIST_FULL | ||
| SUBSCRIBER_LIST_FULL | ||
| CONDITION_VARIABLE_LIST_FULL | ||
| EVENT_VARIABLE_LIST_FULL | ||
| NODE_DATA_LIST_FULL | ||
| END |
If IpcMessageType::ERROR, this is the sub type for details about the error.
enum FindServiceError🔗
| Enumerator | Value | Description |
|---|---|---|
| INVALID_STATE | ||
| UNABLE_TO_WRITE_TO_ROUDI_CHANNEL | ||
| INSTANCE_CONTAINER_OVERFLOW |
using InstanceContainer🔗
using iox::runtime::InstanceContainer = typedef iox::cxx::vector<capro::IdString_t, MAX_NUMBER_OF_INSTANCES>;
Functions Documentation🔗
function stringToIpcMessageType🔗
IpcMessageType stringToIpcMessageType(
const char * str
)
Converts a string to the message type enumeration.
Parameters:
- str string to convert
function IpcMessageTypeToString🔗
std::string IpcMessageTypeToString(
const IpcMessageType msg
)
Converts a message type enumeration value into a string.
Parameters:
- msg enum value to convert
function stringToIpcMessageErrorType🔗
IpcMessageErrorType stringToIpcMessageErrorType(
const char * str
)
Converts a string to the message error type enumeration.
Parameters:
- str string to convert
function IpcMessageErrorTypeToString🔗
std::string IpcMessageErrorTypeToString(
const IpcMessageErrorType msg
)
Converts a message error type enumeration value into a string.
Parameters:
- msg enum value to convert
Attributes Documentation🔗
variable PROCESS_WAITING_FOR_ROUDI_TIMEOUT🔗
constexpr units::Duration PROCESS_WAITING_FOR_ROUDI_TIMEOUT = 60_s;
variable PROCESS_KEEP_ALIVE_INTERVAL🔗
constexpr units::Duration PROCESS_KEEP_ALIVE_INTERVAL = 3 * roudi::DISCOVERY_INTERVAL;
variable PROCESS_KEEP_ALIVE_TIMEOUT🔗
constexpr units::Duration PROCESS_KEEP_ALIVE_TIMEOUT = 5 * PROCESS_KEEP_ALIVE_INTERVAL;
Updated on 31 May 2022 at 15:29:16 CEST