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

capisuitemodule.h File Reference

Contains the Python module integration routines. More...

#include <Python.h>
#include "applicationexception.h"

Go to the source code of this file.

Functions

void capisuitemodule_init () throw (ApplicationError)
 Initializes and registers C implementation of python module capisuite.
void capisuitemodule_destruct_connection (void *conn)
 Destructor function for Connection reference given to Python scripts.


Detailed Description

Contains the Python module integration routines.

This file contains the implementation of thy python module capisuite which contains all commands available in python scripts for programming capisuite.

There are two groups of functions: functions used from C++ to init and access the python module and functions used from python implementing the functions of the python module.

Here you'll only find the functions used from C++. If you're interested in the commands usable from python, please have a look at the documentation found in C/Python wrapper functions.

Author:
Gernot Hillier <gernot@hillier.de>
Revision
1.2

Function Documentation

void capisuitemodule_destruct_connection void *  conn  ) 
 

Destructor function for Connection reference given to Python scripts.

This function will be called by Python if the given connection reference is not used any more in the script. This will lead to the destruction of the Connection object.

This function has the right signature to pass as destructor function for PyCCobject_FromVoidPtr() calls.

Parameters:
conn Connection reference

void capisuitemodule_init  )  throw (ApplicationError)
 

Initializes and registers C implementation of python module capisuite.

This function creates a new python module named "capisuite" containing the functions for the control of capisuite and two exception types: CallGoneError and BackendError (see C/Python wrapper functions). Also there are three constants defined: SERVICE_VOICE, SERVICE_FAXG3, SERVICE_OTHER, see also Connection::service_t.

Returns:
borrowed reference to the __main__-Dictionary of the created python interpreter
Exceptions:
ApplicationError Thrown if some step of the module initialization fails. See errormsg for details.


Generated on Sun Nov 28 14:37:44 2004 for CapiSuite by doxygen 1.3.8