taf_dcs_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 TAF_DCS_INTERFACE_H_INCLUDE_GUARD
#define TAF_DCS_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

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

// Internal includes for this interface
#include "taf_dcs_common.h"
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_dcs_DisconnectHandler_t)(void *);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_dcs_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_TryConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_dcs_SetServerDisconnectHandler
(
    taf_dcs_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_dcs_SetNonExitServerDisconnectHandler
(
    taf_dcs_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_dcs_DisconnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_StartSession
(
    taf_dcs_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_dcs_StartSessionAsync
(
    taf_dcs_ProfileRef_t profileRef,
    taf_dcs_AsyncSessionHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_StopSession
(
    taf_dcs_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_dcs_StopSessionAsync
(
    taf_dcs_ProfileRef_t profileRef,
    taf_dcs_AsyncSessionHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetInterfaceName
(
    taf_dcs_ProfileRef_t profileRef,
    char* ifName,
    size_t ifNameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_dcs_SessionStateHandlerRef_t taf_dcs_AddSessionStateHandler
(
    taf_dcs_ProfileRef_t profileRef,
    taf_dcs_SessionStateHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_dcs_RemoveSessionStateHandler
(
    taf_dcs_SessionStateHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_dcs_RoamingStatusHandlerRef_t taf_dcs_AddRoamingStatusHandler
(
    taf_dcs_RoamingStatusHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_dcs_RemoveRoamingStatusHandler
(
    taf_dcs_RoamingStatusHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetRoamingStatus
(
    uint8_t phoneId,
    bool* isRoamingPtr,
    taf_dcs_RoamingType_t* typePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetIPv4Address
(
    taf_dcs_ProfileRef_t profileRef,
    char* ipAddr,
    size_t ipAddrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetIPv4GatewayAddress
(
    taf_dcs_ProfileRef_t profileRef,
    char* gatewayAddr,
    size_t gatewayAddrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetIPv4DNSAddresses
(
    taf_dcs_ProfileRef_t profileRef,
    char* dns1AddrStr,
    size_t dns1AddrStrSize,
    char* dns2AddrStr,
    size_t dns2AddrStrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetIPv6Address
(
    taf_dcs_ProfileRef_t profileRef,
    char* ipAddr,
    size_t ipAddrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetIPv6GatewayAddress
(
    taf_dcs_ProfileRef_t profileRef,
    char* gatewayAddr,
    size_t gatewayAddrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetIPv6DNSAddresses
(
    taf_dcs_ProfileRef_t profileRef,
    char* dns1AddrStr,
    size_t dns1AddrStrSize,
    char* dns2AddrStr,
    size_t dns2AddrStrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetSessionState
(
    taf_dcs_ProfileRef_t profileRef,
    taf_dcs_ConState_t* connectionStatePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool taf_dcs_IsIPv4
(
    taf_dcs_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool taf_dcs_IsIPv6
(
    taf_dcs_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetDataBearerTechnology
(
    taf_dcs_ProfileRef_t profileRef,
    taf_dcs_DataBearerTechnology_t* dlDataBearerTechPtrPtr,
    taf_dcs_DataBearerTechnology_t* ulDataBearerTechPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetProfileList
(
    taf_dcs_ProfileInfo_t* profileListPtr,
    size_t* profileListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetProfileListEx
(
    uint8_t phoneId,
    taf_dcs_ProfileInfo_t* profileListPtr,
    size_t* profileListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t taf_dcs_GetDefaultProfileIndex
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetDefaultPhoneIdAndProfileId
(
    uint8_t* phoneIdPtr,
    uint32_t* profileIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_SetDefaultProfileIndex
(
    uint32_t profileId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_SetDefaultProfileIndexEx
(
    uint8_t phoneId,
    uint32_t profileId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_dcs_ProfileRef_t taf_dcs_GetProfile
(
    uint32_t profileId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_dcs_ProfileRef_t taf_dcs_GetProfileEx
(
    uint8_t phoneId,
    uint32_t profileId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t taf_dcs_GetProfileIndex
(
    taf_dcs_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetPhoneId
(
    taf_dcs_ProfileRef_t profileRef,
    uint8_t* phoneIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_SetAPN
(
    taf_dcs_ProfileRef_t profileRef,
    const char* LE_NONNULL apnName
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetAPN
(
    taf_dcs_ProfileRef_t profileRef,
    char* apnName,
    size_t apnNameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetApnTypes
(
    taf_dcs_ProfileRef_t profileRef,
    taf_dcs_ApnType_t* apnTypePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_SetPDP
(
    taf_dcs_ProfileRef_t profileRef,
    taf_dcs_Pdp_t pdp
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_dcs_Pdp_t taf_dcs_GetPDP
(
    taf_dcs_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_SetAuthentication
(
    taf_dcs_ProfileRef_t profileRef,
    taf_dcs_Auth_t auth,
    const char* LE_NONNULL userName,
    const char* LE_NONNULL password
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetAuthentication
(
    taf_dcs_ProfileRef_t profileRef,
    taf_dcs_Auth_t* authPtr,
    char* userName,
    size_t userNameSize,
    char* password,
    size_t passwordSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetProfileIdByInterfaceName
(
    const char* LE_NONNULL ifName,
    uint32_t* profileIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_dcs_GetPhoneIdByInterfaceName
(
    const char* LE_NONNULL ifName,
    uint8_t* phoneIdPtr
);

#endif // TAF_DCS_INTERFACE_H_INCLUDE_GUARD