Category

Development Platform
Home > SourceCode/Document > Internet-Socket-Network > xml-soap-webservice > View Code
VXIobjectAPI.h
Package: openvxi-3.4.zip　[view]
Upload User: xqtpzdz
Upload Date: 2022-05-21
Package Size: 1764k
Code Size: 5k
Category:

xml-soap-webservice

Development Platform:

Visual C++

VXIobjectAPI.h：Code Content
  2. /****************License************************************************
  3.  * Vocalocity OpenVXI
  4.  * Copyright (C) 2004-2005 by Vocalocity, Inc. All Rights Reserved.
  5.  * This program is free software; you can redistribute it and/or
  6.  * modify it under the terms of the GNU General Public License
  7.  * as published by the Free Software Foundation; either version 2
  8.  * of the License, or (at your option) any later version.
  9.  *  
  10.  * This program is distributed in the hope that it will be useful,
  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13.  * GNU General Public License for more details.
  14.  *
  15.  * You should have received a copy of the GNU General Public License
  16.  * along with this program; if not, write to the Free Software
  17.  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18.  * Vocalocity, the Vocalocity logo, and VocalOS are trademarks or 
  19.  * registered trademarks of Vocalocity, Inc. 
  20.  * OpenVXI is a trademark of Scansoft, Inc. and used under license 
  21.  * by Vocalocity.
  22.  ***********************************************************************/
  24. #ifndef _VXIOBJECT_API_H
  25. #define _VXIOBJECT_API_H
  27. #include "VXIobject.h"                 /* For VXIobject base interface */
  28. #include "VXIheaderPrefix.h"
  30. #define VXIOBJECT_API_EX               /* Place holder for export symbol
  31.                                           since we don't build DLL for object */
  33. #ifdef __cplusplus
  35. struct VXIlogInterface;
  36. struct VXIinetInterface;
  37. struct VXIjsiInterface;
  38. struct VXIrecInterface;
  39. struct VXIpromptInterface;
  40. struct VXItelInterface;
  41. struct VXIplatform;
  43. extern "C" {
  44. #else
  46. #include "VXIlog.h"
  47. #include "VXIinet.h"
  48. #include "VXIjsi.h"
  49. #include "VXIrec.h"
  50. #include "VXIprompt.h"
  51. #include "VXItel.h"
  52. #include "VXIplatform.h"
  53. #endif
  55.  /** 
  56.   * @name VXIobject
  57.   * @memo VXIobject implementation of VXIobject
  58.   * @doc
  59.   * Provides an implementation of the VXIobject abstract interface for
  60.   * VoiceXML object functionality that allows integrators to define
  61.   * VoiceXML language extensions that can be executed by applications
  62.   * through the VoiceXML object element.  These objects can provide
  63.   * almost any extended functionality that is desired.
  64.   *
  65.   * There is one object interface per thread/line.  
  66.   */
  68. /*@{*/
  70. /**
  71.  * @name VXIobjectResources
  72.  * @memo Structure containing all the interfaces required for Objects
  73.  * @doc This structure must be allocated and all the pointers filled
  74.  * with created and initialized resources before creating the Object
  75.  * interface.
  76.  */
  77. typedef struct VXIobjectResources {
  78.   /** log interface */
  79.   VXIlogInterface    * log;
  80.   /** Internet interface */
  81.   VXIinetInterface   * inet; 
  82.   /** ECMAScript interface */
  83.   VXIjsiInterface    * jsi;    
  84.   /** Recognizer interface */
  85.   VXIrecInterface    * rec;  
  86.   /** Prompt interface */
  87.   VXIpromptInterface * prompt;
  88.   /** Telephony interface */
  89.   VXItelInterface    * tel;
  90.   /** Platform interface */
  91.   VXIplatform        * platform;
  92. } VXIobjectResources;
  95. /**
  96.  * Global platform initialization of VXIobject
  97.  *
  98.  * @param log            VXI Logging interface used for error/diagnostic 
  99.  *                       logging, only used for the duration of this 
  100.  *                       function call
  101.  * @param  diagLogBase   Base tag number for diagnostic logging purposes.
  102.  *                       All diagnostic tags for VXIobject will start at this
  103.  *                       ID and increase upwards.
  104.  *
  105.  * @result VXIobj_RESULT_SUCCESS on success
  106.  */
  107. VXIOBJECT_API_EX 
  108. VXIobjResult VXIobjectInit (VXIlogInterface  *log,
  109.                             VXIunsigned       diagLogBase);
  111. /**
  112.  * Global platform shutdown of VXIobject
  113.  *
  114.  * @param log    VXI Logging interface used for error/diagnostic logging,
  115.  *               only used for the duration of this function call
  116.  *
  117.  * @result VXIobj_RESULT_SUCCESS on success
  118.  */
  119. VXIOBJECT_API_EX 
  120. VXIobjResult VXIobjectShutDown (VXIlogInterface  *log);
  122. /**
  123.  * Create a new object service handle
  124.  *
  125.  * @param resources  A pointer to a structure containing all the interfaces
  126.  *                   that may be required by the object resource
  127.  *
  128.  * @result VXIobj_RESULT_SUCCESS on success 
  129.  */
  130. VXIOBJECT_API_EX 
  131. VXIobjResult VXIobjectCreateResource (VXIobjectResources   *resources,
  132.                                       VXIobjectInterface **object);
  134. /**
  135.  * Destroy the interface and free internal resources. Once this is
  136.  *  called, the resource interfaces passed to VXIobjectCreateResource( )
  137.  *  may be released as well.
  138.  *
  139.  * @result VXIobj_RESULT_SUCCESS on success 
  140.  */
  141. VXIOBJECT_API_EX 
  142. VXIobjResult VXIobjectDestroyResource (VXIobjectInterface **object);
  144. /*@}*/
  146. #ifdef __cplusplus
  147. }
  148. #endif
  150. #include "VXIheaderSuffix.h"
  152. #endif  /* include guard */