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

Module Class Reference

Modules are used for protocol modules and detached threads used to service key Bayonne protocols and interfaces. Module interface class. More...

#include <bayonne.h>

List of all members.

Public Methods

virtual char* getName (void) = 0
 Get the "name" identifer of this module. More...

virtual char* Dispatch (Trunk *trunk) = NULL
 Execute the script request. More...

virtual unsigned Sleep (Trunk *trunk)
 This is used to determine if a timeout/sleep should occur or if script advance is immediate. More...

virtual void Detach (Trunk *trunk)
 Notify for detach. More...


Protected Methods

 Module ()
virtual modtype_t getType (void) = 0
 Get the "type" identifer of this module. More...


Friends

Module* getModule (modtype_t mod, const char *name = NULL)
void detachModules (Trunk *trunk)


Detailed Description

Modules are used for protocol modules and detached threads used to service key Bayonne protocols and interfaces. Module interface class.

These are done as loadable modules and may be replaced with application specific interfaces.

Author(s):
David Sugar <dyfet@ostel.com>


Constructor & Destructor Documentation

Module::Module ( ) [protected]
 


Member Function Documentation

void Module::Detach ( Trunk * trunk ) [inline, virtual]
 

Notify for detach.

As each call is detached, this will get called.

char * Module::Dispatch ( Trunk * trunk ) [virtual]
 

Execute the script request.

Usually this involves creating a detached service thread.

Returns:
error message or NULL.
Parameters:
trunk   object to reference.

unsigned Module::Sleep ( Trunk * trunk ) [inline, virtual]
 

This is used to determine if a timeout/sleep should occur or if script advance is immediate.

Returns:
number of seconds in sleep state.
Parameters:
trunk   object to reference.

char * Module::getName ( void ) [pure virtual]
 

Get the "name" identifer of this module.

Returns:
name string.

modtype_t Module::getType ( void ) [protected, pure virtual]
 

Get the "type" identifer of this module.

Returns:
type id.


Friends And Related Function Documentation

void detachModules ( Trunk * trunk ) [friend]
 

Module* getModule ( modtype_t mod,
const char * name = NULL ) [friend]
 


The documentation for this class was generated from the following file:
Generated at Fri Dec 15 12:35:20 2000 for Bayonne by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000