#include <VXIinterpreter.h>
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.
Public Attributes | |
VXIint32(* | GetVersion )(void) |
Get the VXI interface version implemented. | |
const VXIchar *(* | GetImplementationName )(void) |
Get the name of the implementation. | |
VXIinterpreterResult(* | Run )(struct VXIinterpreterInterface *pThis, const VXIchar *name, const VXIchar *sessionScript, VXIValue **result) |
Run a VoiceXML document and optionally return the result. | |
VXIinterpreterResult(* | SetProperties )(struct VXIinterpreterInterface *pThis, const VXIMap *props) |
Specify runtime properties for the VoiceXML interpreter. | |
VXIinterpreterResult(* | Validate )(struct VXIinterpreterInterface *pThis, const VXIchar *name) |
Load and parse an VXML document. | |
VXIinterpreterResult(* | RequestStop )(struct VXIinterpreterInterface *pThis, VXIbool doStop) |
In the interpreter is running and doStop == TRUE, this will cause the in progress Run to return as soon as possible with VXIinterp_RESULT_STOPPED. | |
VXIinterpreterResult(* | InsertEvent )(struct VXIinterpreterInterface *pThis, const VXIchar *event, const VXIchar *message) |
Trigger an event. | |
VXIinterpreterResult(* | ClearEventQueue )(struct VXIinterpreterInterface *pThis) |
Clear the event queue. |
|
Clear the event queue. NOTE: this function must be called by the integration to clear the event(s) in case of error occurs and the event(s) is no longer valid. The interpreter will not clear the queue to avoid race condition.
|
|
Get the name of the implementation.
|
|
Get the VXI interface version implemented.
|
|
Trigger an event.
|
|
In the interpreter is running and doStop == TRUE, this will cause the in progress Run to return as soon as possible with VXIinterp_RESULT_STOPPED. If doStop == FALSE, this clears any pending stop request. NOTE: if the interpreter encounters an error before noticing the request or while servicing the request, the actual return value from Run may not something other than VXIinterp_RESULT_STOPPED.
|
|
Run a VoiceXML document and optionally return the result.
|
|
Specify runtime properties for the VoiceXML interpreter.
|
|
Load and parse an VXML document. This tests the validity.
|