SignallingReceiver Class Reference

Abstract Layer 2 packet data receiver. More...

#include <yatesig.h>

Inheritance diagram for SignallingReceiver:

Public Member Functions
	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 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 const String &	traceId () 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)

Protected Member Functions
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 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 ()
Protected Member Functions inherited from DebugEnabler
void	debugName (const char *name)

Friends
class	SignallingInterface

Additional Inherited Members
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

Abstract Layer 2 packet data receiver.

An interface to an abstraction of a Layer 2 packet data receiver

Constructor & Destructor Documentation

SignallingReceiver()

SignallingReceiver

(

const char *

name = 0

)

Constructor

Parameters

name	Name of the component to create

~SignallingReceiver()

virtual ~SignallingReceiver ( )

virtual

Destructor, stops the interface and detaches from it

Member Function Documentation

attach()

virtual SignallingInterface * attach ( SignallingInterface * iface )

virtual

Attach a hardware interface to the data link. Detach from the old one if valid

Parameters

iface

Pointer to interface to attach

Returns

Pointer to old attached interface or NULL

References iface().

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

control()

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

Execute a control operation on the attached interface.

Parameters

oper	Operation to execute
params	Optional parameters for the operation

Returns

True if the command completed successfully, for query operations also indicates the interface is enabled and operational

iface()

SignallingInterface * iface ( ) const

inline

Retrieve the interface used by this receiver

Returns

Pointer to the attached interface or NULL

Referenced by attach().

notify()

virtual bool notify ( SignallingInterface::Notification event )

protectedvirtual

Process a notification generated by the attached interface

Parameters

event

Notification event reported by the interface

Returns

True if notification was processed

Reimplemented in ISDNQ921, ISDNQ921Management, ISDNQ921Passive, and SS7MTP2.

receivedPacket()

virtual bool receivedPacket ( const DataBlock & packet )

protectedpure virtual

Process a Signalling Packet received by the interface

Returns

True if message was successfully processed

Implemented in ISDNQ921, ISDNQ921Management, ISDNQ921Passive, and SS7MTP2.

transmitPacket()

bool transmitPacket ( const DataBlock & packet, bool repeat, SignallingInterface::PacketType type = SignallingInterface::Unknown )

protected

Send a packet to the attached interface for transmission

Parameters

packet	Packet data to send
repeat	Continuously send a copy of the packet while no other data is available for transmission
type	Type of the packet to send

Returns

True if the interface accepted the packet

---

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

• yatesig.h