Yate
SIGAdaptUser Class Referenceabstract

Abstract SIGTRAN Adaptation user. More...

#include <yatesig.h>

Inheritance diagram for SIGAdaptUser:
ISDNIUA SS7M2UA SS7M3UA SS7SUA

Public Member Functions

virtual ~SIGAdaptUser ()
 

Protected Member Functions

 SIGAdaptUser ()
 
SIGAdaptClientadaptation () const
 
SIGTransporttransport () const
 
void adaptation (SIGAdaptClient *adapt)
 
virtual void activeChange (bool active)=0
 
bool activate ()
 
bool aspUp () const
 
bool aspActive () const
 
unsigned char getStreamId ()
 

Protected Attributes

bool m_autostart
 
unsigned char m_streamId
 

Friends

class SIGAdaptClient
 

Detailed Description

Abstract SIGTRAN Adaptation user.

An interface to a Signalling Transport Adaptation user

Constructor & Destructor Documentation

◆ ~SIGAdaptUser()

virtual ~SIGAdaptUser ( )
virtual

Destructor

◆ SIGAdaptUser()

SIGAdaptUser ( )
inlineprotected

Default constructor

References m_autostart, and m_streamId.

Member Function Documentation

◆ activate()

bool activate ( )
inlineprotected

Request activation of the ASP

Returns
True if ASP activation started, false on failure

◆ activeChange()

virtual void activeChange ( bool active)
protectedpure virtual

Traffic activity state change notification

Parameters
activeTrue if the ASP is active and traffic is allowed

Implemented in ISDNIUA, and SS7M2UA.

◆ adaptation() [1/2]

SIGAdaptClient * adaptation ( ) const
inlineprotected

Get the User Adaptation to which this component belongs

Returns
Pointer to the User Adaptation layer

Referenced by SS7M2UA::timerTick().

◆ adaptation() [2/2]

void adaptation ( SIGAdaptClient * adapt)
protected

Set the User Adaptation to which this component belongs

Parameters
adaptPointer to the new User Adaptation layer

◆ aspActive()

bool aspActive ( ) const
inlineprotected

Check if the ASP is Active

Returns
True if the ASPTM is in ACTIVE state

◆ aspUp()

bool aspUp ( ) const
inlineprotected

Check if the ASP is Up

Returns
True if the ASPSM is in UP state

◆ getStreamId()

unsigned char getStreamId ( )
inlineprotected

Obtain the stream id to use for data messages

Returns
The stream id

References m_streamId.

◆ transport()

SIGTransport * transport ( ) const
inlineprotected

Get the transport of the user adaptation component

Returns
Pointer to the transport layer or NULL

Member Data Documentation

◆ m_autostart

bool m_autostart
protected

Automatically start on init flag

Referenced by SIGAdaptUser().

◆ m_streamId

unsigned char m_streamId
protected

The SCTP streamId

Referenced by getStreamId(), and SIGAdaptUser().


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