Class IpcInterfaceUser

Inheritance Relationships

Base Type

Class Documentation

class IpcInterfaceUser : public iox::runtime::IpcInterfaceBase

Class for using a IPC channel.

Public Functions

IpcInterfaceUser(const RuntimeName_t &name, const uint64_t maxMessages = APP_MAX_MESSAGES, const uint64_t messageSize = APP_MESSAGE_SIZE) noexcept

Constructs a IpcInterfaceUser and opens a IPC channel. 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

IpcInterfaceUser(const IpcInterfaceUser&) = delete

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

IpcInterfaceUser &operator=(const IpcInterfaceUser&) = delete
IpcInterfaceUser(IpcInterfaceUser&&) = delete

Not needed therefore deleted.

IpcInterfaceUser &operator=(IpcInterfaceUser&&) = delete