VXItelAPI.h
上传用户:xqtpzdz
上传日期:2022-05-21
资源大小:1764k
文件大小:6k
源码类别:

xml/soap/webservice

开发平台:

Visual C++

  1. /****************License************************************************
  2.  * Vocalocity OpenVXI
  3.  * Copyright (C) 2004-2005 by Vocalocity, Inc. All Rights Reserved.
  4.  * This program is free software; you can redistribute it and/or
  5.  * modify it under the terms of the GNU General Public License
  6.  * as published by the Free Software Foundation; either version 2
  7.  * of the License, or (at your option) any later version.
  8.  *  
  9.  * This program is distributed in the hope that it will be useful,
  10.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12.  * GNU General Public License for more details.
  13.  *
  14.  * You should have received a copy of the GNU General Public License
  15.  * along with this program; if not, write to the Free Software
  16.  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17.  * Vocalocity, the Vocalocity logo, and VocalOS are trademarks or 
  18.  * registered trademarks of Vocalocity, Inc. 
  19.  * OpenVXI is a trademark of Scansoft, Inc. and used under license 
  20.  * by Vocalocity.
  21.  ***********************************************************************/
  22. #ifndef _VXITEL_API_H
  23. #define _VXITEL_API_H
  24. #include <VXIheaderPrefix.h>
  25. #include <VXIlog.h>
  26. #include <VXItel.h>
  27. #ifdef __cplusplus
  28. extern "C" {
  29. #endif
  30. /**
  31.  * @name VXItel
  32.  * @memo VXItel Interface
  33.  * @doc
  34.  * VXItel provides a simulator implementation of the VXItel abstract interface
  35.  * for call control functionality.   All calls are blocking with the
  36.  * results returned by the implementation being used to determine the
  37.  * outcome of transers. One VXItel interface should be constructed per line.
  38.  */
  39. /*@{*/
  40. /**
  41.  * VXItel interface, extends the VXItel interface to add a wait for
  42.  * call method.
  43.  */
  44. typedef struct VXItelInterfaceEx
  45. {
  46.   /* Base interface, must be the first member */
  47.   VXItelInterface vxitel;
  48.   /**
  49.    * EnableCall
  50.    *
  51.    * Re-arms the hardware interface to allow it to accept a call. The
  52.    * telephony interface starts up in an out-of-service (OOS) state.
  53.    * In this state, calls will not be excepted. The best
  54.    * implementation is to arrange for the line to be out of service
  55.    * back to the telephony switch so that failover to the next line
  56.    * occurs at the switch level. For some protocols this can be done
  57.    * by setting the line to a busy state.  This call is blocking. When
  58.    * it returns the interface will be ready to accept calls.
  59.    *
  60.    * A hangup or error on the line will place the hardware back into
  61.    * the out-of-service state so that no calls come into the line
  62.    * until it is explictly re-armed.
  63.    *
  64.    * @return VXItel_RESULT_SUCCESS if sucess, different value on failure 
  65.    */
  66.   VXItelResult (*EnableCall)(struct VXItelInterfaceEx  *pThis);
  67.   /**
  68.    * WaitForCall
  69.    *
  70.    * Wait for and answer a call, EnableCall( ) must be called prior
  71.    * to this to enable calls on the channel.
  72.    *
  73.    * @param telephonyProps [OUT] Used to return the telephony properties
  74.    *                             that should be made available to the
  75.    *                             application as "session.telephone.*" 
  76.    *                             variables, such as the called and calling
  77.    *                             party telephone numbers. The platform is
  78.    *                             responsible for destroying these on
  79.    *                             success.
  80.    *
  81.    * @return VXItel_RESULT_SUCCESS if sucess, different value on failure 
  82.    */
  83.   VXItelResult (*WaitForCall)(struct VXItelInterfaceEx  *pThis,
  84.       VXIMap                 **telephonyProps);
  85. } VXItelInterfaceEx;
  86. /**
  87.  * Initializes an VXItel implementation of the VXItel interface
  88.  *
  89.  * @param log              VXI Logging interface used for error/diagnostic 
  90.  *                         logging, only used for the duration of this 
  91.  *                         function call
  92.  * @param diagLogBase      Logging base for diagnostic logging. All 
  93.  *                         diagnostics are based on this offset.
  94.  *
  95.  * @return VXItel_RESULT_SUCCESS if sucess, different value on failure
  96.  */
  97. VXITEL_API VXItelResult VXItelInit (VXIlogInterface  *log,
  98.     VXIunsigned       diagLogBase,
  99.     VXIMap            *args);
  100. /**
  101.  * Shutdown an VXItel implementation of the VXItel interface
  102.  *
  103.  * @param log              VXI Logging interface used for error/diagnostic 
  104.  *                         logging, only used for the duration of this 
  105.  *                         function call
  106.  *
  107.  * @return VXItel_RESULT_SUCCESS if sucess, different value on failure
  108.  */
  109. VXITEL_API VXItelResult VXItelShutDown (VXIlogInterface  *log);
  110. /**
  111.  * Creates an VXItel implementation of the VXItel interface
  112.  *
  113.  * @param log            [IN]  VXI Logging interface used for error/diagnostic
  114.  *                             logging, must remain a valid pointer throughout
  115.  *                             the lifetime of the resource (until 
  116.  *                             VXIpromptDestroyResource( ) is called)
  117.  * @param tel            [OUT] Pointer that returns the newly created VXItel
  118.  *                             interface.
  119.  *
  120.  * @return VXItel_RESULT_SUCCESS if sucess, different value on failure
  121.  */
  122. VXITEL_API VXItelResult VXItelCreateResource(VXIlogInterface *log,
  123.      VXItelInterface **tel);
  124. /**
  125.  * Destroys the specified VXItel implementation
  126.  *
  127.  * @param tel  [IN/OUT] Pointer to the VXItel object to be destroyed.  Set
  128.  *                      to NULL on return.
  129.  *
  130.  * @return VXItel_RESULT_SUCCESS if sucess, different value on failure
  131.  */
  132. VXITEL_API VXItelResult VXItelDestroyResource(VXItelInterface **tel);
  133. /*@}*/
  134. #include <VXIheaderSuffix.h>
  135. #ifdef __cplusplus
  136. }
  137. #endif
  138. #endif  /* include guard */