taf_voicecall_common.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */
#ifndef TAF_VOICECALL_COMMON_H_INCLUDE_GUARD
#define TAF_VOICECALL_COMMON_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "taf_types_common.h"

#define IFGEN_TAF_VOICECALL_PROTOCOL_ID "9d88c6710fe7cde0980776c02d1464d1"
#define IFGEN_TAF_VOICECALL_MSG_SIZE 38



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_VOICECALL_EVENT_CONNECTED 2

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_VOICECALL_EVENT_TERMINATED 3

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_VOICECALL_EVENT_BUSY 5

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_VOICECALL_TERM_NETWORK_FAIL 1

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_VOICECALL_TERM_BAD_ADDRESS 2

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_VOICECALL_TERM_BUSY 3

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_VOICECALL_TERM_LOCAL_ENDED 4

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_VOICECALL_TERM_REMOTE_ENDED 5

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_VOICECALL_TERM_UNDEFINED 6

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_voicecall_Call* taf_voicecall_CallRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_VOICECALL_EVENT_ALERTING = 1,
    TAF_VOICECALL_EVENT_ACTIVE = 2,
    TAF_VOICECALL_EVENT_ENDED = 3,
    TAF_VOICECALL_EVENT_OFFLINE = 4,
    TAF_VOICECALL_EVENT_WAITING = 5,
    TAF_VOICECALL_EVENT_RESOURCE_BUSY = 6,
    TAF_VOICECALL_EVENT_CALL_END_FAILED = 7,
    TAF_VOICECALL_EVENT_CALL_ANSWER_FAILED = 8,
    TAF_VOICECALL_EVENT_INCOMING = 9,
    TAF_VOICECALL_EVENT_ONHOLD = 10,
    TAF_VOICECALL_EVENT_DIALING = 11,
    TAF_VOICECALL_EVENT_CALL_HOLD_FAILED = 12,
    TAF_VOICECALL_EVENT_CALL_RESUME_FAILED = 13,
    TAF_VOICECALL_EVENT_CALL_SWAP_FAILED = 14
}
taf_voicecall_Event_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_VOICECALL_END_NORMAL = 0,
    TAF_VOICECALL_END_NETWORK_FAIL = 1,
    TAF_VOICECALL_END_UNOBTAINABLE_NUMBER = 2,
    TAF_VOICECALL_END_BUSY = 3,
    TAF_VOICECALL_END_LOCAL = 4,
    TAF_VOICECALL_END_REMOTE = 5,
    TAF_VOICECALL_END_UNDEFINED = 6,
    TAF_VOICECALL_END_REJECTED = 7,
    TAF_VOICECALL_END_NORESPONSE = 8
}
taf_voicecall_CallEndCause_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_voicecall_StateHandler* taf_voicecall_StateHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_voicecall_StateHandlerFunc_t)
(
        taf_voicecall_CallRef_t reference,
        const char* LE_NONNULL identifer,
        taf_voicecall_Event_t event,
        void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_voicecall_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_voicecall_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_voicecall_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_voicecall_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_voicecall_StateHandlerRef_t ifgen_taf_voicecall_AddStateHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_voicecall_StateHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_voicecall_RemoveStateHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_voicecall_StateHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_voicecall_CallRef_t ifgen_taf_voicecall_Start
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL destinationID,
        uint8_t phoneId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_voicecall_End
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_voicecall_CallRef_t reference
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_voicecall_Delete
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_voicecall_CallRef_t reference
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_voicecall_Answer
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_voicecall_CallRef_t reference
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_voicecall_GetEndCause
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_voicecall_CallRef_t reference,
        taf_voicecall_CallEndCause_t* causePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_voicecall_Hold
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_voicecall_CallRef_t reference
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_voicecall_Resume
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_voicecall_CallRef_t reference
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_voicecall_Swap
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_voicecall_CallRef_t reference
);

#endif // TAF_VOICECALL_COMMON_H_INCLUDE_GUARD