Abstract ISDN layer 2 (Q.921) message transport. More...

#include <yatesig.h>

Inheritance diagram for ISDNLayer2:

Public Types
enum	State { Released, WaitEstablish, Established, WaitRelease }
Public Member Functions
virtual	~ISDNLayer2 ()
ISDNLayer3 *	layer3 () const
State	state () const
bool	network () const
bool	detectType () const
u_int8_t	localSapi () const
u_int8_t	localTei () const
u_int32_t	maxUserData () const
bool	teiAssigned () const
bool	autoRestart () const
unsigned int	upTime () const
virtual bool	multipleFrame (u_int8_t tei, bool establish, bool force)
virtual bool	sendData (const DataBlock &data, u_int8_t tei, bool ack)
virtual void	cleanup ()=0
virtual void	attach (ISDNLayer3 *layer3)
Static Public Member Functions
static const char *	stateName (State s)
Protected Member Functions
	ISDNLayer2 (const NamedList &params, const char *name=0, u_int8_t tei=0)
Mutex &	l2Mutex ()
void	multipleFrameEstablished (u_int8_t tei, bool confirm, bool timeout)
void	multipleFrameReleased (u_int8_t tei, bool confirm, bool timeout)
void	dataLinkState (u_int8_t tei, bool cmd, bool value)
void	idleTimeout ()
void	receiveData (const DataBlock &data, u_int8_t tei)
void	teiAssigned (bool status)
void	changeState (State newState, const char *reason=0)
bool	changeType ()
void	autoRestart (bool restart)
void	setRi (u_int16_t ri)
ISDNFrame *	parsePacket (const DataBlock &packet)
Friends
class	ISDNQ921Management

Detailed Description

Abstract ISDN layer 2 (Q.921) message transport.

An interface to a Layer 2 (Q.921) ISDN message transport

Member Enumeration Documentation

enum State

Layer states if it has a TEI assigned

Constructor & Destructor Documentation

virtual ~ISDNLayer2 ( ) [virtual]

Destructor

ISDNLayer2	(	const NamedList &	params,
		const char *	name = `0`,
		u_int8_t	tei = `0`
	)		`[protected]`

Constructor Initialize this interface and the component

Parameters:

params	Layer's parameters
name	Optional name of the component
tei	Value of TEI for this layer

Member Function Documentation

virtual void attach ( ISDNLayer3 * layer3 ) [virtual]

Attach an ISDN Q.931 Layer 3 if the given parameter is different from the one we have Cleanup the object before ataching the new Layer 3 This method is thread safe

Parameters:

layer3 Pointer to the Q.931 Layer 3 to attach

Referenced by ISDNQ921::destroyed(), and ISDNQ921Passive::destroyed().

bool autoRestart ( ) const [inline]

Check if this interface will automatically re-establish when released

Returns:: The auto restart flag

void autoRestart ( bool restart ) [inline, protected]

Set the automatically re-establish when released flag

Parameters:

restart The new value of the auto restart flag

void changeState	(	State	newState,
		const char *	reason = `0`
	)		`[protected]`

Set the state Descendants are responsable for multiple frame status management

Parameters:

newState	The new state
reason	Reason of state change, NULL if unspecified

bool changeType ( ) [protected]

Change the interface type

Returns:: True if interface type changed

virtual void cleanup ( ) [pure virtual]

Emergency release. Descendants must implement this method to cleanup/reset data

Implemented in ISDNIUA, ISDNQ921Passive, ISDNQ921Management, and ISDNQ921.

void dataLinkState	(	u_int8_t	tei,
		bool	cmd,
		bool	value
	)		`[protected]`

Notify layer 3 of data link set/release command or response Used for stateless layer 2

Parameters:

tei	The TEI of this layer
cmd	True if received a command, false if received a response
value	The value of the notification If 'cmd' is true (command), the value is true if a request to establish data link was received or false if received a request to release data link If 'cmd' is false (response), the value is the response

bool detectType ( ) const [inline]

Check if this interface should change its type

Returns:: True if type change is allowed

void idleTimeout ( ) [protected]

Notify layer 3 of data link idle timeout Used for stateless layer 2

