#include <HdlcdSessionHeader.h>

Inheritance diagram for HdlcdSessionHeader:

Collaboration diagram for HdlcdSessionHeader:

Public Member Functions
uint8_t	GetServiceAccessPointSpecifier () const
	Query the service access point specifier octett. More...

const std::string &	GetSerialPortName () const
	Query the file name of the serial port. More...

Public Member Functions inherited from Frame
	Frame ()
	The constructor of Frame objects. More...

virtual	~Frame ()
	The destructor of Frame objects. More...

size_t	BytesNeeded () const
	Query the amount of outstanding data during reception for frame assembly. More...

bool	ParseBytes (const unsigned char *a_ReadBuffer, size_t &a_ReadBufferOffset, size_t &a_BytesAvailable)
	Deliver a chunk of received bytes in the phase of deserialization. More...

Static Public Member Functions
static HdlcdSessionHeader	Create (HdlcdSessionDescriptor a_HdlcdSessionDescriptor, const std::string &a_SerialPortName)
	Static creator to create an object in the process of transmission. More...

static std::shared_ptr< HdlcdSessionHeader >	CreateDeserializedFrame ()
	Static creator to create an object in the process of reception. More...

Additional Inherited Members
Protected Attributes inherited from Frame
std::vector< unsigned char >	m_Buffer
	The buffer containing partly received frames or higher-layer payload. More...

size_t	m_BytesRemaining
	The amount of bytes required to finalize frame assembly during reception. More...

Detailed Description

Class HdlcdSessionHeader.

This class implements the session header as specified in the HDLCd access protocol. It inherits from the Frame class and thus allows easy exchange via FrameEndpoint entities.

Definition at line 53 of file HdlcdSessionHeader.h.

Member Function Documentation

static HdlcdSessionHeader HdlcdSessionHeader::Create	(	HdlcdSessionDescriptor	a_HdlcdSessionDescriptor,
		const std::string &	a_SerialPortName
	)

inlinestatic

Static creator to create an object in the process of transmission.

Parameters

a_HdlcdSessionDescriptor	the service access point specifier octett
a_SerialPortName	the file name of the serial port

Returns: The created HDLCd session header object

Definition at line 62 of file HdlcdSessionHeader.h.

Here is the caller graph for this function:

static std::shared_ptr<HdlcdSessionHeader> HdlcdSessionHeader::CreateDeserializedFrame ( )

inlinestatic

Static creator to create an object in the process of reception.

Returns: The created but empty HDLCd session header object

Definition at line 74 of file HdlcdSessionHeader.h.

Here is the caller graph for this function:

const std::string& HdlcdSessionHeader::GetSerialPortName ( ) const

inline

Query the file name of the serial port.

Returns: The file name of the serial port

Definition at line 95 of file HdlcdSessionHeader.h.

uint8_t HdlcdSessionHeader::GetServiceAccessPointSpecifier ( ) const

inline

Query the service access point specifier octett.

Returns: The service access point specifier octett

Definition at line 86 of file HdlcdSessionHeader.h.

Here is the caller graph for this function:

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

libs/hdlcd-devel/src/HdlcdSessionHeader.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation