Class IpcInterfaceCreator

Inheritance Relationships

Base Type

Class Documentation

class IpcInterfaceCreator : public iox::runtime::IpcInterfaceBase

Class for creating and handling a IPC channel.

Note

This class makes sures the IPC channel is created uniquely

Public Functions

IpcInterfaceCreator(const RuntimeName_t &name, const uint64_t maxMessages = ROUDI_MAX_MESSAGES, const uint64_t messageSize = ROUDI_MESSAGE_SIZE) noexcept

Constructs a IpcInterfaceCreator and opens a new IPC channel. If it fails isInitialized will return false. Therefore, isInitialized should always be called before using this class.

Parameters:

  • name – [in] Unique identifier of the IPC channel

  • maxMessages – [in] maximum number of queued messages

  • message – [in] size maximum message size

IpcInterfaceCreator(const IpcInterfaceCreator&) = delete

The copy constructor and assignment operator is deleted since this class manages a resource (IPC channel) which cannot be copied. Move is also not needed, it is also deleted.

IpcInterfaceCreator &operator=(const IpcInterfaceCreator&) = delete
IpcInterfaceCreator(IpcInterfaceCreator&&) = delete

Not needed therefore deleted.

IpcInterfaceCreator &operator=(IpcInterfaceCreator&&) = delete