openD unified API  1.0.0
Classes | Macros | Typedefs | Enumerations | Functions
openD Call API

Classes

struct  openD_callApiPrimitives
 
struct  callApiReq_setup
 
struct  callApiReq_release
 
struct  callApiInd_setup
 
struct  callApiInd_release
 
struct  callApiInd_connectionStatus_ringing
 
struct  callApiInd_connectionStatus_connect
 
struct  callApiInd_connectionStatus_reject
 
struct  openD_callApiReq
 
union  openD_callApiReq.param
 
struct  openD_callApiCfm
 
union  openD_callApiCfm.param
 
struct  openD_callApiInd
 
union  openD_callApiInd.param
 

Macros

#define __OPEND_CALL_API_H__
 
#define __OPEND_CALL_TYPES_H__
 

Typedefs

typedef struct openD_callApiPrimitives openD_callApiPrimitives_t
 
typedef enum openD_callApi_service openD_callApi_service_t
 
typedef struct callApiReq_setup callApiReq_setup_t
 
typedef struct callApiReq_release callApiReq_release_t
 
typedef struct callApiInd_setup callApiInd_setup_t
 
typedef struct callApiInd_release callApiInd_release_t
 
typedef struct callApiInd_connectionStatus_ringing callApiInd_connectionStatus_ringing_t
 
typedef struct callApiInd_connectionStatus_connect callApiInd_connectionStatus_connect_t
 
typedef struct callApiInd_connectionStatus_reject callApiInd_connectionStatus_reject_t
 
typedef struct openD_callApiReq openD_callApiReq_t
 
typedef struct openD_callApiCfm openD_callApiCfm_t
 
typedef struct openD_callApiInd openD_callApiInd_t
 

Enumerations

enum  openD_callApi_service {
  OPEND_CALLAPI_SETUP, OPEND_CALLAPI_RELEASE, OPEND_CALLAPI_CONNECTION_STATUS_RINGING, OPEND_CALLAPI_CONNECTION_STATUS_CONNECT,
  OPEND_CALLAPI_CONNECTION_STATUS_REJECT
}
 

Functions

openD_status_t openD_callApi_init (openD_callApiPrimitives_t *cPrimitives)
 openD call API initialization. More...
 
openD_status_t openD_callApi_request (openD_callApiReq_t *cRequest)
 openD call API request. More...
 

Detailed Description

This module specifies the call API of openD connect.

This file defines the call types of openD connect.

Class Documentation

◆ callApiReq_setup

struct callApiReq_setup

openD SubApi request setup structure.

Class Members
pmid_t pmid

Subscribe enable.

◆ callApiReq_release

struct callApiReq_release

openD SubApi request release structure.

Class Members
pmid_t pmid

Portable part MAC Identity (PMID).

◆ callApiInd_setup

struct callApiInd_setup

openD SubApi indication setup structure.

Class Members
pmid_t pmid

Portable part MAC Identity (PMID).

◆ callApiInd_release

struct callApiInd_release

openD SubApi indication release structure.

Class Members
pmid_t pmid

Portable part MAC Identity (PMID).

◆ callApiInd_connectionStatus_ringing

struct callApiInd_connectionStatus_ringing

openD SubApi indication connectionStatus_ringing structure.

Class Members
pmid_t pmid

Portable part MAC Identity (PMID).

◆ callApiInd_connectionStatus_connect

struct callApiInd_connectionStatus_connect

openD SubApi indication connectionStatus_connect structure.

Class Members
pmid_t pmid

Portable part MAC Identity (PMID).

◆ callApiInd_connectionStatus_reject

struct callApiInd_connectionStatus_reject

openD SubApi indication connectionStatus_reject structure.

Class Members
pmid_t pmid

Portable part MAC Identity (PMID).

◆ openD_callApiReq

struct openD_callApiReq

openD CallApi request structure.

Class Members
union openD_callApiReq param

openD CallApi request parameters.

openD_callApi_service_t service

CallApi request service.

◆ openD_callApiReq.param

union openD_callApiReq.param

openD CallApi request parameters.

Class Members
callApiReq_release_t release

CallApi parameters for a release request.

callApiReq_setup_t setup

CallApi parameters for a setup request.

◆ openD_callApiCfm

struct openD_callApiCfm

