#include <BasicHeader.h>

Collaboration diagram for BasicHeader:

Public Types
enum	e_helper { helper_size = 4 }
	The e_helper enum is used to help to have sizes. More...

enum	e_nextHeader { nextHeader_any = 0, nextHeader_commonHeader = 1, nextHeader_securedPacket = 2 }
	The e_nextHeader enum defines the Next header values. More...

Public Member Functions
	BasicHeader ()
	BasicHeader BasicHeader constructor. More...

	BasicHeader (quint8 version, enum e_nextHeader nextHeader, LifeTime lifeTime, quint8 rhl)
	BasicHeader BasicHeader initialization constructor. More...

	BasicHeader (quint8 version_nextHeader, LifeTime lifeTime, quint8 rhl)
	BasicHeader BasicHeader initialization constructor. More...

	BasicHeader (uchar *)
	BasicHeader BasicHeader initialization constructor. More...

	BasicHeader (const BasicHeader &other)
	BasicHeader BasicHeader copy constructor. More...

	BasicHeader (sniff_basicHeader_t bh)
	BasicHeader BasicHeader initialization constructor. More...

quint8	version () const
	version Version field getter. More...

quint8	nextHeader () const
	nextHeader Next header field getter. More...

LifeTime	lifeTime () const
	lifeTime Life time field getter. More...

quint8	rhl () const
	rhl Router hop limit field getter. More...

void	setVersion (quint8 v)
	setVersion Version field setter. More...

void	setNextHeader (enum e_nextHeader n)
	setNextHeader Next header field setter. More...

void	setVersionNextHeader (quint8 vnh)
	setVersionNextHeader Version + Next header fields setter. More...

void	setLifeTime (LifeTime l)
	setLifeTime Life time field setter. More...

void	setRHL (quint8 r)
	setRHL Router hop limit field setter. More...

QByteArray	toHex ()
	toHex Byte array translator More...

Private Attributes
quint8	m_version_nextHeader

quint8	m_reserved

LifeTime	m_lifeTime

quint8	m_rhl

Detailed Description

Definition at line 33 of file BasicHeader.h.

Member Enumeration Documentation

◆ e_helper

enum BasicHeader::e_helper

The e_helper enum is used to help to have sizes.

Enumerator
helper_size	Size of the BH in bytes.

Definition at line 41 of file BasicHeader.h.

◆ e_nextHeader

enum BasicHeader::e_nextHeader

The e_nextHeader enum defines the Next header values.

Enumerator
nextHeader_any	Next header is the default (i.e. CH).
nextHeader_commonHeader	Next header is a CH.
nextHeader_securedPacket	Next header is a secured packet.

Definition at line 49 of file BasicHeader.h.

Constructor & Destructor Documentation

◆ BasicHeader() [1/6]

BasicHeader::BasicHeader ( )

BasicHeader BasicHeader constructor.

Definition at line 3 of file BasicHeader.cpp.

References itsGnProtocolVersion, m_lifeTime, m_reserved, m_rhl, m_version_nextHeader, and nextHeader_any.

◆ BasicHeader() [2/6]

BasicHeader::BasicHeader	(	quint8	version,
		enum e_nextHeader	nextHeader,
		LifeTime	lifeTime,
		quint8	rhl
	)

BasicHeader BasicHeader initialization constructor.

Parameters

version	Version field.
nextHeader	Next header field.
lifeTime	Life time field.
rhl	Router hop limit field.

Definition at line 11 of file BasicHeader.cpp.

References lifeTime(), m_lifeTime, m_reserved, m_rhl, m_version_nextHeader, nextHeader(), rhl(), and version().

Here is the call graph for this function:

◆ BasicHeader() [3/6]

BasicHeader::BasicHeader	(	quint8	version_nextHeader,
		LifeTime	lifeTime,
		quint8	rhl
	)

BasicHeader BasicHeader initialization constructor.

Parameters

version_nextHeader	Version + Next header fields.
lifeTime	Life time field.
rhl	Router hop limit field.

Definition at line 19 of file BasicHeader.cpp.

References lifeTime(), m_lifeTime, m_reserved, m_rhl, m_version_nextHeader, and rhl().

Here is the call graph for this function:

◆ BasicHeader() [4/6]

BasicHeader::BasicHeader ( uchar * )

BasicHeader BasicHeader initialization constructor.

◆ BasicHeader() [5/6]

BasicHeader::BasicHeader ( const BasicHeader & other )

BasicHeader BasicHeader copy constructor.

Parameters

other The BasicHeader to copy.

Definition at line 27 of file BasicHeader.cpp.

References m_lifeTime, m_reserved, m_rhl, and m_version_nextHeader.

◆ BasicHeader() [6/6]

BasicHeader::BasicHeader ( sniff_basicHeader_t bh )

BasicHeader BasicHeader initialization constructor.

Parameters

bh	The C structure of BH.

Definition at line 35 of file BasicHeader.cpp.

References sniff_basicHeader_s::lifeTime, m_lifeTime, m_reserved, m_rhl, m_version_nextHeader, sniff_basicHeader_s::rhl, and sniff_basicHeader_s::version_nextHeader.

Member Function Documentation

◆ lifeTime()

LifeTime BasicHeader::lifeTime ( ) const

inline

lifeTime Life time field getter.

Returns: The life time field.

Definition at line 105 of file BasicHeader.h.

References m_lifeTime.

