le_mdc.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

#ifndef LEGATO_LE_MDC_INCLUDE_GUARD
#define LEGATO_LE_MDC_INCLUDE_GUARD


#include "legato.h"

//--------------------------------------------------------------------------------------------------
// Symbol and Enum definitions.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

#define LE_MDC_PROFILE_NAME_MAX_LEN   50
#define LE_MDC_PROFILE_NAME_MAX_BYTES (LE_MDC_PROFILE_NAME_MAX_LEN+1)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MDC_DATA_BEARER_TECHNOLOGY_UNKNOWN = 0,              
    LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_1X,              
    LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_HRPD,            
    LE_MDC_DATA_BEARER_TECHNOLOGY_GSM,                      
    LE_MDC_DATA_BEARER_TECHNOLOGY_UMTS,                     
    LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA200_HRPD,             
    LE_MDC_DATA_BEARER_TECHNOLOGY_EDGE,                     
    LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPA_WCDMA,              
    LE_MDC_DATA_BEARER_TECHNOLOGY_WCDMA_HSUPA,              
    LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPA_HSUPA,              
    LE_MDC_DATA_BEARER_TECHNOLOGY_LTE,                      
    LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_EHRPD,           
    LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_WCDMA,          
    LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_HSUPA,          
    LE_MDC_DATA_BEARER_TECHNOLOGY_DC_HSDPAPLUS_WCDMA,       
    LE_MDC_DATA_BEARER_TECHNOLOGY_DC_HSDPAPLUS_HSUPA,       
    LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_64QAM,          
    LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_64QAM_HSUPA,    
    LE_MDC_DATA_BEARER_TECHNOLOGY_TDSCDMA,                  
    LE_MDC_DATA_BEARER_TECHNOLOGY_TDSCDMA_HSDPA,            
    LE_MDC_DATA_BEARER_TECHNOLOGY_TDSCDMA_HSUPA,            
}
le_mdc_dataBearerTechnology_t;

//--------------------------------------------------------------------------------------------------
// API type definitions.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mdc_Profile* le_mdc_ProfileRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mdc_SessionStateHandler* le_mdc_SessionStateHandlerRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_mdc_SessionStateHandlerFunc_t)
(
    bool   isConnected,
    void*  contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mdc_ProfileRef_t le_mdc_LoadProfile
(
    const char* nameStr                 
);



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetProfileName
(
    le_mdc_ProfileRef_t profileRef,        
    char*  nameStr,                         
    size_t nameStrSize                      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_StartSession
(
    le_mdc_ProfileRef_t profileRef     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_StopSession
(
    le_mdc_ProfileRef_t profileRef     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetSessionState
(
    le_mdc_ProfileRef_t profileRef,        
    bool* isConnectedPtr                    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mdc_SessionStateHandlerRef_t le_mdc_AddSessionStateHandler
(
    le_mdc_ProfileRef_t profileRef,        
    le_mdc_SessionStateHandlerFunc_t handler,   
    void* contextPtr                        
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mdc_RemoveSessionStateHandler
(
    le_mdc_SessionStateHandlerRef_t    handlerRef 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetInterfaceName
(
    le_mdc_ProfileRef_t profileRef,        
    char*  interfaceNameStr,                
    size_t interfaceNameStrSize             
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv4Address
(
    le_mdc_ProfileRef_t profileRef,   
    char*  ipAddrStr,                  
    size_t ipAddrStrSize               
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv4GatewayAddress
(
    le_mdc_ProfileRef_t profileRef,        
    char*  gatewayAddrStr,                  
    size_t gatewayAddrStrSize               
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv4DNSAddresses
(
    le_mdc_ProfileRef_t profileRef,         
    char*  dns1AddrStr,                     
    size_t dns1AddrStrSize,                 
    char*  dns2AddrStr,                     
    size_t dns2AddrStrSize                  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv6Address
(
    le_mdc_ProfileRef_t profileRef,    
    char*  ipAddrStr,                  
    size_t ipAddrStrSize               
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv6GatewayAddress
(
    le_mdc_ProfileRef_t profileRef,         
    char*  gatewayAddrStr,                  
    size_t gatewayAddrStrSize               
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv6DNSAddresses
(
    le_mdc_ProfileRef_t profileRef,        
    char*  dns1AddrStr,                     
    size_t dns1AddrStrSize,                 
    char*  dns2AddrStr,                     
    size_t dns2AddrStrSize                  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mdc_IsIPv4
(
    le_mdc_ProfileRef_t profileRef        
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mdc_IsIPv6
(
    le_mdc_ProfileRef_t profileRef        
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetBytesCounters
(
    uint64_t *rxBytes,  
    uint64_t *txBytes   
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_ResetBytesCounter
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetAccessPointName
(
    le_mdc_ProfileRef_t profileRef,   
    char*  apnNameStr,                 
    size_t apnNameStrSize              
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetDataBearerTechnology
(
    le_mdc_ProfileRef_t profileRef,                        
    le_mdc_dataBearerTechnology_t* dataBearerTechnologyPtr  
);


#endif // LEGATO_LE_MDC_INCLUDE_GUARD