taf_mngdConn_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_MNGDCONN_COMMON_H_INCLUDE_GUARD
#define TAF_MNGDCONN_COMMON_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "taf_sim_common.h"
#include "taf_radio_common.h"
#include "taf_dcs_common.h"

#define IFGEN_TAF_MNGDCONN_PROTOCOL_ID "feb1441f3017abb1a34087f85f0ee150"
#define IFGEN_TAF_MNGDCONN_MSG_SIZE 82



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_MNGDCONN_MAX_NAME_LEN 32

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_mngdConn_Data* taf_mngdConn_DataRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_MNGDCONN_DATA_DISCONNECTED = 0,
    TAF_MNGDCONN_DATA_CONNECTED = 1,
    TAF_MNGDCONN_DATA_CONNECTION_FAILED = 2,
    TAF_MNGDCONN_DATA_CONNECTION_STALLED = 3
}
taf_mngdConn_DataState_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_mngdConn_DataStateHandler* taf_mngdConn_DataStateHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_MNGDCONN_RECOVERY_L1_SCHEDULED = 0,
    TAF_MNGDCONN_RECOVERY_L1_STARTED = 1,
    TAF_MNGDCONN_RECOVERY_L1_CANCELED = 2,
    TAF_MNGDCONN_RECOVERY_L2_SCHEDULED = 3,
    TAF_MNGDCONN_RECOVERY_L2_STARTED = 4,
    TAF_MNGDCONN_RECOVERY_L2_CANCELED = 5
}
taf_mngdConn_RecoveryState_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_mngdConn_RecoveryStateHandler* taf_mngdConn_RecoveryStateHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_mngdConn_DataStateHandlerFunc_t)
(
        taf_mngdConn_DataRef_t dataRef,
        taf_mngdConn_DataState_t state,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_mngdConn_RecoveryStateHandlerFunc_t)
(
        taf_mngdConn_RecoveryState_t state,
        taf_mngdConn_DataRef_t dataRef,
        void* contextPtr
);


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_mngdConn_InitCommonData
(
    void
);


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


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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_mngdConn_DataStateHandlerRef_t ifgen_taf_mngdConn_AddDataStateHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef,
        taf_mngdConn_DataStateHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_mngdConn_RemoveDataStateHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataStateHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_mngdConn_RecoveryStateHandlerRef_t ifgen_taf_mngdConn_AddRecoveryStateHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_RecoveryStateHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_mngdConn_RemoveRecoveryStateHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_RecoveryStateHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_mngdConn_DataRef_t ifgen_taf_mngdConn_GetData
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t dataId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_mngdConn_DataRef_t ifgen_taf_mngdConn_GetDataByName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL dataName
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_mngdConn_GetDataIdByRef
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef,
        uint8_t* dataIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_mngdConn_GetDataNameByRef
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef,
        char* dataName,
        size_t dataNameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_mngdConn_StartData
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_mngdConn_StopData
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_mngdConn_GetDataConnectionState
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef,
        taf_mngdConn_DataState_t* statePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_mngdConn_GetDataConnectionIPAddresses
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef,
        char* IPv4Addr,
        size_t IPv4AddrSize,
        char* IPv6Addr,
        size_t IPv6AddrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_mngdConn_StartDataRetry
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_mngdConn_CancelL1Recovery
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_mngdConn_CancelL2Recovery
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_mngdConn_DataRef_t dataRef
);

#endif // TAF_MNGDCONN_COMMON_H_INCLUDE_GUARD