Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

DisconnectModule Class Reference

Call Module for call clearing. More...

#include <disconnectmodule.h>

Inheritance diagram for DisconnectModule:

CallModule CallInterface List of all members.

Public Methods

 DisconnectModule (Connection *conn, int reject_reason=1, bool quick_disconnect=false)
 Constructor. Create object.

void mainLoop () throw (CapiMsgError,CapiExternalError)
 Initiate call clearing and wait for successful physical disconnection.

void callDisconnectedLogical ()
 Do nothing as we're waiting for physical disconnection.


Private Attributes

int reject_reason
 saving reject reason given in constructor

bool quick_disconnect
 disconnect physical immediately w/o disconnection logical before


Detailed Description

Call Module for call clearing.

This module initiates disconnection or rejection of connection and waits until the physical connection is cleared completely. It's no problem to call it when the connection is already (partly or completely) cleared.

There exists nothing like a wrong connection state to disconnect, therefore CapiWrongState is never thrown.

Author:
Gernot Hillier


Constructor & Destructor Documentation

DisconnectModule::DisconnectModule Connection   conn,
int    reject_reason = 1,
bool    quick_disconnect = false
 

Constructor. Create object.

Parameters:
conn  reference to Connection object
reject_reason  reason to give for rejecting a waiting call (1=ignore call, default; for other values see Connection::rejectWaiting()), ignored for normal disconnect
quick_disconnect  disconnect physical immediately, this will lead to a protocol error in Layer 3. Use for error cases.


Member Function Documentation

void DisconnectModule::callDisconnectedLogical   [virtual]
 

Do nothing as we're waiting for physical disconnection.

Reimplemented from CallModule.

void DisconnectModule::mainLoop   throw (CapiMsgError,CapiExternalError) [virtual]
 

Initiate call clearing and wait for successful physical disconnection.

Exceptions:
CapiMsgError  Thrown by Connection::disconnectCall() or Connection::rejectWaiting()
CapiExternalError  Thrown by Connection::rejectWaiting().

Reimplemented from CallModule.


Member Data Documentation

bool DisconnectModule::quick_disconnect [private]
 

disconnect physical immediately w/o disconnection logical before

int DisconnectModule::reject_reason [private]
 

saving reject reason given in constructor


The documentation for this class was generated from the following files:
Generated on Mon Jan 5 12:20:00 2004 for CapiSuite by doxygen1.2.18