ISDN Q.921 implementation on top of a hardware interface. More...

#include <yatesig.h>

Inheritance diagram for ISDNQ921:

Public Member Functions
	ISDNQ921 (const NamedList &params, const char name=0, ISDNQ921Management mgmt=0, u_int8_t tei=0)

virtual	~ISDNQ921 ()

virtual bool	initialize (const NamedList *config)

u_int64_t	dataTimeout () const

virtual bool	multipleFrame (u_int8_t tei, bool establish, bool force)

virtual bool	sendData (const DataBlock &data, u_int8_t tei, bool ack)

bool	sendSabme ()

virtual void	cleanup ()

void	setDebug (bool printFrames, bool extendedDebug)

Public Member Functions inherited from ISDNLayer2
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)

Public Member Functions inherited from SignallingComponent
virtual	~SignallingComponent ()

virtual const String &	toString () const

virtual bool	initialize (const NamedList *config)

virtual bool	control (NamedList &params)

virtual NamedList *	controlCreate (const char *oper=0)

virtual bool	controlExecute (NamedList *params)

virtual void	engine (SignallingEngine *eng)

SignallingEngine *	engine () const

int	debugLevel (int level)

const String &	componentType () const

Public Member Functions inherited from RefObject
	RefObject ()

virtual	~RefObject ()

virtual void *	getObject (const String &name) const

virtual bool	alive () const

bool	ref ()

bool	deref ()

int	refcount () const

virtual void	destruct ()

Public Member Functions inherited from GenObject
	GenObject ()

virtual	~GenObject ()

virtual bool	alive () const

virtual void	destruct ()

virtual const String &	toString () const

virtual const String &	traceId () const

virtual void *	getObject (const String &name) const

NamedCounter *	getObjCounter () const

NamedCounter *	setObjCounter (NamedCounter *counter)

Public Member Functions inherited from DebugEnabler
	DebugEnabler (int level=TelEngine::debugLevel(), bool enabled=true)

int	debugLevel () const

int	debugLevel (int level)

bool	debugEnabled () const

void	debugEnabled (bool enable)

const char *	debugName () const

bool	debugAt (int level) const

bool	debugChained () const

void	debugChain (const DebugEnabler *chain=0)

void	debugCopy (const DebugEnabler *original=0)

Public Member Functions inherited from SignallingReceiver
	SignallingReceiver (const char *name=0)

virtual	~SignallingReceiver ()

virtual SignallingInterface *	attach (SignallingInterface *iface)

SignallingInterface *	iface () const

bool	control (SignallingInterface::Operation oper, NamedList *params=0)

Public Member Functions inherited from SignallingDumpable
	~SignallingDumpable ()

Protected Member Functions
virtual void	destroyed ()

virtual void	timerTick (const Time &when)

virtual bool	receivedPacket (const DataBlock &packet)

bool	receivedFrame (ISDNFrame *frame)

virtual bool	notify (SignallingInterface::Notification event)

void	reset ()

Protected Member Functions inherited from ISDNLayer2
	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)

Protected Member Functions inherited from SignallingComponent
	SignallingComponent (const char name=0, const NamedList params=0, const char *type="unknown")

virtual void	destroyed ()

void	insert (SignallingComponent *component)

virtual void	detach ()

virtual void	timerTick (const Time &when)

void	setName (const char *name)

void	setCompType (const char *type)

unsigned long	tickSleep (unsigned long usec=1000000) const

Protected Member Functions inherited from RefObject
virtual void	zeroRefs ()

bool	resurrect ()

virtual void	destroyed ()

Protected Member Functions inherited from DebugEnabler
void	debugName (const char *name)

Protected Member Functions inherited from SignallingReceiver
bool	transmitPacket (const DataBlock &packet, bool repeat, SignallingInterface::PacketType type=SignallingInterface::Unknown)

virtual bool	receivedPacket (const DataBlock &packet)=0

virtual bool	notify (SignallingInterface::Notification event)

Protected Member Functions inherited from SignallingDumpable
	SignallingDumpable (SignallingDumper::Type type, bool network=false)

bool	dump (void *buf, unsigned int len, bool sent=false, int link=0)

bool	dump (const DataBlock &data, bool sent=false, int link=0)

void	setDumpNetwork (bool network)

void	setDumper (SignallingDumper *dumper=0)

bool	setDumper (const String &name, bool create=true, bool append=false)

bool	control (NamedList &params, SignallingComponent *owner=0)

Friends
class	ISDNQ921Management

Additional Inherited Members
Public Types inherited from ISDNLayer2
enum	State { Released , WaitEstablish , Established , WaitRelease }

Static Public Member Functions inherited from ISDNLayer2
static const char *	stateName (State s)

