SignallingReceiver Class Reference

Abstract Layer 2 packet data receiver. More...

#include <yatesig.h>

Inheritance diagram for SignallingReceiver:

List of all members.

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)
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)
Friends
class	SignallingInterface

---

Detailed Description

Abstract Layer 2 packet data receiver.

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

---

Constructor & Destructor Documentation

SignallingReceiver

(

const char *

name = 0

)

Constructor

Parameters:

name

Name of the component to create

virtual ~SignallingReceiver

(

)

[virtual]

Destructor, stops the interface and detaches from it

---

Member Function Documentation

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

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

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

SignallingInterface* iface

(

)

const [inline]

Retrive the interface used by this receiver

Returns:

Pointer to the attached interface or NULL

virtual bool notify

(

SignallingInterface::Notification

event

)

[protected, virtual]

Process a notification generated by the attached interface

Parameters:

event

Notification event reported by the interface

Returns:

True if notification was processed

Reimplemented in SS7MTP2, ISDNQ921, ISDNQ921Management, and ISDNQ921Passive.

virtual bool receivedPacket

(

const DataBlock &

packet

)

[protected, pure virtual]

Process a Signalling Packet received by the interface

Returns:

True if message was successfully processed

Implemented in SS7MTP2, ISDNQ921, ISDNQ921Management, and ISDNQ921Passive.

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