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. |
|
VXI Runtime property for the URI to the beep audio (See SetProperties). The VXIValue passed should be of type VXIString. The default is empty. |
|
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. |
|
|
|
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. |
|
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. |
|
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) |
|
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. |
|
|
Create an interface to the VoiceXML interpreter. Create a VXI interface given an interface structure that contains all the resources required for the VXI.
|
|
Destroy and de-allocate a VXI interface. Destroy an interface returned from VXIinterpreterCreateResource. The pointer is set to NULL on success.
|
|
Per-process initialization for VXIinterpreter. This function should be called once at process startup.
|
|
Per-process de-initialization for VXIinterpreter. This function should be called once per process shutdown, after all the interfaces for the process are destroyed.
|