TCPStreamEventHeader Struct Reference

#include <TCPEventStreamDefs.h>

Public Types
enum	StreamDataType { InvalidStream =0, Setup =1, Neutron =2, SE =3 }

Public Member Functions
	TCPStreamEventHeader ()
	TCPStreamEventHeader (uint32_t type_)
bool	isValid () const
uint32_t	majorVersion () const
uint32_t	minorVersion () const

Public Attributes
uint32_t	marker1
	always 0xffffffff More...
uint32_t	marker2
	always 0xffffffff More...
uint32_t	version
	should be TCPStreamEventHeader::current_version More...
uint32_t	length
	this packet size in bytes More...
uint32_t	type
	StreamDataType More...

Static Public Attributes
static const uint32_t	marker = 0xffffffff
	magic value for marker1, marker2 More...
static const uint32_t	major_version = 1
	starts at 1, then incremented whenever layout of this or further packets changes in a non backward compatible way More...
static const uint32_t	minor_version = 0
	reset to 0 in major version change, then incremented whenever layout of this or further packets changes in a backward compatible way More...
static const uint32_t	current_version = (major_version << 16) | minor_version
	starts at 1, then incremented whenever layout of this or further packets changes More...

Detailed Description

this structure is provided at the start of a packet if a stream gets corrupt, you could look for two consecutive 0xffffffff (marker1, marker2) to find a starting point to continue the stream

Definition at line 17 of file TCPEventStreamDefs.h.

Member Enumeration Documentation

enum TCPStreamEventHeader::StreamDataType

Enumerator
InvalidStream
Setup
Neutron
SE

Definition at line 25 of file TCPEventStreamDefs.h.

Constructor & Destructor Documentation

TCPStreamEventHeader::TCPStreamEventHeader ( )

inline

Definition at line 27 of file TCPEventStreamDefs.h.

Referenced by isValid().

TCPStreamEventHeader::TCPStreamEventHeader ( uint32_t  type_ )

inline

Definition at line 28 of file TCPEventStreamDefs.h.

Member Function Documentation

bool TCPStreamEventHeader::isValid ( ) const

inline

Definition at line 29 of file TCPEventStreamDefs.h.

References InvalidStream, length, major_version, majorVersion(), marker, marker1, marker2, minor_version, minorVersion(), TCPStreamEventHeader(), and type.

Referenced by TCPStreamEventDataNeutron::isValid(), TCPStreamEventDataSetup::isValid(), and EventsToolApp::liveData().

uint32_t TCPStreamEventHeader::majorVersion ( ) const

inline

Definition at line 33 of file TCPEventStreamDefs.h.

References version.

Referenced by isValid().

uint32_t TCPStreamEventHeader::minorVersion ( ) const

inline

Definition at line 34 of file TCPEventStreamDefs.h.

References version.

Referenced by isValid().

Member Data Documentation

const uint32_t TCPStreamEventHeader::current_version = (major_version << 16) | minor_version

static

starts at 1, then incremented whenever layout of this or further packets changes

Definition at line 32 of file TCPEventStreamDefs.h.

uint32_t TCPStreamEventHeader::length

this packet size in bytes

Definition at line 22 of file TCPEventStreamDefs.h.

Referenced by isValid(), and EventsToolApp::liveData().

const uint32_t TCPStreamEventHeader::major_version = 1

static

starts at 1, then incremented whenever layout of this or further packets changes in a non backward compatible way

Definition at line 30 of file TCPEventStreamDefs.h.

Referenced by isValid().

const uint32_t TCPStreamEventHeader::marker = 0xffffffff

static

magic value for marker1, marker2

Definition at line 26 of file TCPEventStreamDefs.h.

Referenced by isValid().

uint32_t TCPStreamEventHeader::marker1

always 0xffffffff

Definition at line 19 of file TCPEventStreamDefs.h.

Referenced by isValid().

uint32_t TCPStreamEventHeader::marker2

always 0xffffffff

Definition at line 20 of file TCPEventStreamDefs.h.

Referenced by isValid().

const uint32_t TCPStreamEventHeader::minor_version = 0

static

reset to 0 in major version change, then incremented whenever layout of this or further packets changes in a backward compatible way

Definition at line 31 of file TCPEventStreamDefs.h.

Referenced by isValid().

uint32_t TCPStreamEventHeader::type

StreamDataType

Definition at line 23 of file TCPEventStreamDefs.h.

Referenced by isValid(), TCPStreamEventDataNeutron::isValid(), TCPStreamEventDataSetup::isValid(), and EventsToolApp::liveData().

uint32_t TCPStreamEventHeader::version

should be TCPStreamEventHeader::current_version

Definition at line 21 of file TCPEventStreamDefs.h.

Referenced by majorVersion(), and minorVersion().

---

The documentation for this struct was generated from the following file:

• /isis2/instcontrol_temp/ICP/newicp/TCPEventStreamDefs.h