Application Programming Interface

The ska-pst-smrb library provides a Shared Memory Ring Buffer API that is used by the applications. This API is described below.

Class Hierarchy

• • Namespace ska
    • Namespace ska::pst
      • Namespace ska::pst::smrb
        • Class DataBlock
        • Class DataBlockAccessor
        • Class DataBlockCreate
        • Class DataBlockManager
        • Class DataBlockRead
        • Class DataBlockStats
          • Struct DataBlockStats::stats
        • Class DataBlockView
        • Class DataBlockWrite
        • Class SmrbBlockProducer
        • Class SmrbSegmentProducer
        • Enum State

File Hierarchy

• • Directory src
    • Directory ska
      • Directory pst
        • Directory smrb
          • File DataBlock.h
          • File DataBlockAccessor.h
          • File DataBlockCreate.h
          • File DataBlockManager.h
          • File DataBlockRead.h
          • File DataBlockStats.h
          • File DataBlockView.h
          • File DataBlockWrite.h
          • File SmrbBlockProducer.h
          • File SmrbSegmentProducer.h
          • File version.h

Full API

Namespaces

• Namespace ska
  • Namespaces

• Namespace ska::pst
  • Namespaces

• Namespace ska::pst::common

• Namespace ska::pst::smrb
  • Classes
  • Enums
  • Functions

Classes and Structs

• Struct DataBlockStats::stats
  • Nested Relationships
  • Struct Documentation

• Class DataBlock
  • Inheritance Relationships
    • Derived Types
  • Class Documentation

• Class DataBlockAccessor
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation

• Class DataBlockCreate
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class DataBlockManager
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class DataBlockRead
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class DataBlockStats
  • Nested Relationships
    • Nested Types
  • Class Documentation

• Class DataBlockView
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class DataBlockWrite
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class SmrbBlockProducer
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class SmrbSegmentProducer
  • Inheritance Relationships
    • Base Type
  • Class Documentation

Enums

• Enum State
  • Enum Documentation

Functions

• Function ska::pst::smrb::get_version_string
  • Function Documentation