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

Telephony interface


Detailed Description

Abstract interface for telephony functionality.

VXItel provides the telephony functions for the VXI. The transfer type is split into bridge and blind transfers. These platform functions are platform and generally location dependant.


Classes

struct  VXItelInterface
 Abstract interface for telephony functionality. More...

Properties

Keys identifying properties in a VXIMap passed to VXItelInterface::TransferBlind, VXItelInterface::TransferBridge, and VXItelInterface::TransferConsultation.

#define TEL_CONNECTTIMEOUT   L"vxi.tel.connecttimeout"
 VXIInteger containing the connecttimeout property (in milliseconds).
#define TEL_MAX_CALL_TIME   L"vxi.tel.maxcalltime"
 VXIInteger containing the maxcalltime property (in milliseconds).
#define TEL_TRANSFER_DATA   L"vxi.tel.transfer.aai"
 VXIString containing the aai information.
#define TEL_TRANSFER_TYPE   L"vxi.tel.transfer.type"
 VXIString containing the type information.

Return keys

Keys identifying properties in a VXIMap returned by calls to VXItelInterface::TransferConsultation and VXItelInterface::TransferBridge.

#define TEL_TRANSFER_DURATION   L"vxi.tel.transfer.duration"
 VXIInteger containing the transfer duration in milliseconds.
#define TEL_TRANSFER_STATUS   L"vxi.tel.transfer.status"
 VXIInteger containing the status of the transfer, as defined by VXItelTransferStatus.

Typedefs

typedef enum VXItelResult VXItelResult
 Result codes for the telephony interface.
typedef enum VXItelStatus VXItelStatus
 Telephony line status.
typedef enum VXItelTransferStatus VXItelTransferStatus
 Result codes for transfer requests.
typedef VXItelInterface VXItelInterface
 Abstract interface for telephony functionality.

Enumerations

enum  VXItelResult {
  VXItel_RESULT_FATAL_ERROR = -100, VXItel_RESULT_DRIVER_ERROR = -50, VXItel_RESULT_IO_ERROR = -8, VXItel_RESULT_OUT_OF_MEMORY = -7,
  VXItel_RESULT_SYSTEM_ERROR = -6, VXItel_RESULT_PLATFORM_ERROR = -5, VXItel_RESULT_BUFFER_TOO_SMALL = -4, VXItel_RESULT_INVALID_PROP_NAME = -3,
  VXItel_RESULT_INVALID_PROP_VALUE = -2, VXItel_RESULT_INVALID_ARGUMENT = -1, VXItel_RESULT_SUCCESS = 0, VXItel_RESULT_FAILURE = 1,
  VXItel_RESULT_NON_FATAL_ERROR = 2, VXItel_RESULT_TIMEOUT = 3, VXItel_RESULT_CONNECTION_NO_AUTHORIZATION = 4, VXItel_RESULT_CONNECTION_BAD_DESTINATION = 5,
  VXItel_RESULT_CONNECTION_NO_ROUTE = 6, VXItel_RESULT_CONNECTION_NO_RESOURCE = 7, VXItel_RESULT_UNSUPPORTED_URI = 8, VXItel_RESULT_UNSUPPORTED = 100
}
 Result codes for the telephony interface. More...
enum  VXItelStatus { VXItel_STATUS_ACTIVE, VXItel_STATUS_INACTIVE }
 Telephony line status. More...
enum  VXItelTransferStatus {
  VXItel_TRANSFER_BUSY, VXItel_TRANSFER_NOANSWER, VXItel_TRANSFER_NETWORK_BUSY, VXItel_TRANSFER_NEAR_END_DISCONNECT,
  VXItel_TRANSFER_FAR_END_DISCONNECT, VXItel_TRANSFER_NETWORK_DISCONNECT, VXItel_TRANSFER_MAXTIME_DISCONNECT, VXItel_TRANSFER_CONNECTED,
  VXItel_TRANSFER_CALLER_HANGUP, VXItel_TRANSFER_UNKNOWN
}
 Result codes for transfer requests. More...


Define Documentation

#define TEL_CONNECTTIMEOUT   L"vxi.tel.connecttimeout"
 

VXIInteger containing the connecttimeout property (in milliseconds).

#define TEL_MAX_CALL_TIME   L"vxi.tel.maxcalltime"
 

VXIInteger containing the maxcalltime property (in milliseconds).

#define TEL_TRANSFER_DATA   L"vxi.tel.transfer.aai"
 

