Rogue

Contents:

  • Installing & Compiling Rogue
  • PyRogue Tree
  • Interfaces
  • Utilities
  • Hardware
  • Protocols
    • UDP Protocol
    • RSSI Protocol
      • RSSI Protocol Client
      • RSSI Protocol Server
      • RSSI Protocol Class Descriptions
        • Client
        • Server
        • Header
        • Controller
        • Application
        • Transport
    • Packetizer Protocol
    • Network Wrapper
    • Batcher Protocol
    • EPICSV4 Protocol
    • SRP Protocol
    • UART Protocol
  • Logging In Rogue
  • Creating Custom Modules
  • Using the PyDM Gui
  • Migration Notes
Rogue
  • Protocols
  • RSSI Protocol
  • RSSI Protocol Class Descriptions
  • Header
  • View page source

Header

TODO

Header objects in C++ are referenced by the following shared pointer typedef:

typedef std::shared_ptr<rogue::protocols::rssi::Header> rogue::protocols::rssi::HeaderPtr

The Header class description is shown below:

class Header

PGP Card class.

Public Functions

explicit Header(std::shared_ptr<rogue::interfaces::stream::Frame> frame)

Creator.

~Header()

Destructor.

std::shared_ptr<rogue::interfaces::stream::Frame> getFrame()

Get Frame.

bool verify()

Verify header checksum. Also inits records.

void update()

Update header with settings and update checksum.

struct timeval &getTime()

Get time.

uint32_t count()

Get Count.

void rstTime()

Reset tx time.

std::string dump()

Dump message contents.

Public Members

bool syn

Syn flag.

bool ack

Ack flag.

bool rst

Rst flag.

bool nul

NUL flag.

bool busy

Busy flag.

uint8_t sequence

Sequence number.

uint8_t acknowledge

Acknowledge number.

uint8_t version

Version field.

bool chk

Chk flag.

uint8_t maxOutstandingSegments

MAX Outstanding Segments.

uint16_t maxSegmentSize

MAX Segment Size.

uint16_t retransmissionTimeout

Retransmission Timeout.

uint16_t cumulativeAckTimeout

Cumulative Acknowledgment Timeout.

uint16_t nullTimeout

NULL Timeout.

uint8_t maxRetransmissions

Max Retransmissions.

uint8_t maxCumulativeAck

MAX Cumulative Ack.

uint8_t timeoutUnit

Timeout Unit.

uint32_t connectionId

Connection ID.

Public Static Functions

static std::shared_ptr<rogue::protocols::rssi::Header> create(std::shared_ptr<rogue::interfaces::stream::Frame> frame)

Create.

Public Static Attributes

static const int32_t HeaderSize = 8

Header Size.

Previous Next

© Copyright 2025, SLAC National Accelerator Laboratory.

Built with Sphinx using a theme provided by Read the Docs.