iceoryx_doc  1.0.1
Namespaces | Classes | Typedefs | Enumerations | Variables
iox Namespace Reference

Namespaces

 mepoo
 Mepoo Component Description.
 
 roudi
 

Classes

struct  Config
 
struct  DefaultChunkDistributorConfig
 
struct  DefaultChunkQueueConfig
 
struct  LoggingComponent
 

Typedefs

using RouDiConfig_t = Config< mepoo::SegmentConfig, config::RouDiConfig >
 
using PublisherPortRouDiType = iox::popo::PublisherPortRouDi
 
using PublisherPortUserType = iox::popo::PublisherPortUser
 
using SubscriberPortRouDiType = iox::popo::SubscriberPortRouDi
 
using SubscriberPortUserType = iox::popo::SubscriberPortUser
 
using UniquePortId = popo::TypedUniqueId< popo::BasePortData >
 
using SubscriberPortType = iox::build::CommunicationPolicy
 
using IpcChannelType = iox::posix::UnixDomainSocket
 The socket is created in the current path if no absolute path is given hence we need an absolut path so that every application knows where our sockets can be found.
 
using RuntimeName_t = cxx::string< MAX_RUNTIME_NAME_LENGTH >
 
using NodeName_t = cxx::string< 100 >
 
using ShmName_t = cxx::string< 128 >
 

Enumerations

enum class  SubscribeState : uint32_t {
  NOT_SUBSCRIBED = 0 , SUBSCRIBE_REQUESTED , SUBSCRIBED , UNSUBSCRIBE_REQUESTED ,
  WAIT_FOR_OFFER
}
 
enum class  ConnectionState : uint32_t {
  NOT_CONNECTED = 0 , CONNECT_REQUESTED , CONNNECTED , DISCONNECT_REQUESTED ,
  WAIT_FOR_OFFER
}
 

Variables

constexpr uint32_t MAX_RECEIVERS_PER_SENDERPORT = build::IOX_MAX_SUBSCRIBERS_PER_PUBLISHER
 
constexpr uint32_t MAX_PUBLISHERS = build::IOX_MAX_PUBLISHERS
 
constexpr uint32_t MAX_SUBSCRIBERS_PER_PUBLISHER = build::IOX_MAX_SUBSCRIBERS_PER_PUBLISHER
 
constexpr uint32_t MAX_CHUNKS_ALLOCATED_PER_PUBLISHER_SIMULTANEOUSLY
 
constexpr uint64_t MAX_PUBLISHER_HISTORY = build::IOX_MAX_PUBLISHER_HISTORY
 
constexpr uint32_t MAX_SUBSCRIBERS = build::IOX_MAX_SUBSCRIBERS
 
constexpr uint32_t MAX_CHUNKS_HELD_PER_SUBSCRIBER_SIMULTANEOUSLY
 
constexpr uint32_t MAX_SUBSCRIBER_QUEUE_CAPACITY = MAX_CHUNKS_HELD_PER_SUBSCRIBER_SIMULTANEOUSLY
 
constexpr uint32_t PUBLISHERS_RESERVED_FOR_INTROSPECTION = 5
 
constexpr uint32_t MAX_INTERFACE_NUMBER = build::IOX_MAX_INTERFACE_NUMBER
 
constexpr uint32_t MAX_INTERFACE_CAPRO_FIFO_SIZE = MAX_PUBLISHERS
 
constexpr uint32_t MAX_CHANNEL_NUMBER = MAX_PUBLISHERS + MAX_SUBSCRIBERS
 
constexpr uint32_t MAX_GATEWAY_SERVICES = 2 * MAX_CHANNEL_NUMBER
 
constexpr uint32_t MAX_CLIENTS = build::IOX_MAX_SUBSCRIBERS
 
constexpr uint32_t MAX_REQUESTS_ALLOCATED_SIMULTANEOUSLY = 4U
 
constexpr uint32_t MAX_RESPONSES_PROCESSED_SIMULTANEOUSLY = 16U
 
constexpr uint32_t MAX_RESPONSE_QUEUE_CAPACITY = 16U
 
constexpr uint32_t MAX_SERVERS = build::IOX_MAX_PUBLISHERS
 
constexpr uint32_t MAX_CLIENTS_PER_SERVER = 256U
 
constexpr uint32_t MAX_REQUESTS_PROCESSED_SIMULTANEOUSLY = 4U
 
constexpr uint32_t MAX_RESPONSES_ALLOCATED_SIMULTANEOUSLY = MAX_REQUESTS_PROCESSED_SIMULTANEOUSLY
 
constexpr uint32_t MAX_REQUEST_QUEUE_CAPACITY = 1024
 
constexpr uint32_t MAX_NUMBER_OF_CONDITION_VARIABLES = 1024U
 
constexpr uint32_t MAX_NUMBER_OF_NOTIFIERS_PER_CONDITION_VARIABLE = 128U
 
constexpr uint32_t MAX_NUMBER_OF_ATTACHMENTS_PER_WAITSET = 128U
 
constexpr uint8_t MAX_NUMBER_OF_EVENT_VARIABLES = 128U
 
constexpr uint8_t MAX_NUMBER_OF_EVENTS_PER_LISTENER = 128U
 
constexpr uint32_t MAX_APPLICATION_CAPRO_FIFO_SIZE = 128U
 
constexpr uint32_t MAX_NUMBER_OF_MEMPOOLS = 32U
 
constexpr uint32_t MAX_SHM_SEGMENTS = 100U
 
constexpr uint32_t MAX_NUMBER_OF_MEMORY_PROVIDER = 8U
 
constexpr uint32_t MAX_NUMBER_OF_MEMORY_BLOCKS_PER_MEMORY_PROVIDER = 64U
 
constexpr uint32_t CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT {8U}
 
constexpr uint32_t CHUNK_NO_USER_HEADER_SIZE {0U}
 
constexpr uint32_t CHUNK_NO_USER_HEADER_ALIGNMENT {1U}
 
constexpr uint32_t ROUDI_MAX_MESSAGES = 5U
 
constexpr uint32_t ROUDI_MESSAGE_SIZE = 512U
 
constexpr uint32_t APP_MAX_MESSAGES = 5U
 
constexpr uint32_t APP_MESSAGE_SIZE = 512U
 
constexpr uint32_t MAX_PROCESS_NUMBER = 300U
 
constexpr uint32_t MAX_NUMBER_OF_INSTANCES = 50U
 
constexpr uint32_t MAX_NODE_NUMBER = 1000U
 
constexpr uint32_t MAX_NODE_PER_PROCESS = 50U
 
constexpr uint32_t MAX_RUNTIME_NAME_LENGTH = MAX_IPC_CHANNEL_NAME_LENGTH
 

Detailed Description

Todo:
this might be needed to be public when the logger is used in templates
Todo:
this might be needed to be public when the logger is used in templates

Variable Documentation

◆ MAX_CHUNKS_ALLOCATED_PER_PUBLISHER_SIMULTANEOUSLY

constexpr uint32_t iox::MAX_CHUNKS_ALLOCATED_PER_PUBLISHER_SIMULTANEOUSLY
constexpr
Initial value:
=
build::IOX_MAX_CHUNKS_ALLOCATED_PER_PUBLISHER_SIMULTANEOUSLY

◆ MAX_CHUNKS_HELD_PER_SUBSCRIBER_SIMULTANEOUSLY

constexpr uint32_t iox::MAX_CHUNKS_HELD_PER_SUBSCRIBER_SIMULTANEOUSLY
constexpr
Initial value:
=
build::IOX_MAX_CHUNKS_HELD_PER_SUBSCRIBER_SIMULTANEOUSLY

◆ MAX_CLIENTS_PER_SERVER

constexpr uint32_t iox::MAX_CLIENTS_PER_SERVER = 256U
constexpr

◆ MAX_INTERFACE_NUMBER

constexpr uint32_t iox::MAX_INTERFACE_NUMBER = build::IOX_MAX_INTERFACE_NUMBER
constexpr

With MAX_SUBSCRIBER_QUEUE_CAPACITY = MAX_CHUNKS_HELD_PER_SUBSCRIBER_SIMULTANEOUSLY we couple the maximum number of chunks a user is allowed to hold with the maximum queue capacity. This allows that a polling user can replace all the held chunks in one execution with all new ones from a completely filled queue. Or the other way round, when we have a contract with the user regarding how many chunks they are allowed to hold, then the queue size needs not be bigger. We can provide this number of newest chunks, more the user would not be allowed to hold anyway

◆ MAX_NUMBER_OF_INSTANCES

constexpr uint32_t iox::MAX_NUMBER_OF_INSTANCES = 50U
constexpr

Maximum number of instances of a given service, which can be found. This limitation is coming due to the fixed capacity of the cxx::vector (This doesn't limit the offered number of instances)

◆ MAX_RECEIVERS_PER_SENDERPORT

constexpr uint32_t iox::MAX_RECEIVERS_PER_SENDERPORT = build::IOX_MAX_SUBSCRIBERS_PER_PUBLISHER
constexpr
Todo:
remove MAX_RECEIVERS_PER_SENDERPORT when the new port building blocks are used

◆ MAX_REQUESTS_ALLOCATED_SIMULTANEOUSLY

constexpr uint32_t iox::MAX_REQUESTS_ALLOCATED_SIMULTANEOUSLY = 4U
constexpr