API reference

These pages show the 88 public types of FairMQ and their members. Doxygen reads the installed headers at each build of this site, so the signatures are always current. The text comes from the comments in the headers.

Each member links to its line in the source browser. Use the search (Ctrl K) to find a class or a member by name.

fair::mq

• AlignmentstructNo comment yet.
• ChannelclassWrapper class for Socket and related methods.
• ChannelResourceclassNo comment yet.
• DeviceclassNo comment yet.
• DeviceErrorStatestructNo comment yet.
• DeviceRunnerclassUtility class to facilitate a convenient top-level device launch/shutdown.
• ErrorCategorystructNo comment yet.
• ErrorCodeenum classNo comment yet.
• EventstructNo comment yet.
• EventManagerclassManages event callbacks from different subscribers.
• is_transferrablestructNo comment yet.
• MemoryResourceclassNo comment yet.
• MessagestructNo comment yet.
• MessageBadAllocstructNo comment yet.
• MessageErrorstructNo comment yet.
• OngoingTransitionstructNo comment yet.
• ParserErrorstructNo comment yet.
• PartsstructNo comment yet.
• PluginclassBase class for FairMQ plugins.
• PluginManagerclassmanages and owns plugin instances
• PluginServicesclassFacilitates communication between devices and plugins.
• PollerstructNo comment yet.
• PollerErrorstructNo comment yet.
• ProgOptionsclassNo comment yet.
• PropertyChangestructNo comment yet.
• PropertyChangeAsStringstructNo comment yet.
• PropertyHelperclassNo comment yet.
• PropertyNotFoundErrorstructNo comment yet.
• RefCountBadAllocstructNo comment yet.
• RegionBlockstructNo comment yet.
• RegionConfigstructNo comment yet.
• RegionEventenum classNo comment yet.
• RegionInfostructNo comment yet.
• RuntimeErrorstructNo comment yet.
• SocketstructNo comment yet.
• SocketErrorstructNo comment yet.
• Stateenum classNo comment yet.
• StateMachineclassNo comment yet.
• StateQueueclassNo comment yet.
• TransferCodeenum classNo comment yet.
• Transitionenum classNo comment yet.
• Transportenum classNo comment yet.
• TransportErrorstructNo comment yet.
• TransportFactoryclassNo comment yet.
• TransportFactoryErrorstructNo comment yet.
• UnmanagedRegionstructNo comment yet.

fair::mq::shmem

• AllocationAlgorithmenum classNo comment yet.
• BufferDebugInfostructNo comment yet.
• DeviceCounterstructNo comment yet.
• EventCounterstructNo comment yet.
• HeartbeatstructNo comment yet.
• ManagerclassNo comment yet.
• MessageclassNo comment yet.
• MetaHeaderstructNo comment yet.
• MonitorclassNo comment yet.
• PollerclassNo comment yet.
• RBTreeBestFitstructNo comment yet.
• RefCountstructNo comment yet.
• RegionBlockstructNo comment yet.
• RegionCounterstructNo comment yet.
• RegionInfostructNo comment yet.
• SegmentstructNo comment yet.
• SegmentBufferShrinkstructNo comment yet.
• SegmentConfigstructNo comment yet.
• SegmentInfostructNo comment yet.
• SessionIdstructNo comment yet.
• SessionInfostructNo comment yet.
• SharedMemoryErrorstructNo comment yet.
• ShmHeaderstructNo comment yet.
• ShmIdstructNo comment yet.
• SimpleSeqFitstructNo comment yet.
• SocketclassNo comment yet.
• TransportFactoryclassNo comment yet.
• UnmanagedRegionstructNo comment yet.
• UnmanagedRegionImplclassNo comment yet.

fair::mq::tools

• CallOnDestructionclassNo comment yet.
• DefaultRouteDetectionErrorstructNo comment yet.
• execute_resultstructNo comment yet.
• InstanceLimiterstructNo comment yet.
• NonCanonicalInputstructNo comment yet.
• RateLimiterclassNo comment yet.
• SemaphorestructA simple blocking semaphore.
• SharedSemaphorestructA simple copyable blocking semaphore.
• VersionstructNo comment yet.