VXIString containing the aai information.

#define TEL_TRANSFER_DURATION   L"vxi.tel.transfer.duration"
 

VXIInteger containing the transfer duration in milliseconds.

#define TEL_TRANSFER_STATUS   L"vxi.tel.transfer.status"
 

VXIInteger containing the status of the transfer, as defined by VXItelTransferStatus.

#define TEL_TRANSFER_TYPE   L"vxi.tel.transfer.type"
 

VXIString containing the type information.


Typedef Documentation

typedef struct VXItelInterface VXItelInterface
 

Abstract interface for telephony functionality.

VXItel provides the telephony functions for the VXI. The transfer type is split into the bridge and blind transfers. These platform functions are very platform and generally location dependant.

There is one telephony interface per thread/line.

typedef enum VXItelResult VXItelResult
 

Result codes for the telephony interface.

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 enum VXItelStatus VXItelStatus
 

Telephony line status.

A line status of Active indicates that the line is currently occupied. It may be in a call or in a transfer.

typedef enum VXItelTransferStatus VXItelTransferStatus
 

Result codes for transfer requests.


Enumeration Type Documentation

enum VXItelResult
 

Result codes for the telephony interface.

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:
VXItel_RESULT_FATAL_ERROR  Fatal error, terminate call.
VXItel_RESULT_DRIVER_ERROR  Low-level telephony library error.
VXItel_RESULT_IO_ERROR  I/O error.
VXItel_RESULT_OUT_OF_MEMORY  Out of memory.
VXItel_RESULT_SYSTEM_ERROR  System error, out of service.
VXItel_RESULT_PLATFORM_ERROR  Errors from platform services.
VXItel_RESULT_BUFFER_TOO_SMALL  Return buffer too small.
VXItel_RESULT_INVALID_PROP_NAME  Property name is not valid.
VXItel_RESULT_INVALID_PROP_VALUE  Property value is not valid.
VXItel_RESULT_INVALID_ARGUMENT  Invalid function argument.
VXItel_RESULT_SUCCESS  Success.
VXItel_RESULT_FAILURE  Normal failure, nothing logged.
VXItel_RESULT_NON_FATAL_ERROR  Non-fatal non-specific error.
VXItel_RESULT_TIMEOUT  Operation is not supported.
VXItel_RESULT_CONNECTION_NO_AUTHORIZATION  Call is not allowed to the destination.
VXItel_RESULT_CONNECTION_BAD_DESTINATION  The destination URI is malformed.
VXItel_RESULT_CONNECTION_NO_ROUTE  The platform is not able to place a call to the destination.
VXItel_RESULT_CONNECTION_NO_RESOURCE  The platform cannot allocate resources to place the call.
VXItel_RESULT_UNSUPPORTED_URI  The platform does not support the URI format.
VXItel_RESULT_UNSUPPORTED  Operation is not supported.

enum VXItelStatus
 

Telephony line status.

A line status of Active indicates that the line is currently occupied. It may be in a call or in a transfer.

Enumeration values:
VXItel_STATUS_ACTIVE  In a call.
VXItel_STATUS_INACTIVE  Not in call.

enum VXItelTransferStatus
 

Result codes for transfer requests.

Enumeration values:
VXItel_TRANSFER_BUSY  The endpoint refused the call.
VXItel_TRANSFER_NOANSWER  There was no answer within the specified time.
VXItel_TRANSFER_NETWORK_BUSY  Some intermediate network refused the call.
VXItel_TRANSFER_NEAR_END_DISCONNECT  The call completed and was terminated by the caller.
VXItel_TRANSFER_FAR_END_DISCONNECT  The call completed and was terminated by the callee.
VXItel_TRANSFER_NETWORK_DISCONNECT  The call completed and was terminated by the network.
VXItel_TRANSFER_MAXTIME_DISCONNECT  The call duration exceeded the value of maxtime attribute and was terminated by the platform.
VXItel_TRANSFER_CONNECTED  The call is connected.

This should only be used for consultation type transfers, as bridges transfers don't expect it, and will set the field var to "unknown".

VXItel_TRANSFER_CALLER_HANGUP  The call was terminated due to the caller hanging up.
VXItel_TRANSFER_UNKNOWN  This value may be returned if the outcome of the transfer is unknown, for instance if the platform does not support reporting the outcome of transfer completion.

OpenVXI will treat this status as a successful transfer.


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