HdlcdSessionDescriptor Class Reference

Class HdlcdSessionDescriptor. More...

#include <HdlcdSessionDescriptor.h>

Public Member Functions
	HdlcdSessionDescriptor (E_SESSION_TYPE a_eSessionType, uint8_t a_SessionFlags)
	The constructor of HdlcdSessionDescriptor objects. More...
	HdlcdSessionDescriptor (uint8_t a_ServiceAccessPointSpecifier)
	The constructor of HdlcdSessionDescriptor objects. More...
	operator uint8_t () const
	Query the service access point specifier octett. More...
E_SESSION_TYPE	GetSessionType () const
	Query the session type. More...
bool	DeliversRcvdData () const
	Query whether data packets sent by a device to the HDLCd should be delivered. More...
bool	DeliversSentData () const
	Query whether data packets sent by the HDLCd to a device should be delivered. More...
bool	DeliversInvalidData () const
	Query whether invalid data packets with a broken CRC checksum should be delivered. More...

Detailed Description

Class HdlcdSessionDescriptor.

This is a convenience class to assemble the service access point specifier byte (SAP) of the HDLCd access protocol. The use of enums allows a human-readable specification of sessions.

Definition at line 89 of file HdlcdSessionDescriptor.h.

Constructor & Destructor Documentation

HdlcdSessionDescriptor::HdlcdSessionDescriptor ( E_SESSION_TYPE  a_eSessionType, uint8_t  a_SessionFlags  )

inline

The constructor of HdlcdSessionDescriptor objects.

This constructor is used to assemble the service access point specifier as a combination of enums

Parameters

a_eSessionType	the session type enum
a_SessionFlags	a combination of E_SESSION_FLAGS enums

Definition at line 98 of file HdlcdSessionDescriptor.h.

HdlcdSessionDescriptor::HdlcdSessionDescriptor ( uint8_t  a_ServiceAccessPointSpecifier )

inlineexplicit

The constructor of HdlcdSessionDescriptor objects.

This constructor is used to parse the service access point specifier using the assembled octett

Parameters

a_ServiceAccessPointSpecifier

the service access point specifier octett

Definition at line 118 of file HdlcdSessionDescriptor.h.

Member Function Documentation

bool HdlcdSessionDescriptor::DeliversInvalidData ( ) const

inline

Query whether invalid data packets with a broken CRC checksum should be delivered.

Return values

true	invalid data packets with a broken CRC checksum should be delivered
false	invalid data packets with a broken CRC checksum should be ignored

Returns

Indicates whether invalid data packets with a broken CRC checksum should be delivered or ignored

Definition at line 168 of file HdlcdSessionDescriptor.h.

bool HdlcdSessionDescriptor::DeliversRcvdData ( ) const

inline

Query whether data packets sent by a device to the HDLCd should be delivered.

Return values

true	data packets received from the HDLCd should be delivered
false	data packets received from the HDLCd should be ignored

Returns

Indicates whether data packets received from the HDLCd should be delivered or ignored

Definition at line 148 of file HdlcdSessionDescriptor.h.

bool HdlcdSessionDescriptor::DeliversSentData ( ) const

inline

Query whether data packets sent by the HDLCd to a device should be delivered.

Return values

true	data packets sent to a device should be delivered
false	data packets sent to a device should be ignored

Returns

Indicates whether data packets sent to a device should be delivered or ignored

Definition at line 158 of file HdlcdSessionDescriptor.h.

E_SESSION_TYPE HdlcdSessionDescriptor::GetSessionType ( ) const

inline

Query the session type.

Returns

The session type

Definition at line 138 of file HdlcdSessionDescriptor.h.

HdlcdSessionDescriptor::operator uint8_t ( ) const

inline

Query the service access point specifier octett.

Returns

The service access point specifier octett

Definition at line 130 of file HdlcdSessionDescriptor.h.

---

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

• libs/hdlcd-devel/src/HdlcdSessionDescriptor.h