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

Interpreter interface


Detailed Description

The OpenSpeech Browser core is the OpenVXI.

The VXIinterpreter interface implements the VXI interface function to run the interface. In addition a set of process and thread initialization routines are provided to set-up and destroy the interpreter per thread.


Classes

struct  VXIresources
 Structure containing all the interfaces required by the VXI. More...
struct  VXIinterpreterInterface
 VXIinterpreter interface for VoiceXML execution. More...

Defines

#define VXI_BEEP_AUDIO   L"vxi.property.beep.uri"
 VXI Runtime property for the URI to the beep audio (See SetProperties).
#define VXI_PLATFORM_DEFAULTS   L"vxi.property.platform.defaults"
 VXI Runtime property for the URI to the platform defaults script (See SetProperties).
#define VXI_DEFAULT_ACCESS_CONTROL   L"vxi.property.defaultaccesscontrol"
 VXI Runtime property for the behavior of the interpreter when the ?access-control? PI is missing from a document fetched by <data> (See SetProperties).
#define VXI_DOC_MEMORY_CACHE   L"vxi.property.cache.size"

Typedefs

typedef enum VXIinterpreterResult VXIinterpreterResult
 Result codes for interface methods.
typedef VXIresources VXIresources
 Structure containing all the interfaces required by the VXI.
typedef VXIinterpreterInterface VXIinterpreterInterface
 VXIinterpreter interface for VoiceXML execution.

Enumerations

enum  VXIinterpreterResult {
  VXIinterp_RESULT_FATAL_ERROR = -100, VXIinterp_RESULT_OUT_OF_MEMORY = -7, VXIinterp_RESULT_PLATFORM_ERROR = -5, VXIinterp_RESULT_INVALID_PROP_NAME = -3,
  VXIinterp_RESULT_INVALID_PROP_VALUE = -2, VXIinterp_RESULT_INVALID_ARGUMENT = -1, VXIinterp_RESULT_SUCCESS = 0, VXIinterp_RESULT_FAILURE = 1,
  VXIinterp_RESULT_STOPPED = 3, VXIinterp_RESULT_FETCH_TIMEOUT = 51, VXIinterp_RESULT_FETCH_ERROR = 52, VXIinterp_RESULT_INVALID_DOCUMENT = 53,
  VXIinterp_RESULT_UNSUPPORTED = 100
}
 Result codes for interface methods. More...

Functions

VXI_INTERPRETER VXIinterpreterResult VXIinterpreterInit (VXIlogInterface *log, VXIunsigned diagLogBase, const VXIMap *props)
 Per-process initialization for VXIinterpreter.
VXI_INTERPRETER void VXIinterpreterShutDown (VXIlogInterface *log)
 Per-process de-initialization for VXIinterpreter.
VXI_INTERPRETER VXIinterpreterResult VXIinterpreterCreateResource (VXIresources *resource, VXIinterpreterInterface **pThis)
 Create an interface to the VoiceXML interpreter.
VXI_INTERPRETER void VXIinterpreterDestroyResource (VXIinterpreterInterface **pThis)
 Destroy and de-allocate a VXI interface.


Define Documentation

#define VXI_BEEP_AUDIO   L"vxi.property.beep.uri"
 

VXI Runtime property for the URI to the beep audio (See SetProperties).

The VXIValue passed should be of type VXIString. The default is empty.

#define VXI_DEFAULT_ACCESS_CONTROL   L"vxi.property.defaultaccesscontrol"
 

VXI Runtime property for the behavior of the interpreter when the ?access-control? PI is missing from a document fetched by <data> (See SetProperties).

The VXIValue passed should be of type VXIInteger, and contain non-zero to allow access, or 0 to deny access. The default is 0.

#define VXI_DOC_MEMORY_CACHE   L"vxi.property.cache.size"
 

#define VXI_PLATFORM_DEFAULTS   L"vxi.property.platform.defaults"
 

VXI Runtime property for the URI to the platform defaults script (See SetProperties).

The VXIValue passed should be of type VXIString. The default is to use an internal defaults script.


Typedef Documentation

