This file contains the header declaration of class HdlcdSessionDescriptor. More...

#include <stdint.h>

Include dependency graph for HdlcdSessionDescriptor.h:

This graph shows which files directly or indirectly include this file:

Classes
class	HdlcdSessionDescriptor
	Class HdlcdSessionDescriptor. More...

Enumerations
enum	E_SESSION_TYPE { SESSION_TYPE_TRX_ALL = 0x00, SESSION_TYPE_TRX_STATUS = 0x10, SESSION_TYPE_RX_PAYLOAD = 0x20, SESSION_TYPE_RX_HDLC = 0x30, SESSION_TYPE_RX_HDLC_DISSECTED = 0x40, SESSION_TYPE_ARITHMETIC_ENDMARKER = 0x50, SESSION_TYPE_MASK = 0xF0, SESSION_TYPE_UNSET = 0xFF }
	The enum E_SESSION_TYPE to specify all possible session types. More...

enum	E_SESSION_FLAGS { SESSION_FLAGS_NONE = 0x00, SESSION_FLAGS_DELIVER_RCVD = 0x01, SESSION_FLAGS_DELIVER_SENT = 0x02, SESSION_FLAGS_DELIVER_INVALIDS = 0x04, SESSION_FLAGS_RESERVED = 0x08, SESSION_FLAGS_MASK = 0x0F }
	The enum E_SESSION_FLAGS to specify all possible session flags. More...

Detailed Description

This file contains the header declaration of class HdlcdSessionDescriptor.

Author: Florian Evers, flori.nosp@m.an-e.nosp@m.vers@.nosp@m.gmx..nosp@m.de

Copyright: BSD 3 Clause licence

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

(1) Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer. 

(2) Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.  

(3)The name of the author may not be used to
endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file HdlcdSessionDescriptor.h.

Enumeration Type Documentation

enum E_SESSION_FLAGS

The enum E_SESSION_FLAGS to specify all possible session flags.

This enum specifies the set of available session flags according to the HDLCd access protocol. Multiple combination of flags are possible

Enumerator
SESSION_FLAGS_NONE	Empty list of flags.
SESSION_FLAGS_DELIVER_RCVD	Deliver data packets sent by the device and received by the HDLCd.
SESSION_FLAGS_DELIVER_SENT	Deliver data packets sent by the HDLCd and received by the device.
SESSION_FLAGS_DELIVER_INVALIDS	Deliver also invalid frames with broken CRC checksum.
SESSION_FLAGS_RESERVED	Reserved bit.
SESSION_FLAGS_MASK	Bit mask to query the session flags.

Definition at line 70 of file HdlcdSessionDescriptor.h.

enum E_SESSION_TYPE

The enum E_SESSION_TYPE to specify all possible session types.

This enum specifies the set of available session types according to the HDLCd access protocol.

Enumerator
SESSION_TYPE_TRX_ALL	Payload, data read and write, port status read and write.
SESSION_TYPE_TRX_STATUS	Port status only, no data exchange, port status read and write.
SESSION_TYPE_RX_PAYLOAD	Payload Raw, data read only, port status read only.
SESSION_TYPE_RX_HDLC	HDLC Raw, data read only, port status read only.
SESSION_TYPE_RX_HDLC_DISSECTED	HDLC dissected, data read only, port status read only.
SESSION_TYPE_ARITHMETIC_ENDMARKER	The lowest invalid session type number.
SESSION_TYPE_MASK	Bit mask to query the session type.
SESSION_TYPE_UNSET	Invalid entry, to indicate unset state.

Definition at line 49 of file HdlcdSessionDescriptor.h.

Classes

Enumerations

Detailed Description

Enumeration Type Documentation