openD CallApi confirm structure.

Class Members
union openD_callApiCfm param
openD_callApi_service_t service

CallApi confirm service.

openD_status_t status

CallApi service status.

◆ openD_callApiCfm.param

union openD_callApiCfm.param
Class Members
callApiReq_setup_t setup

CallApi parameters for a setup request.

◆ openD_callApiInd

struct openD_callApiInd

openD CallApi indication structure.

Class Members
union openD_callApiInd param

openD CallApi indication parameters.

openD_callApi_service_t service

CallApi indication service.

◆ openD_callApiInd.param

union openD_callApiInd.param

openD CallApi indication parameters.

Class Members
callApiInd_connectionStatus_connect_t connectionStatus_connect

CallApi parameter for a connectionStatus_connect indication.

callApiInd_connectionStatus_reject_t connectionStatus_reject

CallApi parameter for a connectionStatus_reject indication.

callApiInd_connectionStatus_ringing_t connectionStatus_ringing

CallApi parameter for a connectionStatus_ringing indication.

callApiInd_release_t release

CallApi parameter for a release indication.

callApiInd_setup_t setup

CallApi parameter for a setup indication.

Macro Definition Documentation

◆ __OPEND_CALL_API_H__

#define __OPEND_CALL_API_H__

◆ __OPEND_CALL_TYPES_H__

#define __OPEND_CALL_TYPES_H__

Typedef Documentation

◆ callApiInd_connectionStatus_connect_t

typedef struct callApiInd_connectionStatus_connect callApiInd_connectionStatus_connect_t

openD SubApi indication connectionStatus_connect structure.

◆ callApiInd_connectionStatus_reject_t

typedef struct callApiInd_connectionStatus_reject callApiInd_connectionStatus_reject_t

openD SubApi indication connectionStatus_reject structure.

◆ callApiInd_connectionStatus_ringing_t

typedef struct callApiInd_connectionStatus_ringing callApiInd_connectionStatus_ringing_t

openD SubApi indication connectionStatus_ringing structure.

◆ callApiInd_release_t

typedef struct callApiInd_release callApiInd_release_t

openD SubApi indication release structure.

◆ callApiInd_setup_t

typedef struct callApiInd_setup callApiInd_setup_t

openD SubApi indication setup structure.

◆ callApiReq_release_t

typedef struct callApiReq_release callApiReq_release_t

openD SubApi request release structure.

◆ callApiReq_setup_t

typedef struct callApiReq_setup callApiReq_setup_t

openD SubApi request setup structure.

◆ openD_callApi_service_t

typedef enum openD_callApi_service openD_callApi_service_t

openD CallApi services.

◆ openD_callApiCfm_t

typedef struct openD_callApiCfm openD_callApiCfm_t

openD CallApi confirm structure.

◆ openD_callApiInd_t

typedef struct openD_callApiInd openD_callApiInd_t

openD CallApi indication structure.

◆ openD_callApiPrimitives_t

typedef struct openD_callApiPrimitives openD_callApiPrimitives_t

openD CallApi primitives structure.

◆ openD_callApiReq_t

typedef struct openD_callApiReq openD_callApiReq_t

openD CallApi request structure.

Enumeration Type Documentation

◆ openD_callApi_service

enum openD_callApi_service

openD CallApi services.

Enumerator
OPEND_CALLAPI_SETUP 

Setup.

OPEND_CALLAPI_RELEASE 

Release.

OPEND_CALLAPI_CONNECTION_STATUS_RINGING 

Connection status ringing.

OPEND_CALLAPI_CONNECTION_STATUS_CONNECT 

Connection status connect.

OPEND_CALLAPI_CONNECTION_STATUS_REJECT 

Connection status reject.

Function Documentation

◆ openD_callApi_init()

openD_status_t openD_callApi_init ( openD_callApiPrimitives_t *  cPrimitives)

openD call API initialization.

Parameters
cPrimitivesPointer of the call API primitives structure (openD_callApiPrimitives_t).
Return values
Statusof the operation (openD_status_t).

◆ openD_callApi_request()

openD_status_t openD_callApi_request ( openD_callApiReq_t *  cRequest)

openD call API request.

Parameters
cRequestPointer of the call API request structure (openD_callApiReq_t).
Return values
Statusof the operation (openD_status_t).