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

TrunkImage Class Reference

This class is used to hold user loaded XML script files as returned for an XML parser stage. script images per trunk. More...

#include <bayonne.h>

Inheritance diagram for TrunkImage:

ScriptImage URLStream XMLStream List of all members.

Public Methods

 TrunkImage ()
 Construct a new script image, normally done in the plugin.

virtual ~TrunkImage ()
void setProxy (const char *addr, tpport_t port)
 Initial proxy setup. More...

virtual bool Loader (trunkdata_t *data) = 0
 Load and parse an XML resource into a ccScript runtime engine. More...

void Purge (void)
 Access to the purge method of the script image.

void* alloc (unsigned size)
 Access to the image paged memory allocator. More...


Protected Methods

void Close (void)
void getCompile (const char *name = "#")
 Get a scriptname object for a named script segment. More...

void setCompile (unsigned trap)
 Set the compiler for a specific event chain in the script. More...

void putCompile (compile_t *cc)
 Cleanup a compile phase operation. More...

void addCompile (unsigned long mask, const char *cmd, const char **args)
 Add a statement to the active session. More...

void setToken (const unsigned char **attrib)
 Initialize token and parsing. More...

const char* getToken (void)
 Fetch a local token. More...

virtual unsigned long getDefaultMask (void)
 Trap default mask to apply. More...

const char* getAttribute (const char *key, const char *value = NULL)
 Used to extract a specific attribute for an element. More...


Protected Attributes

compile_tmain
compile_tcurrent

Detailed Description

This class is used to hold user loaded XML script files as returned for an XML parser stage. script images per trunk.

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


Constructor & Destructor Documentation

TrunkImage::TrunkImage ( )
 

Construct a new script image, normally done in the plugin.

TrunkImage::~TrunkImage ( ) [inline, virtual]
 


Member Function Documentation

void TrunkImage::Close ( void ) [inline, protected]
 

bool TrunkImage::Loader ( trunkdata_t * data ) [pure virtual]
 

Load and parse an XML resource into a ccScript runtime engine.

The plugin impliments a derived class which performs a specific dialect.

Parameters:
true   on success, false on failure.
pointer   to collected data structure.

void TrunkImage::Purge ( void )
 

Access to the purge method of the script image.

void TrunkImage::addCompile ( unsigned long mask,
const char * cmd,
const char ** args ) [protected]
 

Add a statement to the active session.

Parameters:
mask   of bits.
keyword   method to invoke.
command   arguments.

void * TrunkImage::alloc ( unsigned size ) [inline]
 

Access to the image paged memory allocator.

Returns:
pointer to allocated workspace.
Parameters:
size   requested.

const char * TrunkImage::getAttribute ( const char * key,
const char * value = NULL ) [protected]
 

Used to extract a specific attribute for an element.

Returns:
attribute value.
Parameters:
list   of attributes.
attribute   identifier.
default   if not found.

void TrunkImage::getCompile ( const char * name = "#" ) [protected]
 

Get a scriptname object for a named script segment.

Parameters:
name   of script segment to allocate.

unsigned long TrunkImage::getDefaultMask ( void ) [inline, protected, virtual]
 

Trap default mask to apply.

Returns:
default mask.

const char * TrunkImage::getToken ( void ) [protected]
 

Fetch a local token.

Returns:
token.

void TrunkImage::putCompile ( compile_t * cc ) [protected]
 

Cleanup a compile phase operation.

Parameters:
pointer   to compile session.

void TrunkImage::setCompile ( unsigned trap ) [protected]
 

Set the compiler for a specific event chain in the script.

Parameters:
0   for main else trap event chain.

void TrunkImage::setProxy ( const char * addr,
tpport_t port ) [inline]
 

Initial proxy setup.

Parameters:
address   of proxy server.
port   number of proxy server.

void TrunkImage::setToken ( const unsigned char ** attrib ) [protected]
 

Initialize token and parsing.

Parameters:
attributes.  


Member Data Documentation

compile_t * TrunkImage::current [protected]
 

compile_t * TrunkImage::main [protected]
 


The documentation for this class was generated from the following file:
Generated at Wed Apr 25 22:24:41 2001 for Bayonne by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000