PacketHeader Class Reference

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

#include <PacketHeader.h>

Inheritance diagram for PacketHeader:

Collaboration diagram for PacketHeader:

Signals
void	signalError (const QString &error_message)

Public Member Functions
	PacketHeader (JackTrip *jacktrip)
	The class Constructor.
virtual	~PacketHeader ()
	The class Destructor.
virtual void	fillHeaderCommonFromAudio ()=0
virtual void	parseHeader ()=0
	Parse the packet header and take appropriate measures (like change settings, or quit the program if peer settings don't match)
virtual void	checkPeerSettings (int8_t *full_packet)=0
virtual uint64_t	getPeerTimeStamp (int8_t *full_packet) const =0
virtual uint16_t	getPeerSequenceNumber (int8_t *full_packet) const =0
virtual uint16_t	getPeerBufferSize (int8_t *full_packet) const =0
virtual uint8_t	getPeerSamplingRate (int8_t *full_packet) const =0
virtual uint8_t	getPeerBitResolution (int8_t *full_packet) const =0
virtual uint8_t	getPeerNumChannels (int8_t *full_packet) const =0
virtual uint8_t	getPeerConnectionMode (int8_t *full_packet) const =0
virtual void	increaseSequenceNumber ()
	Increase sequence number for counter, a 16bit number.
virtual uint16_t	getSequenceNumber () const
	Returns the current sequence number.
virtual int	getHeaderSizeInBytes () const =0
	Get the header size in bytes.
virtual void	putHeaderInPacketBaseClass (int8_t *full_packet, const HeaderStruct &header_struct)
virtual void	putHeaderInPacket (int8_t *full_packet)=0
	Put the header in buffer pointed by full_packet.

Static Public Member Functions
static uint64_t	usecTime ()
	Return a time stamp in microseconds.

Detailed Description

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

Constructor & Destructor Documentation

PacketHeader()

PacketHeader::PacketHeader

(

JackTrip *

jacktrip

)

The class Constructor.

~PacketHeader()

virtual PacketHeader::~PacketHeader ( )

inlinevirtual

The class Destructor.

Member Function Documentation

checkPeerSettings()

virtual void PacketHeader::checkPeerSettings ( int8_t *  full_packet )

pure virtual

Implemented in JamLinkHeader, EmptyHeader, and DefaultHeader.

fillHeaderCommonFromAudio()

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.

getHeaderSizeInBytes()

virtual int PacketHeader::getHeaderSizeInBytes ( ) const

pure virtual

Get the header size in bytes.

Implemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

getPeerBitResolution()

virtual uint8_t PacketHeader::getPeerBitResolution ( int8_t *  full_packet ) const

pure virtual

Implemented in JamLinkHeader, EmptyHeader, and DefaultHeader.

getPeerBufferSize()

virtual uint16_t PacketHeader::getPeerBufferSize ( int8_t *  full_packet ) const

pure virtual

Implemented in JamLinkHeader, EmptyHeader, and DefaultHeader.

getPeerConnectionMode()

virtual uint8_t PacketHeader::getPeerConnectionMode ( int8_t *  full_packet ) const

pure virtual

Implemented in JamLinkHeader, EmptyHeader, and DefaultHeader.

getPeerNumChannels()

virtual uint8_t PacketHeader::getPeerNumChannels ( int8_t *  full_packet ) const

pure virtual

Implemented in JamLinkHeader, EmptyHeader, and DefaultHeader.

getPeerSamplingRate()

virtual uint8_t PacketHeader::getPeerSamplingRate ( int8_t *  full_packet ) const

pure virtual

Implemented in JamLinkHeader, EmptyHeader, and DefaultHeader.

getPeerSequenceNumber()

virtual uint16_t PacketHeader::getPeerSequenceNumber ( int8_t *  full_packet ) const

pure virtual

Implemented in JamLinkHeader, EmptyHeader, and DefaultHeader.

getPeerTimeStamp()

virtual uint64_t PacketHeader::getPeerTimeStamp ( int8_t *  full_packet ) const

pure virtual

Implemented in JamLinkHeader, EmptyHeader, and DefaultHeader.

getSequenceNumber()

virtual uint16_t PacketHeader::getSequenceNumber ( ) const

inlinevirtual

Returns the current sequence number.

Returns

16bit Sequence number

Reimplemented in DefaultHeader.

increaseSequenceNumber()

virtual void PacketHeader::increaseSequenceNumber ( )

inlinevirtual

Increase sequence number for counter, a 16bit number.

Reimplemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

parseHeader()

virtual void PacketHeader::parseHeader ( )

pure virtual

Parse the packet header and take appropriate measures (like change settings, or quit the program if peer settings don't match)

Implemented in DefaultHeader, JamLinkHeader, and EmptyHeader.

putHeaderInPacket()

virtual void PacketHeader::putHeaderInPacket ( int8_t *  full_packet )

pure virtual

Put the header in buffer pointed by full_packet.

Parameters

full_packet

Pointer to full packet (audio+header). Size must be sizeof(header part) + sizeof(audio part)

Implemented in EmptyHeader, DefaultHeader, and JamLinkHeader.

putHeaderInPacketBaseClass()

virtual void PacketHeader::putHeaderInPacketBaseClass ( int8_t *  full_packet, const HeaderStruct &  header_struct  )

inlinevirtual

signalError

void PacketHeader::signalError ( const QString &  error_message )

signal

usecTime()

uint64_t PacketHeader::usecTime ( )

static

Return a time stamp in microseconds.

Returns

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

---

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

• src/PacketHeader.h
• src/PacketHeader.cpp