class SS7ISUPCall

An SS7 ISUP call. More...

Full nameTelEngine::SS7ISUPCall
Definition#include <libs/ysig/yatesig.h>
InheritsTelEngine::SignallingCall [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Protected Methods


Detailed Description

A signalling call using SS7 ISUP protocol

enum State { Null = 0, Testing = 1, Setup = 2, Accepted = 3, Ringing = 4, Answered = 5, Releasing = 6, Released = 7 }

State

Call state enumerators

 ~SS7ISUPCall ()

~SS7ISUPCall

[virtual]

Destructor. Complete call release. Releas circuit. Remove itself from controller's list

inline State  state ()

state

[const]

Get the call state

Returns: The call state as enumeration

inline bool  earlyState ()

earlyState

[const]

Check if the call is a not test one in early state

Returns: True if this a non test call in early state

inline const String&  cicRange ()

cicRange

[const]

Get the call's circuit range

Returns: The call's circuit range

inline unsigned int  id ()

id

[const]

Get the call id (the code of the circuit reserved for this call)

Returns: The call id

SignallingEvent*  getEvent (const Time& when)

getEvent

[virtual]

Get an event from this call This method is thread safe

Parameters:
whenThe current time

Returns: SignallingEvent pointer or 0 if no events

Reimplemented from SignallingCall.

bool  sendEvent (SignallingEvent* event)

sendEvent

[virtual]

Send an event to this call

Parameters:
eventThe event to send

Returns: True if the operation succedded

Reimplemented from SignallingCall.

inline void  setTerminate (bool gracefully, const char* reason = 0, const char* diagnostic = 0, const char* location = 0)

setTerminate

Set termination flag. Set termination reason if not already set

Parameters:
gracefullyTrue to send RLC on termination, false to destroy the call without notification
reasonTermination reason
diagnosticOptional diagnostic data to be sent with termination reason
locationOptional release location

void*  getObject (const String& name)

getObject

[const virtual]

Get a pointer to this object or other data

Parameters:
nameObject name

Returns: The requested pointer or 0 if not exists

Reimplemented from GenObject.

 SS7ISUPCall (SS7ISUP* controller, SignallingCircuit* cic, const SS7PointCode& local, const SS7PointCode& remote, bool outgoing, int sls = -1, const char* range = 0, bool testCall = false)

SS7ISUPCall

[protected]

Constructor

Parameters:
controllerThe call controller
cicThe reserved circuit
localThe local point code used to create the routing label for sent messages
remoteThe remote point code used to create the routing label for sent messages
outgoingCall direction
slsOptional link for the routing label
rangeOptional range used to re-allocate a circuit for this call if necessary
testCallTrue if this is a test call

SignallingEvent*  releaseComplete (bool final, SS7MsgISUP* msg = 0, const char* reason = 0, bool timeout = false)

releaseComplete

[protected]

Release call. Stop timers. Send a RLC (Release Complete) message if it should terminate gracefully Decrease the object's referrence count and generate a Release event if not final This method is thread safe

Parameters:
finalTrue if called from destructor
msgReceived message with parameters if any
reasonOptional release reason
timeoutTrue if this is method is called due to T5 timer expiry

Returns: SignallingEvent pointer or 0

bool  replaceCircuit (SignallingCircuit* circuit, SS7MsgISUP* msg = 0)

replaceCircuit

[protected]

Replace the circuit reserved for this call. Release the already reserved circuit. Retransmit the initial IAM request on success. On failure set the termination flag and release the new circuit if valid. If false is returned, the call is prepared to return a Release event. This method is thread safe

Parameters:
circuitThe new circuit reserved for this call
msgOptional message to send before IAM (it will be consumed)

Returns: False if the state is greater then Setup, the call is not outgoing or the new circuit is 0

void  stopWaitSegment (bool discard)

stopWaitSegment

[protected]

Stop waiting for a SGM (Segmentation) message when another message is received by the controller. This method is thread safe

Parameters:
discardTrue to discard (destruct) the segment waiting message if any


Generated by: paulc on bussard on Tue Apr 12 17:15:21 2011, using kdoc 2.0a54.