le_mcc_interface.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 LE_MCC_INTERFACE_H_INCLUDE_GUARD
#define LE_MCC_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mcc_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mcc_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MCC_EVENT_SETUP,

    LE_MCC_EVENT_INCOMING,

    LE_MCC_EVENT_ORIGINATING,

    LE_MCC_EVENT_ALERTING,

    LE_MCC_EVENT_CONNECTED,

    LE_MCC_EVENT_TERMINATED,

    LE_MCC_EVENT_WAITING,

    LE_MCC_EVENT_ON_HOLD,

    LE_MCC_EVENT_MAX
}
le_mcc_Event_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MCC_TERM_LOCAL_ENDED,

    LE_MCC_TERM_REMOTE_ENDED,

    LE_MCC_TERM_NETWORK_FAIL,

    LE_MCC_TERM_UNASSIGNED_NUMBER,

    LE_MCC_TERM_NO_ROUTE_TO_DESTINATION,

    LE_MCC_TERM_CHANNEL_UNACCEPTABLE,

    LE_MCC_TERM_OPERATOR_DETERMINED_BARRING,

    LE_MCC_TERM_USER_BUSY,

    LE_MCC_TERM_NO_USER_RESPONDING,

    LE_MCC_TERM_USER_ALERTING_NO_ANSWER,

    LE_MCC_TERM_CALL_REJECTED,

    LE_MCC_TERM_NUMBER_CHANGED,

    LE_MCC_TERM_PREEMPTION,

    LE_MCC_TERM_DESTINATION_OUT_OF_ORDER,

    LE_MCC_TERM_INVALID_NUMBER_FORMAT,

    LE_MCC_TERM_FACILITY_REJECTED,

    LE_MCC_TERM_RESP_TO_STATUS_ENQUIRY,

    LE_MCC_TERM_NORMAL_UNSPECIFIED,

    LE_MCC_TERM_NO_CIRCUIT_OR_CHANNEL_AVAILABLE,

    LE_MCC_TERM_NETWORK_OUT_OF_ORDER,

    LE_MCC_TERM_TEMPORARY_FAILURE,

    LE_MCC_TERM_SWITCHING_EQUIPMENT_CONGESTION,

    LE_MCC_TERM_ACCESS_INFORMATION_DISCARDED,

    LE_MCC_TERM_REQUESTED_CIRCUIT_OR_CHANNEL_NOT_AVAILABLE,

    LE_MCC_TERM_RESOURCES_UNAVAILABLE_OR_UNSPECIFIED,

    LE_MCC_TERM_QOS_UNAVAILABLE,

    LE_MCC_TERM_REQUESTED_FACILITY_NOT_SUBSCRIBED,

    LE_MCC_TERM_INCOMING_CALLS_BARRED_WITHIN_CUG,

    LE_MCC_TERM_BEARER_CAPABILITY_NOT_AUTH,

    LE_MCC_TERM_BEARER_CAPABILITY_UNAVAILABLE,

    LE_MCC_TERM_SERVICE_OPTION_NOT_AVAILABLE,

    LE_MCC_TERM_ACM_LIMIT_EXCEEDED,

    LE_MCC_TERM_BEARER_SERVICE_NOT_IMPLEMENTED,

    LE_MCC_TERM_REQUESTED_FACILITY_NOT_IMPLEMENTED,

    LE_MCC_TERM_ONLY_DIGITAL_INFORMATION_BEARER_AVAILABLE,

    LE_MCC_TERM_SERVICE_OR_OPTION_NOT_IMPLEMENTED,

    LE_MCC_TERM_INVALID_TRANSACTION_IDENTIFIER,

    LE_MCC_TERM_USER_NOT_MEMBER_OF_CUG,

    LE_MCC_TERM_INCOMPATIBLE_DESTINATION,

    LE_MCC_TERM_INVALID_TRANSIT_NW_SELECTION,

    LE_MCC_TERM_SEMANTICALLY_INCORRECT_MESSAGE,

    LE_MCC_TERM_INVALID_MANDATORY_INFORMATION,

    LE_MCC_TERM_MESSAGE_TYPE_NON_IMPLEMENTED,

    LE_MCC_TERM_MESSAGE_TYPE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE,

    LE_MCC_TERM_INFORMATION_ELEMENT_NON_EXISTENT,

    LE_MCC_TERM_CONDITONAL_IE_ERROR,

    LE_MCC_TERM_MESSAGE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE,

    LE_MCC_TERM_RECOVERY_ON_TIMER_EXPIRY,

    LE_MCC_TERM_PROTOCOL_ERROR_UNSPECIFIED,

    LE_MCC_TERM_INTERWORKING_UNSPECIFIED,

    LE_MCC_TERM_PLATFORM_SPECIFIC,

    LE_MCC_TERM_UNDEFINED
}
le_mcc_TerminationReason_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mcc_Call* le_mcc_CallRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mcc_CallEventHandler* le_mcc_CallEventHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_mcc_CallEventHandlerFunc_t)
(
    le_mcc_CallRef_t callRef,
    le_mcc_Event_t event,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_CallRef_t le_mcc_Create
(
    const char* phoneNumPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_Delete
(
    le_mcc_CallRef_t callRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_Start
(
    le_mcc_CallRef_t callRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mcc_IsConnected
(
    le_mcc_CallRef_t callRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_GetRemoteTel
(
    le_mcc_CallRef_t callRef,

    char* telPtr,

    size_t telPtrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_TerminationReason_t le_mcc_GetTerminationReason
(
    le_mcc_CallRef_t callRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_mcc_GetPlatformSpecificTerminationCode
(
    le_mcc_CallRef_t callRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_Answer
(
    le_mcc_CallRef_t callRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_HangUp
(
    le_mcc_CallRef_t callRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_HangUpAll
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_GetCallerIdRestrict
(
    le_mcc_CallRef_t callRef,

    le_onoff_t* clirStatusPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_SetCallerIdRestrict
(
    le_mcc_CallRef_t callRef,

    le_onoff_t clirStatus
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_CallEventHandlerRef_t le_mcc_AddCallEventHandler
(
    le_mcc_CallEventHandlerFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mcc_RemoveCallEventHandler
(
    le_mcc_CallEventHandlerRef_t addHandlerRef
);


#endif // LE_MCC_INTERFACE_H_INCLUDE_GUARD