Referenced by BasicHeader(), GeoNet::checkUCFPB(), HistoryPacketEntry::execute(), CBFPacketEntry::execute(), UnicastForwardingPacketEntry::isTimeout(), PacketBuffersEntry::isTimeout(), and CBFPacketEntry::sendPacket().

Here is the caller graph for this function:

◆ nextHeader()

quint8 BasicHeader::nextHeader ( ) const

inline

nextHeader Next header field getter.

Returns: The next header field.

Definition at line 100 of file BasicHeader.h.

References m_version_nextHeader.

Referenced by BasicHeader(), GeoNet::basicHeaderProcessing(), and GeoNet::gucPacketProcessing().

Here is the caller graph for this function:

◆ rhl()

quint8 BasicHeader::rhl ( ) const

inline

rhl Router hop limit field getter.

Returns: The router hop limit.

Definition at line 110 of file BasicHeader.h.

References m_rhl.

Referenced by BasicHeader(), GeoNet::commonHeaderProcessing(), CBFPacketEntry::execute(), GeoNet::gacPacketProcessing(), GeoNet::gbcPacketProcessing(), GeoNet::gucPacketProcessing(), GeoNet::LSReplyPacketProcessing(), GeoNet::LSRequestPacketProcessing(), and GeoNet::tsbPacketProcessing().

Here is the caller graph for this function:

◆ setLifeTime()

void BasicHeader::setLifeTime ( LifeTime l )

inline

setLifeTime Life time field setter.

Parameters

l	The new life time.

Definition at line 132 of file BasicHeader.h.

References m_lifeTime.

Referenced by GeoNet::checkUCFPB(), and CBFPacketEntry::sendPacket().

Here is the caller graph for this function:

◆ setNextHeader()

void BasicHeader::setNextHeader ( enum e_nextHeader n )

inline

setNextHeader Next header field setter.

Parameters

n	The new next header.

Definition at line 122 of file BasicHeader.h.

References m_version_nextHeader.

◆ setRHL()

void BasicHeader::setRHL ( quint8 r )

inline

setRHL Router hop limit field setter.

Parameters

r	The new RHL.

Definition at line 137 of file BasicHeader.h.

References m_rhl.

Referenced by GeoNet::commonHeaderProcessing().

Here is the caller graph for this function:

◆ setVersion()

void BasicHeader::setVersion ( quint8 v )

inline

setVersion Version field setter.

Parameters

v	The new version.

Definition at line 117 of file BasicHeader.h.

References m_version_nextHeader.

◆ setVersionNextHeader()

void BasicHeader::setVersionNextHeader ( quint8 vnh )

inline

setVersionNextHeader Version + Next header fields setter.

Parameters

vnh	The new version and next header.

Definition at line 127 of file BasicHeader.h.

References m_version_nextHeader.

◆ toHex()

QByteArray BasicHeader::toHex ( )

toHex Byte array translator

Returns: The translated byte array.

Definition at line 43 of file BasicHeader.cpp.

References LifeTime::helper_size, m_lifeTime, m_reserved, m_rhl, m_version_nextHeader, and LifeTime::toHex().

Referenced by GeoNet::checkUCFPB(), GeoNet::getSecuredPayload(), and GeoNet::send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ version()

quint8 BasicHeader::version ( ) const

inline

version Version field getter.

Returns: The version field.

Definition at line 95 of file BasicHeader.h.

References m_version_nextHeader.

Referenced by BasicHeader(), GeoNet::basicHeaderProcessing(), GeoNet::beaconPacketProcessing(), GeoNet::gacPacketProcessing(), GeoNet::gbcPacketProcessing(), GeoNet::gucPacketProcessing(), GeoNet::LSReplyPacketProcessing(), GeoNet::LSRequestPacketProcessing(), GeoNet::shbPacketProcessing(), and GeoNet::tsbPacketProcessing().

Here is the caller graph for this function:

Member Data Documentation

◆ m_lifeTime

LifeTime BasicHeader::m_lifeTime

private

Life time field.

Definition at line 149 of file BasicHeader.h.

Referenced by BasicHeader(), lifeTime(), setLifeTime(), and toHex().

◆ m_reserved

quint8 BasicHeader::m_reserved

private

Reserved field.

Definition at line 148 of file BasicHeader.h.

Referenced by BasicHeader(), and toHex().

◆ m_rhl

quint8 BasicHeader::m_rhl

private

Router hop limit field.

Definition at line 150 of file BasicHeader.h.

Referenced by BasicHeader(), rhl(), setRHL(), and toHex().

◆ m_version_nextHeader

quint8 BasicHeader::m_version_nextHeader

private

Version + Next header fields.

Definition at line 147 of file BasicHeader.h.

Referenced by BasicHeader(), nextHeader(), setNextHeader(), setVersion(), setVersionNextHeader(), toHex(), and version().

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

network/include/BasicHeader.h
network/src/BasicHeader.cpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ e_helper

◆ e_nextHeader

Constructor & Destructor Documentation

◆ BasicHeader() [1/6]

◆ BasicHeader() [2/6]

◆ BasicHeader() [3/6]

◆ BasicHeader() [4/6]

◆ BasicHeader() [5/6]

◆ BasicHeader() [6/6]

Member Function Documentation

◆ lifeTime()

◆ nextHeader()

◆ rhl()

◆ setLifeTime()

◆ setNextHeader()

◆ setRHL()

◆ setVersion()

◆ setVersionNextHeader()

◆ toHex()

◆ version()

Member Data Documentation

◆ m_lifeTime

◆ m_reserved

◆ m_rhl

◆ m_version_nextHeader