le_mdc_interface.h
Go to the documentation of this file.
41 * le_mdc_GetProfile() must be called with @c LE_MDC_DEFAULT_PROFILE to retrieve the default index43 * le_mdc_GetProfile() must be called with @c LE_MDC_SIMTOOLKIT_BIP_DEFAULT_PROFILE to retrieve the56 * identification number (ICCID). If no match is found in the database using the ICCID, the search81 * le_mdc_MapProfileOnNetworkInterface() may be used to map a data session with a network interface.95 * The current state of a data session can be queried using le_mdc_GetSessionState(). An application103 * the application takes responsibility to trigger the data session for that MT PDP request using116 * @warning The MT-PDP context activation feature is not supported on all platforms. Please refer to148 * The amount of received and transmitted data can be retrieved through le_mdc_GetBytesCounters().155 * @note The data statistics collection activation and the data counters are persistent even after195 //--------------------------------------------------------------------------------------------------199 //--------------------------------------------------------------------------------------------------202 //--------------------------------------------------------------------------------------------------205 * Connect the current client thread to the service providing this API. Block until the service is208 * For each thread that wants to use this API, either ConnectService or TryConnectService must be209 * called before any other functions in this API. Normally, ConnectService is automatically called214 //--------------------------------------------------------------------------------------------------220 //--------------------------------------------------------------------------------------------------223 * Try to connect the current client thread to the service providing this API. Return with an error226 * For each thread that wants to use this API, either ConnectService or TryConnectService must be227 * called before any other functions in this API. Normally, ConnectService is automatically called236 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).239 //--------------------------------------------------------------------------------------------------245 //--------------------------------------------------------------------------------------------------249 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants252 //--------------------------------------------------------------------------------------------------259 //--------------------------------------------------------------------------------------------------265 * longer a connection to the service, and the functions in this API can't be used. For details, see270 //--------------------------------------------------------------------------------------------------277 //--------------------------------------------------------------------------------------------------281 //--------------------------------------------------------------------------------------------------284 //--------------------------------------------------------------------------------------------------288 //--------------------------------------------------------------------------------------------------291 //--------------------------------------------------------------------------------------------------295 //--------------------------------------------------------------------------------------------------298 //--------------------------------------------------------------------------------------------------302 //--------------------------------------------------------------------------------------------------305 //--------------------------------------------------------------------------------------------------309 //--------------------------------------------------------------------------------------------------312 //--------------------------------------------------------------------------------------------------316 //--------------------------------------------------------------------------------------------------319 //--------------------------------------------------------------------------------------------------323 //--------------------------------------------------------------------------------------------------326 //--------------------------------------------------------------------------------------------------330 //--------------------------------------------------------------------------------------------------333 //--------------------------------------------------------------------------------------------------337 //--------------------------------------------------------------------------------------------------340 //--------------------------------------------------------------------------------------------------344 //--------------------------------------------------------------------------------------------------347 //--------------------------------------------------------------------------------------------------351 //--------------------------------------------------------------------------------------------------354 //--------------------------------------------------------------------------------------------------358 //--------------------------------------------------------------------------------------------------361 //--------------------------------------------------------------------------------------------------365 //--------------------------------------------------------------------------------------------------368 //--------------------------------------------------------------------------------------------------372 //--------------------------------------------------------------------------------------------------375 //--------------------------------------------------------------------------------------------------380 //--------------------------------------------------------------------------------------------------383 //--------------------------------------------------------------------------------------------------387 //--------------------------------------------------------------------------------------------------391 //--------------------------------------------------------------------------------------------------395 //--------------------------------------------------------------------------------------------------470 //--------------------------------------------------------------------------------------------------474 //--------------------------------------------------------------------------------------------------489 //--------------------------------------------------------------------------------------------------493 //--------------------------------------------------------------------------------------------------503 //--------------------------------------------------------------------------------------------------507 //--------------------------------------------------------------------------------------------------524 //--------------------------------------------------------------------------------------------------528 //--------------------------------------------------------------------------------------------------627 //--------------------------------------------------------------------------------------------------631 //--------------------------------------------------------------------------------------------------635 //--------------------------------------------------------------------------------------------------639 //--------------------------------------------------------------------------------------------------643 //--------------------------------------------------------------------------------------------------647 //--------------------------------------------------------------------------------------------------649 (658 //--------------------------------------------------------------------------------------------------662 //--------------------------------------------------------------------------------------------------664 (671 //--------------------------------------------------------------------------------------------------676 //--------------------------------------------------------------------------------------------------678 (687 //--------------------------------------------------------------------------------------------------691 * This event provides information on data session connection state changes for the given profileRef.694 //--------------------------------------------------------------------------------------------------705 //--------------------------------------------------------------------------------------------------709 //--------------------------------------------------------------------------------------------------716 //--------------------------------------------------------------------------------------------------720 * This event provides information on data session connection state changes for the given profileRef.723 //--------------------------------------------------------------------------------------------------732 //--------------------------------------------------------------------------------------------------736 //--------------------------------------------------------------------------------------------------743 //--------------------------------------------------------------------------------------------------757 //--------------------------------------------------------------------------------------------------764 //--------------------------------------------------------------------------------------------------774 //--------------------------------------------------------------------------------------------------781 //--------------------------------------------------------------------------------------------------794 //--------------------------------------------------------------------------------------------------801 //--------------------------------------------------------------------------------------------------808 //--------------------------------------------------------------------------------------------------819 //--------------------------------------------------------------------------------------------------831 * @warning The MT-PDP context activation feature is not supported on all platforms. Please refer to834 //--------------------------------------------------------------------------------------------------841 //--------------------------------------------------------------------------------------------------848 //--------------------------------------------------------------------------------------------------859 //--------------------------------------------------------------------------------------------------872 * @warning The MT-PDP context activation feature is not supported on all platforms. Please refer to875 //--------------------------------------------------------------------------------------------------882 //--------------------------------------------------------------------------------------------------894 //--------------------------------------------------------------------------------------------------903 //--------------------------------------------------------------------------------------------------915 //--------------------------------------------------------------------------------------------------926 //--------------------------------------------------------------------------------------------------939 //--------------------------------------------------------------------------------------------------950 //--------------------------------------------------------------------------------------------------952 * Get the gateway IPv4 address for the given profile, if the data session is connected and has an963 //--------------------------------------------------------------------------------------------------974 //--------------------------------------------------------------------------------------------------989 //--------------------------------------------------------------------------------------------------1004 //--------------------------------------------------------------------------------------------------1017 //--------------------------------------------------------------------------------------------------1028 //--------------------------------------------------------------------------------------------------1030 * Get the gateway IPv6 address for the given profile, if the data session is connected and has an1041 //--------------------------------------------------------------------------------------------------1052 //--------------------------------------------------------------------------------------------------1067 //--------------------------------------------------------------------------------------------------1082 //--------------------------------------------------------------------------------------------------1084 * Allow the caller to know if the given profile is actually supporting IPv4, if the data session1092 //--------------------------------------------------------------------------------------------------1099 //--------------------------------------------------------------------------------------------------1101 * Allow the caller to know if the given profile is actually supporting IPv6, if the data session1109 //--------------------------------------------------------------------------------------------------1116 //--------------------------------------------------------------------------------------------------1127 //--------------------------------------------------------------------------------------------------1138 //--------------------------------------------------------------------------------------------------1149 //--------------------------------------------------------------------------------------------------1158 //--------------------------------------------------------------------------------------------------1166 //--------------------------------------------------------------------------------------------------1172 //--------------------------------------------------------------------------------------------------1180 //--------------------------------------------------------------------------------------------------1186 //--------------------------------------------------------------------------------------------------1194 //--------------------------------------------------------------------------------------------------1200 //--------------------------------------------------------------------------------------------------1212 //--------------------------------------------------------------------------------------------------1221 //--------------------------------------------------------------------------------------------------1231 //--------------------------------------------------------------------------------------------------1238 //--------------------------------------------------------------------------------------------------1258 //--------------------------------------------------------------------------------------------------1267 //--------------------------------------------------------------------------------------------------1281 //--------------------------------------------------------------------------------------------------1288 //--------------------------------------------------------------------------------------------------1301 //--------------------------------------------------------------------------------------------------1312 //--------------------------------------------------------------------------------------------------1331 //--------------------------------------------------------------------------------------------------1344 //--------------------------------------------------------------------------------------------------1357 //--------------------------------------------------------------------------------------------------1374 //--------------------------------------------------------------------------------------------------1381 //--------------------------------------------------------------------------------------------------1387 //--------------------------------------------------------------------------------------------------1396 //--------------------------------------------------------------------------------------------------1405 //--------------------------------------------------------------------------------------------------1414 //--------------------------------------------------------------------------------------------------1421 //--------------------------------------------------------------------------------------------------1433 //--------------------------------------------------------------------------------------------------1440 //--------------------------------------------------------------------------------------------------1447 //--------------------------------------------------------------------------------------------------1458 //--------------------------------------------------------------------------------------------------1468 //--------------------------------------------------------------------------------------------------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)void(* le_mdc_MtPdpSessionStateHandlerFunc_t)(le_mdc_ConState_t ConnectionState, void *contextPtr)Definition: le_mdc_interface.h:664le_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_SetAPN(le_mdc_ProfileRef_t profileRef, const char *LE_NONNULL apnStr)struct le_mdc_SessionStateHandler * le_mdc_SessionStateHandlerRef_tDefinition: le_mdc_interface.h:632bool le_mdc_IsIPv4(le_mdc_ProfileRef_t profileRef)void(* le_mdc_SessionStateHandlerFunc_t)(le_mdc_ProfileRef_t profileRef, le_mdc_ConState_t ConnectionState, void *contextPtr)Definition: le_mdc_interface.h:649le_result_t le_mdc_GetIPv4GatewayAddress(le_mdc_ProfileRef_t profileRef, char *gatewayAddr, size_t gatewayAddrSize)le_result_t le_mdc_StopSession(le_mdc_ProfileRef_t profileRef)le_result_t le_mdc_GetAPN(le_mdc_ProfileRef_t profileRef, char *apnStr, size_t apnStrSize)void le_mdc_SetServerDisconnectHandler(le_mdc_DisconnectHandler_t disconnectHandler, void *contextPtr)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 *ipAddr, size_t ipAddrSize)cf. 3GPP 24.008 Annex I2Definition: le_mdc_interface.h:615void le_mdc_ConnectService(void)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:535void 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:605le_result_t le_mdc_GetInterfaceName(le_mdc_ProfileRef_t profileRef, char *interfaceName, size_t interfaceNameSize)le_result_t le_mdc_SetPDP(le_mdc_ProfileRef_t profileRef, le_mdc_Pdp_t pdp)bool le_mdc_IsIPv6(le_mdc_ProfileRef_t profileRef)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:583le_result_t le_mdc_GetBytesCounters(uint64_t *rxBytesPtr, uint64_t *txBytesPtr)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:555cf. 3GPP 24.008 Annex I2Definition: le_mdc_interface.h:609CDMA2000 HRPD (1xEV-DO)Definition: le_mdc_interface.h:436cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:597le_mdc_DisconnectionReason_t le_mdc_GetDisconnectionReason(le_mdc_ProfileRef_t profileRef)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:577void(* le_mdc_DisconnectHandler_t)(void *)Definition: le_mdc_interface.h:200le_result_t le_mdc_GetAuthentication(le_mdc_ProfileRef_t profileRef, le_mdc_Auth_t *typePtr, char *userName, size_t userNameSize, char *password, size_t passwordSize)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:553void le_mdc_GetPlatformSpecificFailureConnectionReason(le_mdc_ProfileRef_t profileRef, int32_t *failureTypePtr, int32_t *failureCodePtr)void le_mdc_RemoveSessionStateHandler(le_mdc_SessionStateHandlerRef_t handlerRef)void le_mdc_RemoveMtPdpSessionStateHandler(le_mdc_MtPdpSessionStateHandlerRef_t handlerRef)le_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:640le_result_t le_mdc_GetIPv4Address(le_mdc_ProfileRef_t profileRef, char *ipAddr, size_t ipAddrSize)le_result_t le_mdc_StartBytesCounter(void)le_mdc_MtPdpSessionStateHandlerRef_t le_mdc_AddMtPdpSessionStateHandler(le_mdc_SessionStateHandlerFunc_t handlerPtr, void *contextPtr)le_result_t le_mdc_GetIPv6GatewayAddress(le_mdc_ProfileRef_t profileRef, char *gatewayAddr, size_t gatewayAddrSize)le_result_t le_mdc_SetAuthentication(le_mdc_ProfileRef_t profileRef, le_mdc_Auth_t type, const char *LE_NONNULL userName, const char *LE_NONNULL password)le_result_t le_mdc_GetProfileFromApn(const char *LE_NONNULL 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)void(* le_mdc_SessionHandlerFunc_t)(le_mdc_ProfileRef_t profileRef, le_result_t result, void *contextPtr)Definition: le_mdc_interface.h:678le_result_t le_mdc_StopBytesCounter(void)le_result_t le_mdc_RejectMtPdpSession(le_mdc_ProfileRef_t profileRef)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:591CDMA2000 HRPD (1xEV-DO RevA)Definition: le_mdc_interface.h:438le_result_t le_mdc_MapProfileOnNetworkInterface(le_mdc_ProfileRef_t profileRef, const char *LE_NONNULL interfaceName)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:579le_result_t le_mdc_GetIPv6DNSAddresses(le_mdc_ProfileRef_t profileRef, char *dns1AddrStr, size_t dns1AddrStrSize, char *dns2AddrStr, size_t dns2AddrStrSize)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:549cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:547