Static Public Member Functions inherited from SignallingComponent
static bool	resolveConfig (const String &cmpName, NamedList &params, const NamedList *config)

Static Public Member Functions inherited from RefObject
static bool	alive (const RefObject *obj)

static bool	efficientIncDec ()

Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)

static bool	getObjCounting ()

static void	setObjCounting (bool enable)

static NamedCounter *	getObjCounter (const String &name, bool create=true)

static ObjList &	getObjCounters ()

Detailed Description

ISDN Q.921 implementation on top of a hardware interface.

Q.921 ISDN Layer 2 implementation on top of a hardware HDLC interface

Constructor & Destructor Documentation

◆ ISDNQ921()

ISDNQ921	(	const NamedList &	params,
		const char *	name = `0`,
		ISDNQ921Management *	mgmt = `0`,
		u_int8_t	tei = `0`
	)

Constructor Initialize this object and the component

Parameters

params	Layer's and TelEngine::ISDNLayer2 parameters
name	Name of this component
mgmt	TEI management component
tei	Value of TEI for this component

◆ ~ISDNQ921()

virtual ~ISDNQ921 ( )

virtual

Destructor

Member Function Documentation

◆ cleanup()

virtual void cleanup ( )

virtual

Emergency release. Send 'disconnect' command. Reset all data. Set state to 'Released' This method is thread safe

Implements ISDNLayer2.

◆ dataTimeout()

u_int64_t dataTimeout ( ) const

inline

Get the timeout of a data frame. After that, a higher layer may retransmit data

Returns: The timeout of a data frame

◆ destroyed()

virtual void destroyed ( )

inlineprotectedvirtual

Detach links. Disposes memory

Reimplemented from SignallingComponent.

References ISDNLayer2::attach(), SignallingReceiver::attach(), and SignallingComponent::destroyed().

◆ initialize()

virtual bool initialize ( const NamedList * config )

virtual

Configure and initialize Q.921 and its interface

Parameters

config Optional configuration parameters override

Returns: True if Q.921 and the interface were initialized properly

Reimplemented from SignallingComponent.

◆ multipleFrame()

virtual bool multipleFrame	(	u_int8_t	tei,
		bool	establish,
		bool	force
	)

virtual

Implements Q.921 DL-ESTABLISH and DL-RELEASE request primitives If accepted, the primitive is enqueued for further processing This method is thread safe

Parameters

tei	This layer's TEI
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 from ISDNLayer2.

◆ notify()

virtual bool notify ( SignallingInterface::Notification event )

protectedvirtual

Process a notification generated by the attached interface This method is thread safe

Parameters

event Notification event reported by the interface

Returns: True if notification was processed

Reimplemented from SignallingReceiver.

◆ receivedFrame()

bool receivedFrame ( ISDNFrame * frame )

protected

Process the frame received

Parameters

frame Pointer to frame to process

Returns: True if the frame was processed

◆ receivedPacket()

virtual bool receivedPacket ( const DataBlock & packet )

protectedvirtual

Process a packet received by the receiver's interface This method is thread safe

Parameters

packet The received packet

Returns: True if message was successfully processed

Implements SignallingReceiver.

◆ reset()

void reset ( )

protected

Reset object if not in Released state. Drop all frames This method is thread safe

◆ sendData()

virtual bool sendData	(	const DataBlock &	data,
		u_int8_t	tei,
		bool	ack
	)

virtual

Implements Q.921 DL-DATA and DL-UNIT DATA request primitives Send data through the HDLC interface This method is thread safe

Parameters

data	Data to send
tei	The TEI to send with the data frane
ack	True to send an acknowledged frame, false to send an unacknowledged one

Returns: False if the request was not accepted or send operation failed

Reimplemented from ISDNLayer2.

◆ sendSabme()

bool sendSabme ( )

inline

Send a SABME frame to reset the layer

Returns: True if a SABME frame was sent

◆ setDebug()

void setDebug	(	bool	printFrames,
		bool	extendedDebug
	)

inline

Set debug data of this layer

Parameters

printFrames	Enable/disable frame printing on output
extendedDebug	Enable/disable hex data dump if print frames is enabled

◆ timerTick()

virtual void timerTick ( const Time & when )

protectedvirtual

Method called periodically to check timeouts This method is thread safe

Parameters

when	Time to use as computing base for events and timeouts

Reimplemented from SignallingComponent.

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

yatesig.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ISDNQ921()

◆ ~ISDNQ921()

Member Function Documentation

◆ cleanup()

◆ dataTimeout()

◆ destroyed()

◆ initialize()

◆ multipleFrame()

◆ notify()

◆ receivedFrame()

◆ receivedPacket()

◆ reset()

◆ sendData()

◆ sendSabme()

◆ setDebug()

◆ timerTick()