typedef struct VXIinterpreterInterface VXIinterpreterInterface
 

VXIinterpreter interface for VoiceXML execution.

Abstract interface for the VoiceXML intepreter, simply provides a single method for running the intepreter on a document and getting the document result.

There is one intepreter interface per thread/line.

typedef enum VXIinterpreterResult VXIinterpreterResult
 

Result codes for interface methods.

Result codes less then zero are severe errors (likely to be platform faults), those greater then zero are warnings (likely to be application issues)

typedef struct VXIresources VXIresources
 

Structure containing all the interfaces required by the VXI.

This structure must be allocated and all the pointers filled with created and initialized resources before creating the VXI interface.


Enumeration Type Documentation

enum VXIinterpreterResult
 

Result codes for interface methods.

Result codes less then zero are severe errors (likely to be platform faults), those greater then zero are warnings (likely to be application issues)

Enumeration values:
VXIinterp_RESULT_FATAL_ERROR  Fatal error, terminate call.
VXIinterp_RESULT_OUT_OF_MEMORY  Out of memory.
VXIinterp_RESULT_PLATFORM_ERROR  Errors from platform services.
VXIinterp_RESULT_INVALID_PROP_NAME  Property name is not valid.
VXIinterp_RESULT_INVALID_PROP_VALUE  Property value is not valid.
VXIinterp_RESULT_INVALID_ARGUMENT  Invalid function argument.
VXIinterp_RESULT_SUCCESS  Success.
VXIinterp_RESULT_FAILURE  Normal failure.
VXIinterp_RESULT_STOPPED  Run call aborted.
VXIinterp_RESULT_FETCH_TIMEOUT  Document fetch timeout.
VXIinterp_RESULT_FETCH_ERROR  Unable to open or read from URI.
VXIinterp_RESULT_INVALID_DOCUMENT  Not a valid VoiceXML document.
VXIinterp_RESULT_UNSUPPORTED  Operation is not supported.


Function Documentation

VXI_INTERPRETER VXIinterpreterResult VXIinterpreterCreateResource VXIresources resource,
VXIinterpreterInterface **  pThis
 

Create an interface to the VoiceXML interpreter.

Create a VXI interface given an interface structure that contains all the resources required for the VXI.

Parameters:
resource [IN] A pointer to a structure containing all the interfaces requires by the VXI
pThis [IN] A pointer to the VXI interface that is to be allocated. The pointer will be set if this call is successful.
Returns:
VXIinterp_RESULT_SUCCESS if interface is available for use
VXIinterp_RESULT_OUT_OF_MEMORY if low memory is suspected
VXIinterp_RESULT_INVALID_ARGUMENT

VXI_INTERPRETER void VXIinterpreterDestroyResource VXIinterpreterInterface **  pThis  ) 
 

Destroy and de-allocate a VXI interface.

Destroy an interface returned from VXIinterpreterCreateResource. The pointer is set to NULL on success.

Parameters:
pThis [IN] The pointer to the interface to be destroyed.

VXI_INTERPRETER VXIinterpreterResult VXIinterpreterInit VXIlogInterface log,
VXIunsigned  diagLogBase,
const VXIMap *  props
 

Per-process initialization for VXIinterpreter.

This function should be called once at process startup.

Parameters:
log [IN] VXI Logging interface used for error/diagnostic logging, only used for the duration of this function call
diagLogBase [IN] Base tag number for diagnostic logging purposes. All diagnostic tags for the VXI will start at this ID and increase upwards.
props [IN]
Returns:
VXIinterp_RESULT_SUCCESS if resources may be created.

VXIinterp_RESULT_FAILURE if interface is unavailable.

VXI_INTERPRETER void VXIinterpreterShutDown VXIlogInterface log  ) 
 

Per-process de-initialization for VXIinterpreter.

This function should be called once per process shutdown, after all the interfaces for the process are destroyed.

Parameters:
log [IN] VXI Logging interface used for error/diagnostic logging, only used for the duration of this function call


Generated on Wed Jun 1 12:50:19 2005 for OpenVXI by  doxygen 1.4.2