Mutex& l2Mutex ( ) [inline, protected]

Retrieve the layer's mutex

Returns:: Reference to the Layer 2 mutex

ISDNLayer3* layer3 ( ) const [inline]

Get the ISDN Layer 3 attached to this layer

u_int8_t localSapi ( ) const [inline]

Get the SAPI (Service Access Point Identifier) of this interface

Returns:: The SAPI (Service Access Point Identifier) of this interface

u_int8_t localTei ( ) const [inline]

Get the TEI (Terminal Endpoint Identifier) of this interface

Returns:: The TEI (Terminal Endpoint Identifier) of this interface

u_int32_t maxUserData ( ) const [inline]

Get the maximum length of user data transported through this layer

Returns:: The maximum length of user data transported through this layer

virtual bool multipleFrame	(	u_int8_t	tei,
		bool	establish,
		bool	force
	)		`[inline, virtual]`

Implements Q.921 DL-ESTABLISH and DL-RELEASE request primitives Descendants must implement this method to fullfill the request

Parameters:

tei	This layer TEI (Terminal Endpoint Identifier)
establish	True to establish. False to release
force	True to establish even if we already are in this mode. This parameter is ignored if establish is false

Returns:: True if the request was accepted

Reimplemented in ISDNIUA, ISDNQ921Management, and ISDNQ921.

void multipleFrameEstablished	(	u_int8_t	tei,
		bool	confirm,
		bool	timeout
	)		`[protected]`

Implements Q.921 DL-ESTABLISH indication/confirmation primitive of 'multiple frame acknowledged' mode established

Parameters:

tei	The TEI requested
confirm	True if this is a confirmation of a previous request. False if it is an indication of state change on remote request
timeout	True if the reason is a timeout.

void multipleFrameReleased	(	u_int8_t	tei,
		bool	confirm,
		bool	timeout
	)		`[protected]`

Implements Q.921 DL-RELEASE indication/confirmation primitive of 'multiple frame acknowledged' mode released

Parameters:

tei	The TEI released
confirm	True if this is a confirmation of a previous request. False if it is an indication of state change on remote request
timeout	True if the reason is a timeout.

bool network ( ) const [inline]

Check if this interface is the network or CPE (user) side of the link

Returns:: True if this interface is the network side of the link

ISDNFrame* parsePacket ( const DataBlock & packet ) [protected]

Parse a received packet

Parameters:

packet The packet received

Returns:: Pointer to a newly created frame, NULL if an error occured

void receiveData	(	const DataBlock &	data,
		u_int8_t	tei
	)		`[protected]`

Implements Q.921 DL-DATA and DL-UNIT DATA indication primitives Receive data from remote peer

Parameters:

data	Received data
tei	The TEI for which the data was received

virtual bool sendData	(	const DataBlock &	data,
		u_int8_t	tei,
		bool	ack
	)		`[inline, virtual]`

Implements Q.921 DL-DATA and DL-UNIT DATA request primitives Descendants must implement this method to fullfill the request

Parameters:

data	Data to send
tei	This layer TEI
ack	True to send an acknowledged frame, false to send an unacknowledged one

Returns:: True if the request was accepted

Reimplemented in ISDNIUA, ISDNQ921Management, and ISDNQ921.

void setRi ( u_int16_t ri ) [inline, protected]

Set the Reference Identifier used in management procedures

Parameters:

ri	The new reference number

State state ( ) const [inline]

Get the layer's state

Returns:: The layer's state as enumeration

static const char* stateName ( State s ) [inline, static]

Get the text associated with a given state

Parameters:

s	The state to get the text for

Returns:: The text associated with the given state

References TelEngine::lookup().

bool teiAssigned ( ) const [inline]

Check if this interface has a TEI assigned

Returns:: True if this interface has a TEI assigned

void teiAssigned ( bool status ) [protected]

Set TEI assigned status. Print a debug message. If status is false calls cleanup() Descendants are responsable for TEI assigned status management

Parameters:

status The new TEI assigned status

unsigned int upTime ( ) const [inline]

Get the uptime of the interface

Returns:: Time since interface got up in seconds

References Time::secNow().

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

yatesig.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation