Public Member Functions | Static Public Member Functions | Private Attributes

PacketHeader Class Reference

Base class for header type. Subclass this struct to create a new header. More...

#include <PacketHeader.h>

Inheritance diagram for PacketHeader:
Inheritance graph
[legend]
Collaboration diagram for PacketHeader:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 PacketHeader (JackTrip *jacktrip)
 The class Constructor.
virtual ~PacketHeader ()
 The class Destructor.
virtual void fillHeaderCommonFromAudio ()=0
virtual void parseHeader ()=0
virtual void checkPeerSettings (int8_t *full_packet)=0
virtual uint16_t getPeerSequenceNumber (int8_t *full_packet) const =0
virtual void increaseSequenceNumber ()
virtual uint16_t getSequenceNumber () const
virtual int getHeaderSizeInBytes () const =0
virtual void putHeaderInPacketBaseClass (int8_t *full_packet, const HeaderStruct &header_struct)
virtual void putHeaderInPacket (int8_t *full_packet)=0

Static Public Member Functions

static uint64_t usecTime ()
 Return a time stamp in microseconds.

Private Attributes

uint16_t mSeqNumber
JackTripmJackTrip
 JackTrip mediator class.

Detailed Description

Base class for header type. Subclass this struct to create a new header.


Constructor & Destructor Documentation

PacketHeader::PacketHeader ( JackTrip jacktrip  ) 

The class Constructor.

virtual PacketHeader::~PacketHeader (  )  [inline, virtual]

The class Destructor.


Member Function Documentation

virtual void PacketHeader::checkPeerSettings ( int8_t full_packet  )  [pure virtual]

Implemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

virtual void PacketHeader::fillHeaderCommonFromAudio (  )  [pure virtual]
Todo:
Implement this using a JackTrip Method (Mediator) member instead of the reference to JackAudio

Implemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

virtual int PacketHeader::getHeaderSizeInBytes (  )  const [pure virtual]

Implemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

virtual uint16_t PacketHeader::getPeerSequenceNumber ( int8_t full_packet  )  const [pure virtual]

Implemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

virtual uint16_t PacketHeader::getSequenceNumber (  )  const [inline, virtual]

Reimplemented in DefaultHeader.

virtual void PacketHeader::increaseSequenceNumber (  )  [inline, virtual]

Reimplemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

virtual void PacketHeader::parseHeader (  )  [pure virtual]

Implemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

virtual void PacketHeader::putHeaderInPacket ( int8_t full_packet  )  [pure virtual]

Implemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

virtual void PacketHeader::putHeaderInPacketBaseClass ( int8_t full_packet,
const HeaderStruct header_struct 
) [inline, virtual]
uint64_t PacketHeader::usecTime (  )  [static]

Return a time stamp in microseconds.

Returns:
Time stamp: microseconds since midnight (0 hour), January 1, 1970

Member Data Documentation

JackTrip mediator class.

Reimplemented in DefaultHeader, JamLinkHeader, and EmptyHeader.


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