packing::RogueFrameHeader Class Reference

the header that the Rogue StreamWriter puts includes at the beginning of each frame. More...

#include <RogueFrameHeader.h>

Public Member Functions
utility::Reader &	read (utility::Reader &r)
	read the next rogue frame header into memory
int	channel () const
	get the channel this data was written to
unsigned int	size () const
	get the size of the frame not including this header
uint16_t	flags () const
	get the flags included in the header
uint8_t	error () const
	get specifc error flags included in the header
uint8_t	trailer () const
	get the trailer byte for checking
bool	probablyYaml () const
	check if this frame is probably a yaml dump

Private Attributes
uint32_t	size_
	size of frame written by StreamWriter
uint16_t	flags_
	extra flags written by StreamWriter
uint8_t	error_
	error flags written by StreamWriter
uint8_t	channel_
	StreamWriter channel.
uint8_t	trailer_
	last byte stored in frame

Detailed Description

the header that the Rogue StreamWriter puts includes at the beginning of each frame.

Definition at line 16 of file RogueFrameHeader.h.

Member Function Documentation

channel()

int packing::RogueFrameHeader::channel ( ) const

inline

get the channel this data was written to

Definition at line 21 of file RogueFrameHeader.h.

{ return channel_; }

References channel_.

error()

uint8_t packing::RogueFrameHeader::error ( ) const

inline

get specifc error flags included in the header

Definition at line 27 of file RogueFrameHeader.h.

{ return error_; }

References error_.

flags()

uint16_t packing::RogueFrameHeader::flags ( ) const

inline

get the flags included in the header

Definition at line 25 of file RogueFrameHeader.h.

{ return flags_; }

References flags_.

probablyYaml()

bool packing::RogueFrameHeader::probablyYaml ( ) const

inline

check if this frame is probably a yaml dump

Definition at line 31 of file RogueFrameHeader.h.

{ return trailer_ == 0x0a; }

References trailer_.

read()

utility::Reader & packing::RogueFrameHeader::read

(

utility::Reader &

r

)

read the next rogue frame header into memory

Definition at line 5 of file RogueFrameHeader.cxx.

                                                      {
  if (!(r >> size_ >> flags_ >> error_ >> channel_)) {
    return r;
  }
 
  // subtract 4 from size since 4 bytes after
  // the bytes holding size have been read
  size_ -= 4;
 
  int frame_start = r.tell();
  r.seek(frame_start + size_ - 1);
  r >> trailer_;
  // reset back to beginning of frame
  r.seek(frame_start);
 
  return r;
}

References channel_, error_, flags_, packing::utility::Reader::seek(), size_, packing::utility::Reader::tell(), and trailer_.

size()

unsigned int packing::RogueFrameHeader::size ( ) const

inline

get the size of the frame not including this header

Definition at line 23 of file RogueFrameHeader.h.

{ return size_; }

References size_.

trailer()

uint8_t packing::RogueFrameHeader::trailer ( ) const

inline

get the trailer byte for checking

Definition at line 29 of file RogueFrameHeader.h.

{ return trailer_; }

References trailer_.

Member Data Documentation

channel_

uint8_t packing::RogueFrameHeader::channel_

private

StreamWriter channel.

Definition at line 48 of file RogueFrameHeader.h.

Referenced by channel(), and read().

error_

uint8_t packing::RogueFrameHeader::error_

private

error flags written by StreamWriter

Definition at line 46 of file RogueFrameHeader.h.

Referenced by error(), and read().

flags_

uint16_t packing::RogueFrameHeader::flags_

private

extra flags written by StreamWriter

Definition at line 44 of file RogueFrameHeader.h.

Referenced by flags(), and read().

size_

uint32_t packing::RogueFrameHeader::size_

private

size of frame written by StreamWriter

The number written on disk is 4 more than the number we store here for later use because the number on disk does not include the other 4 bytes we parse into the other members below.

Definition at line 42 of file RogueFrameHeader.h.

Referenced by read(), and size().

trailer_

uint8_t packing::RogueFrameHeader::trailer_

private

last byte stored in frame

we need to check the trailer byte as well since many of the early runs took data with both the data and yaml-dump of the config stored in the same channel

The yaml-dump has a characteristic trailer byte 0x0a

Definition at line 58 of file RogueFrameHeader.h.

Referenced by probablyYaml(), read(), and trailer().

---

The documentation for this class was generated from the following files:

• Packing/include/Packing/RogueFrameHeader.h
• Packing/src/Packing/RogueFrameHeader.cxx