Struct astutedds::rtps::ShmSegmentHeader

Struct astutedds::rtps::ShmSegmentHeader

ClassList > astutedds > rtps > ShmSegmentHeader

Header at the start of each shared memory segment.

  • #include <shm_transport.hpp>

Public Attributes

Type Name
uint32_t magic = {0x534D4453}
"SHDS" magic number
std::atomic< uint64_t > read_idx = {0}
Current read index (per reader)
uint8_t reserved = {}
Reserved for future use.
uint32_t segment_size = {0}
Total segment size.
uint32_t slot_count = {0}
Number of ring buffer slots.
uint32_t slot_size = {0}
Size of each slot.
uint32_t version = {1}
Protocol version.
std::atomic< uint64_t > write_idx = {0}
Current write index.

Public Static Attributes

Type Name
constexpr size_t SIZE = 64

Public Attributes Documentation

variable magic

"SHDS" magic number 

uint32_t astutedds::rtps::ShmSegmentHeader::magic;

variable read_idx

Current read index (per reader) 

std::atomic<uint64_t> astutedds::rtps::ShmSegmentHeader::read_idx;

variable reserved

Reserved for future use. 

uint8_t astutedds::rtps::ShmSegmentHeader::reserved[40];

variable segment_size

Total segment size. 

uint32_t astutedds::rtps::ShmSegmentHeader::segment_size;

variable slot_count

Number of ring buffer slots. 

uint32_t astutedds::rtps::ShmSegmentHeader::slot_count;

variable slot_size

Size of each slot. 

uint32_t astutedds::rtps::ShmSegmentHeader::slot_size;

variable version

Protocol version. 

uint32_t astutedds::rtps::ShmSegmentHeader::version;

variable write_idx

Current write index. 

std::atomic<uint64_t> astutedds::rtps::ShmSegmentHeader::write_idx;

Public Static Attributes Documentation

variable SIZE

constexpr size_t astutedds::rtps::ShmSegmentHeader::SIZE;

The documentation for this class was generated from the following file include/astutedds/rtps/shm_transport.hpp