SIGTransport Class Reference

An abstract SIGTRAN transport layer. More...

#include <yatesig.h>

Inheritance diagram for SIGTransport:

List of all members.

Public Types
enum	Transport {   None = 0, Sctp, Tcp, Udp,   Unix }
Public Member Functions
SIGTRAN *	sigtran () const
virtual bool	connected (int streamId) const =0
Protected Member Functions
	SIGTransport (const char *name=0)
void	attach (SIGTRAN *sigtran)
virtual void	attached (bool hasUAL)=0
bool	processMSG (unsigned char msgVersion, unsigned char msgClass, unsigned char msgType, const DataBlock &msg, int streamId) const
virtual bool	transmitMSG (unsigned char msgVersion, unsigned char msgClass, unsigned char msgType, const DataBlock &msg, int streamId=0)
virtual bool	transmitMSG (const DataBlock &header, const DataBlock &msg, int streamId=0)=0
Friends
class	SIGTRAN

---

Detailed Description

An abstract SIGTRAN transport layer.

A an abstraction offering connectivity to a SIGTRAN transport

---

Member Enumeration Documentation

enum Transport

Type of transport used

---

Constructor & Destructor Documentation

SIGTransport

(

const char *

name = 0

)

[inline, protected]

Constructor

Parameters:

name

Default empty component name

---

Member Function Documentation

void attach

(

SIGTRAN *

sigtran

)

[protected]

Attach an user adaptation layer

Parameters:

sigtran

SIGTRAN component to attach, can be NULL

virtual void attached

(

bool

hasUAL

)

[protected, pure virtual]

Notification if the attached state changed

Parameters:

hasUAL

True if an User Adaptation Layer is now attached

virtual bool connected

(

int

streamId

)

const [pure virtual]

Check if the network transport layer is connected

Parameters:

streamId

Identifier of the stream to check if applicable

Returns:

True if the transport (and stream if applicable) is connected

bool processMSG	(	unsigned char	msgVersion,
		unsigned char	msgClass,
		unsigned char	msgType,
		const DataBlock &	msg,
		int	streamId
	)			const [protected]

Send a complete message to the adaptation layer for processing

Parameters:

	msgVersion	Version of the protocol
	msgClass	Class of the message
	msgType	Type of the message, depends on the class
	msg	Message data, may be empty
	streamId	Identifier of the stream the message was received on

Returns:

True if the message was handled

SIGTRAN* sigtran

(

)

const [inline]

Get the SIGTRAN component attached to this transport

Returns:

Pointer to adaptation layer or NULL

virtual bool transmitMSG	(	const DataBlock &	header,
		const DataBlock &	msg,
		int	streamId = 0
	)			[protected, pure virtual]

Transmit a prepared message to the network

Parameters:

	header	Message header, typically 8 octets
	msg	Message data, may be empty
	streamId	Identifier of the stream to send the data over

Returns:

True if the message was transmitted to network

virtual bool transmitMSG	(	unsigned char	msgVersion,
		unsigned char	msgClass,
		unsigned char	msgType,
		const DataBlock &	msg,
		int	streamId = 0
	)			[protected, virtual]

Transmit a message to the network

Parameters:

	msgVersion	Version of the protocol
	msgClass	Class of the message
	msgType	Type of the message, depends on the class
	msg	Message data, may be empty
	streamId	Identifier of the stream to send the data over

Returns:

True if the message was transmitted to network

---

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

• yatesig.h