le_mdc_interface.h
Go to the documentation of this file.
39 * le_mdc_GetProfile() must be called with @c LE_MDC_DEFAULT_PROFILE to retrieve the default index41 * le_mdc_GetProfile() must be called with @c LE_MDC_SIMTOOLKIT_BIP_DEFAULT_PROFILE to retrieve the54 * identification number (ICCID). If no match is found in the database using the ICCID, the search85 * The current state of a data session can be queried using le_mdc_GetSessionState(). An application134 * These values correspond to the number of bytes received/transmitted since the last software reset174 //--------------------------------------------------------------------------------------------------177 * Connect the current client thread to the service providing this API. Block until the service is180 * For each thread that wants to use this API, either ConnectService or TryConnectService must be181 * called before any other functions in this API. Normally, ConnectService is automatically called186 //--------------------------------------------------------------------------------------------------192 //--------------------------------------------------------------------------------------------------195 * Try to connect the current client thread to the service providing this API. Return with an error198 * For each thread that wants to use this API, either ConnectService or TryConnectService must be199 * called before any other functions in this API. Normally, ConnectService is automatically called206 * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.207 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).210 //--------------------------------------------------------------------------------------------------216 //--------------------------------------------------------------------------------------------------222 * longer a connection to the service, and the functions in this API can't be used. For details, see227 //--------------------------------------------------------------------------------------------------234 //--------------------------------------------------------------------------------------------------238 //--------------------------------------------------------------------------------------------------242 //--------------------------------------------------------------------------------------------------246 //--------------------------------------------------------------------------------------------------250 //--------------------------------------------------------------------------------------------------254 //--------------------------------------------------------------------------------------------------258 //--------------------------------------------------------------------------------------------------262 //--------------------------------------------------------------------------------------------------266 //--------------------------------------------------------------------------------------------------270 //--------------------------------------------------------------------------------------------------274 //--------------------------------------------------------------------------------------------------278 //--------------------------------------------------------------------------------------------------282 //--------------------------------------------------------------------------------------------------286 //--------------------------------------------------------------------------------------------------290 //--------------------------------------------------------------------------------------------------294 //--------------------------------------------------------------------------------------------------298 //--------------------------------------------------------------------------------------------------302 //--------------------------------------------------------------------------------------------------306 //--------------------------------------------------------------------------------------------------310 //--------------------------------------------------------------------------------------------------314 //--------------------------------------------------------------------------------------------------318 //--------------------------------------------------------------------------------------------------322 //--------------------------------------------------------------------------------------------------326 //--------------------------------------------------------------------------------------------------330 //--------------------------------------------------------------------------------------------------334 //--------------------------------------------------------------------------------------------------338 //--------------------------------------------------------------------------------------------------342 //--------------------------------------------------------------------------------------------------346 //--------------------------------------------------------------------------------------------------350 //--------------------------------------------------------------------------------------------------354 //--------------------------------------------------------------------------------------------------358 //--------------------------------------------------------------------------------------------------406 //--------------------------------------------------------------------------------------------------410 //--------------------------------------------------------------------------------------------------428 //--------------------------------------------------------------------------------------------------432 //--------------------------------------------------------------------------------------------------447 //--------------------------------------------------------------------------------------------------451 //--------------------------------------------------------------------------------------------------472 //--------------------------------------------------------------------------------------------------476 //--------------------------------------------------------------------------------------------------620 //--------------------------------------------------------------------------------------------------624 //--------------------------------------------------------------------------------------------------628 //--------------------------------------------------------------------------------------------------632 //--------------------------------------------------------------------------------------------------636 //--------------------------------------------------------------------------------------------------646 //--------------------------------------------------------------------------------------------------648 (655 //--------------------------------------------------------------------------------------------------663 //--------------------------------------------------------------------------------------------------665 (671 //--------------------------------------------------------------------------------------------------682 //--------------------------------------------------------------------------------------------------684 (690 //--------------------------------------------------------------------------------------------------694 * This event provides information on data session connection state changes for the given profileRef.696 //--------------------------------------------------------------------------------------------------709 //--------------------------------------------------------------------------------------------------713 //--------------------------------------------------------------------------------------------------720 //--------------------------------------------------------------------------------------------------724 * This event provides information on data session connection state changes for the given profileRef.726 //--------------------------------------------------------------------------------------------------736 //--------------------------------------------------------------------------------------------------740 //--------------------------------------------------------------------------------------------------747 //--------------------------------------------------------------------------------------------------761 //--------------------------------------------------------------------------------------------------768 //--------------------------------------------------------------------------------------------------778 //--------------------------------------------------------------------------------------------------785 //--------------------------------------------------------------------------------------------------798 //--------------------------------------------------------------------------------------------------805 //--------------------------------------------------------------------------------------------------812 //--------------------------------------------------------------------------------------------------825 //--------------------------------------------------------------------------------------------------837 //--------------------------------------------------------------------------------------------------844 //--------------------------------------------------------------------------------------------------851 //--------------------------------------------------------------------------------------------------864 //--------------------------------------------------------------------------------------------------876 //--------------------------------------------------------------------------------------------------883 //--------------------------------------------------------------------------------------------------895 //--------------------------------------------------------------------------------------------------905 //--------------------------------------------------------------------------------------------------917 //--------------------------------------------------------------------------------------------------930 //--------------------------------------------------------------------------------------------------943 //--------------------------------------------------------------------------------------------------956 //--------------------------------------------------------------------------------------------------958 * Get the gateway IPv4 address for the given profile, if the data session is connected and has an969 //--------------------------------------------------------------------------------------------------982 //--------------------------------------------------------------------------------------------------997 //--------------------------------------------------------------------------------------------------1016 //--------------------------------------------------------------------------------------------------1029 //--------------------------------------------------------------------------------------------------1042 //--------------------------------------------------------------------------------------------------1044 * Get the gateway IPv6 address for the given profile, if the data session is connected and has an1055 //--------------------------------------------------------------------------------------------------1068 //--------------------------------------------------------------------------------------------------1083 //--------------------------------------------------------------------------------------------------1102 //--------------------------------------------------------------------------------------------------1104 * Allow the caller to know if the given profile is actually supporting IPv4, if the data session1112 //--------------------------------------------------------------------------------------------------1119 //--------------------------------------------------------------------------------------------------1121 * Allow the caller to know if the given profile is actually supporting IPv6, if the data session1129 //--------------------------------------------------------------------------------------------------1136 //--------------------------------------------------------------------------------------------------1147 //--------------------------------------------------------------------------------------------------1160 //--------------------------------------------------------------------------------------------------1171 //--------------------------------------------------------------------------------------------------1181 //--------------------------------------------------------------------------------------------------1189 //--------------------------------------------------------------------------------------------------1195 //--------------------------------------------------------------------------------------------------1207 //--------------------------------------------------------------------------------------------------1217 //--------------------------------------------------------------------------------------------------1227 //--------------------------------------------------------------------------------------------------1234 //--------------------------------------------------------------------------------------------------1250 //--------------------------------------------------------------------------------------------------1260 //--------------------------------------------------------------------------------------------------1274 //--------------------------------------------------------------------------------------------------1281 //--------------------------------------------------------------------------------------------------1294 //--------------------------------------------------------------------------------------------------1307 //--------------------------------------------------------------------------------------------------1321 * @note Both PAP and CHAP authentification can be set for 3GPP network: in this case, the device1326 //--------------------------------------------------------------------------------------------------1342 //--------------------------------------------------------------------------------------------------1355 //--------------------------------------------------------------------------------------------------1377 //--------------------------------------------------------------------------------------------------1384 //--------------------------------------------------------------------------------------------------1390 //--------------------------------------------------------------------------------------------------1399 //--------------------------------------------------------------------------------------------------1409 //--------------------------------------------------------------------------------------------------1418 //--------------------------------------------------------------------------------------------------1425 //--------------------------------------------------------------------------------------------------1434 //--------------------------------------------------------------------------------------------------1441 //--------------------------------------------------------------------------------------------------1448 //--------------------------------------------------------------------------------------------------le_result_t le_mdc_GetSessionState(le_mdc_ProfileRef_t profileRef, le_mdc_ConState_t *connectionStatePtr)le_mdc_SessionStateHandlerRef_t le_mdc_AddSessionStateHandler(le_mdc_ProfileRef_t profileRef, le_mdc_SessionStateHandlerFunc_t handlerPtr, void *contextPtr)le_mdc_Pdp_t le_mdc_GetPDP(le_mdc_ProfileRef_t profileRef)void le_mdc_StartSessionAsync(le_mdc_ProfileRef_t profileRef, le_mdc_SessionHandlerFunc_t handlerPtr, void *contextPtr)le_result_t le_mdc_GetDataBearerTechnology(le_mdc_ProfileRef_t profileRef, le_mdc_DataBearerTechnology_t *downlinkDataBearerTechPtrPtr, le_mdc_DataBearerTechnology_t *uplinkDataBearerTechPtrPtr)le_result_t le_mdc_GetInterfaceName(le_mdc_ProfileRef_t profileRef, char *interfaceName, size_t interfaceNameNumElements)struct le_mdc_SessionStateHandler * le_mdc_SessionStateHandlerRef_tDefinition: le_mdc_interface.h:625le_result_t le_mdc_GetIPv4GatewayAddress(le_mdc_ProfileRef_t profileRef, char *gatewayAddr, size_t gatewayAddrNumElements)bool le_mdc_IsIPv4(le_mdc_ProfileRef_t profileRef)le_result_t le_mdc_StopSession(le_mdc_ProfileRef_t profileRef)le_result_t le_mdc_GetAuthentication(le_mdc_ProfileRef_t profileRef, le_mdc_Auth_t *typePtr, char *userName, size_t userNameNumElements, char *password, size_t passwordNumElements)cf. 3GPP 24.008 Annex I2Definition: le_mdc_interface.h:605void le_mdc_ConnectService(void)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:485void le_mdc_StopSessionAsync(le_mdc_ProfileRef_t profileRef, le_mdc_SessionHandlerFunc_t handlerPtr, void *contextPtr)cf. 3GPP 24.008 Annex I2Definition: le_mdc_interface.h:590le_result_t le_mdc_SetPDP(le_mdc_ProfileRef_t profileRef, le_mdc_Pdp_t pdp)le_result_t le_mdc_GetAPN(le_mdc_ProfileRef_t profileRef, char *apnStr, size_t apnStrNumElements)void(* le_mdc_MtPdpSessionStateHandlerFunc_t)(le_mdc_ConState_t ConnectionState, void *contextPtr)Definition: le_mdc_interface.h:665bool le_mdc_IsIPv6(le_mdc_ProfileRef_t profileRef)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:557le_result_t le_mdc_GetBytesCounters(uint64_t *rxBytesPtr, uint64_t *txBytesPtr)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:515cf. 3GPP 24.008 Annex I2Definition: le_mdc_interface.h:596CDMA2000 HRPD (1xEV-DO)Definition: le_mdc_interface.h:394cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:578le_mdc_DisconnectionReason_t le_mdc_GetDisconnectionReason(le_mdc_ProfileRef_t profileRef)void le_mdc_RemoveSessionStateHandler(le_mdc_SessionStateHandlerRef_t addHandlerRef)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:548le_result_t le_mdc_GetIPv6DNSAddresses(le_mdc_ProfileRef_t profileRef, char *dns1AddrStr, size_t dns1AddrStrNumElements, char *dns2AddrStr, size_t dns2AddrStrNumElements)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:512le_result_t le_mdc_GetIPv4DNSAddresses(le_mdc_ProfileRef_t profileRef, char *dns1AddrStr, size_t dns1AddrStrNumElements, char *dns2AddrStr, size_t dns2AddrStrNumElements)void le_mdc_GetPlatformSpecificFailureConnectionReason(le_mdc_ProfileRef_t profileRef, int32_t *failureTypePtr, int32_t *failureCodePtr)le_result_t le_mdc_GetIPv6Address(le_mdc_ProfileRef_t profileRef, char *ipAddr, size_t ipAddrNumElements)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:500le_result_t le_mdc_TryConnectService(void)le_mdc_ProfileRef_t le_mdc_GetProfile(uint32_t index)int32_t le_mdc_GetPlatformSpecificDisconnectionCode(le_mdc_ProfileRef_t profileRef)le_result_t le_mdc_StartSession(le_mdc_ProfileRef_t profileRef)le_result_t le_mdc_ResetBytesCounter(void)void le_mdc_DisconnectService(void)struct le_mdc_MtPdpSessionStateHandler * le_mdc_MtPdpSessionStateHandlerRef_tDefinition: le_mdc_interface.h:633le_mdc_MtPdpSessionStateHandlerRef_t le_mdc_AddMtPdpSessionStateHandler(le_mdc_SessionStateHandlerFunc_t handlerPtr, void *contextPtr)le_result_t le_mdc_GetIPv4Address(le_mdc_ProfileRef_t profileRef, char *ipAddr, size_t ipAddrNumElements)le_result_t le_mdc_SetAuthentication(le_mdc_ProfileRef_t profileRef, le_mdc_Auth_t type, const char *userName, const char *password)le_result_t le_mdc_GetProfileFromApn(const char *apnStr, le_mdc_ProfileRef_t *profileRefPtr)uint32_t le_mdc_GetProfileIndex(le_mdc_ProfileRef_t profileRef)uint32_t le_mdc_NumProfiles(void)le_result_t le_mdc_SetDefaultAPN(le_mdc_ProfileRef_t profileRef)le_result_t le_mdc_RejectMtPdpSession(le_mdc_ProfileRef_t profileRef)void(* le_mdc_SessionHandlerFunc_t)(le_mdc_ProfileRef_t profileRef, le_result_t result, void *contextPtr)Definition: le_mdc_interface.h:684cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:569CDMA2000 HRPD (1xEV-DO RevA)Definition: le_mdc_interface.h:397le_result_t le_mdc_SetAPN(le_mdc_ProfileRef_t profileRef, const char *apnStr)void(* le_mdc_SessionStateHandlerFunc_t)(le_mdc_ProfileRef_t profileRef, le_mdc_ConState_t ConnectionState, void *contextPtr)Definition: le_mdc_interface.h:648le_result_t le_mdc_GetIPv6GatewayAddress(le_mdc_ProfileRef_t profileRef, char *gatewayAddr, size_t gatewayAddrNumElements)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:551cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:506cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:503void le_mdc_RemoveMtPdpSessionStateHandler(le_mdc_MtPdpSessionStateHandlerRef_t addHandlerRef)