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 to156 * The amount of received and transmitted data can be retrieved through le_mdc_GetBytesCounters().163 * @note The data statistics collection activation and the data counters are persistent even after203 //--------------------------------------------------------------------------------------------------207 //--------------------------------------------------------------------------------------------------210 //--------------------------------------------------------------------------------------------------213 * Connect the current client thread to the service providing this API. Block until the service is216 * For each thread that wants to use this API, either ConnectService or TryConnectService must be217 * called before any other functions in this API. Normally, ConnectService is automatically called222 //--------------------------------------------------------------------------------------------------228 //--------------------------------------------------------------------------------------------------231 * Try to connect the current client thread to the service providing this API. Return with an error234 * For each thread that wants to use this API, either ConnectService or TryConnectService must be235 * called before any other functions in this API. Normally, ConnectService is automatically called244 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).247 //--------------------------------------------------------------------------------------------------253 //--------------------------------------------------------------------------------------------------257 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants260 //--------------------------------------------------------------------------------------------------267 //--------------------------------------------------------------------------------------------------273 * longer a connection to the service, and the functions in this API can't be used. For details, see278 //--------------------------------------------------------------------------------------------------285 //--------------------------------------------------------------------------------------------------289 //--------------------------------------------------------------------------------------------------292 //--------------------------------------------------------------------------------------------------296 //--------------------------------------------------------------------------------------------------299 //--------------------------------------------------------------------------------------------------303 //--------------------------------------------------------------------------------------------------306 //--------------------------------------------------------------------------------------------------310 //--------------------------------------------------------------------------------------------------313 //--------------------------------------------------------------------------------------------------317 //--------------------------------------------------------------------------------------------------320 //--------------------------------------------------------------------------------------------------324 //--------------------------------------------------------------------------------------------------327 //--------------------------------------------------------------------------------------------------331 //--------------------------------------------------------------------------------------------------334 //--------------------------------------------------------------------------------------------------338 //--------------------------------------------------------------------------------------------------341 //--------------------------------------------------------------------------------------------------345 //--------------------------------------------------------------------------------------------------348 //--------------------------------------------------------------------------------------------------352 //--------------------------------------------------------------------------------------------------355 //--------------------------------------------------------------------------------------------------359 //--------------------------------------------------------------------------------------------------362 //--------------------------------------------------------------------------------------------------366 //--------------------------------------------------------------------------------------------------369 //--------------------------------------------------------------------------------------------------373 //--------------------------------------------------------------------------------------------------376 //--------------------------------------------------------------------------------------------------380 //--------------------------------------------------------------------------------------------------383 //--------------------------------------------------------------------------------------------------388 //--------------------------------------------------------------------------------------------------391 //--------------------------------------------------------------------------------------------------395 //--------------------------------------------------------------------------------------------------399 //--------------------------------------------------------------------------------------------------403 //--------------------------------------------------------------------------------------------------478 //--------------------------------------------------------------------------------------------------482 //--------------------------------------------------------------------------------------------------497 //--------------------------------------------------------------------------------------------------501 //--------------------------------------------------------------------------------------------------511 //--------------------------------------------------------------------------------------------------515 //--------------------------------------------------------------------------------------------------532 //--------------------------------------------------------------------------------------------------536 //--------------------------------------------------------------------------------------------------635 //--------------------------------------------------------------------------------------------------639 //--------------------------------------------------------------------------------------------------643 //--------------------------------------------------------------------------------------------------647 //--------------------------------------------------------------------------------------------------651 //--------------------------------------------------------------------------------------------------655 //--------------------------------------------------------------------------------------------------657 (666 //--------------------------------------------------------------------------------------------------670 //--------------------------------------------------------------------------------------------------672 (679 //--------------------------------------------------------------------------------------------------684 //--------------------------------------------------------------------------------------------------686 (695 //--------------------------------------------------------------------------------------------------699 * This event provides information on data session connection state changes for the given profileRef.702 //--------------------------------------------------------------------------------------------------713 //--------------------------------------------------------------------------------------------------717 //--------------------------------------------------------------------------------------------------724 //--------------------------------------------------------------------------------------------------728 * This event provides information on data session connection state changes for the given profileRef.731 //--------------------------------------------------------------------------------------------------740 //--------------------------------------------------------------------------------------------------744 //--------------------------------------------------------------------------------------------------751 //--------------------------------------------------------------------------------------------------765 //--------------------------------------------------------------------------------------------------772 //--------------------------------------------------------------------------------------------------782 //--------------------------------------------------------------------------------------------------789 //--------------------------------------------------------------------------------------------------802 //--------------------------------------------------------------------------------------------------809 //--------------------------------------------------------------------------------------------------816 //--------------------------------------------------------------------------------------------------827 //--------------------------------------------------------------------------------------------------839 * @warning The MT-PDP context activation feature is not supported on all platforms. Please refer to842 //--------------------------------------------------------------------------------------------------849 //--------------------------------------------------------------------------------------------------856 //--------------------------------------------------------------------------------------------------867 //--------------------------------------------------------------------------------------------------880 * @warning The MT-PDP context activation feature is not supported on all platforms. Please refer to883 //--------------------------------------------------------------------------------------------------890 //--------------------------------------------------------------------------------------------------902 //--------------------------------------------------------------------------------------------------911 //--------------------------------------------------------------------------------------------------923 //--------------------------------------------------------------------------------------------------934 //--------------------------------------------------------------------------------------------------947 //--------------------------------------------------------------------------------------------------958 //--------------------------------------------------------------------------------------------------960 * Get the gateway IPv4 address for the given profile, if the data session is connected and has an971 //--------------------------------------------------------------------------------------------------982 //--------------------------------------------------------------------------------------------------997 //--------------------------------------------------------------------------------------------------1012 //--------------------------------------------------------------------------------------------------1025 //--------------------------------------------------------------------------------------------------1036 //--------------------------------------------------------------------------------------------------1038 * Get the gateway IPv6 address for the given profile, if the data session is connected and has an1049 //--------------------------------------------------------------------------------------------------1060 //--------------------------------------------------------------------------------------------------1075 //--------------------------------------------------------------------------------------------------1090 //--------------------------------------------------------------------------------------------------1092 * Allow the caller to know if the given profile is actually supporting IPv4, if the data session1100 //--------------------------------------------------------------------------------------------------1107 //--------------------------------------------------------------------------------------------------1109 * Allow the caller to know if the given profile is actually supporting IPv6, if the data session1117 //--------------------------------------------------------------------------------------------------1124 //--------------------------------------------------------------------------------------------------1135 //--------------------------------------------------------------------------------------------------1146 //--------------------------------------------------------------------------------------------------1157 //--------------------------------------------------------------------------------------------------1166 //--------------------------------------------------------------------------------------------------1174 //--------------------------------------------------------------------------------------------------1180 //--------------------------------------------------------------------------------------------------1188 //--------------------------------------------------------------------------------------------------1194 //--------------------------------------------------------------------------------------------------1202 //--------------------------------------------------------------------------------------------------1208 //--------------------------------------------------------------------------------------------------1220 //--------------------------------------------------------------------------------------------------1229 //--------------------------------------------------------------------------------------------------1239 //--------------------------------------------------------------------------------------------------1246 //--------------------------------------------------------------------------------------------------1266 //--------------------------------------------------------------------------------------------------1275 //--------------------------------------------------------------------------------------------------1289 //--------------------------------------------------------------------------------------------------1296 //--------------------------------------------------------------------------------------------------1309 //--------------------------------------------------------------------------------------------------1320 //--------------------------------------------------------------------------------------------------1339 //--------------------------------------------------------------------------------------------------1352 //--------------------------------------------------------------------------------------------------1365 //--------------------------------------------------------------------------------------------------1382 //--------------------------------------------------------------------------------------------------1389 //--------------------------------------------------------------------------------------------------1395 //--------------------------------------------------------------------------------------------------1404 //--------------------------------------------------------------------------------------------------1413 //--------------------------------------------------------------------------------------------------1422 * @deprecated This function is deprecated, le_mdc_GetDisconnectionReasonExt should be used for the1425 //--------------------------------------------------------------------------------------------------1432 //--------------------------------------------------------------------------------------------------1444 * @deprecated This function is deprecated, le_mdc_GetPlatformSpecificDisconnectionCodeExt should1447 //--------------------------------------------------------------------------------------------------1454 //--------------------------------------------------------------------------------------------------1464 * @deprecated This function is deprecated, le_mdc_GetPlatformSpecificFailureConnectionReasonExt1467 //--------------------------------------------------------------------------------------------------1478 //--------------------------------------------------------------------------------------------------1486 * @note For IPv4v6 mode, pdpType specifies which session's disconnect reason to get(IPv4 or IPv61490 //--------------------------------------------------------------------------------------------------1499 //--------------------------------------------------------------------------------------------------1510 * @note For IPv4v6 mode, pdpType specifies which session's disconnect reason to get(IPv4 or IPv61514 //--------------------------------------------------------------------------------------------------1523 //--------------------------------------------------------------------------------------------------1529 * @note For IPv4v6 mode, pdpType specifies which session's disconnect reason to get(IPv4 or IPv61533 //--------------------------------------------------------------------------------------------------1546 //--------------------------------------------------------------------------------------------------1556 //--------------------------------------------------------------------------------------------------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:672le_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:640bool 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:657le_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:623int32_t le_mdc_GetPlatformSpecificDisconnectionCodeExt(le_mdc_ProfileRef_t profileRef, le_mdc_Pdp_t pdpType)void le_mdc_ConnectService(void)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:543void 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:613le_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:591le_result_t le_mdc_GetBytesCounters(uint64_t *rxBytesPtr, uint64_t *txBytesPtr)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:563cf. 3GPP 24.008 Annex I2Definition: le_mdc_interface.h:617CDMA2000 HRPD (1xEV-DO)Definition: le_mdc_interface.h:444cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:605le_mdc_DisconnectionReason_t le_mdc_GetDisconnectionReason(le_mdc_ProfileRef_t profileRef)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:585void(* le_mdc_DisconnectHandler_t)(void *)Definition: le_mdc_interface.h:208le_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:561void 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)void le_mdc_GetPlatformSpecificFailureConnectionReasonExt(le_mdc_ProfileRef_t profileRef, le_mdc_Pdp_t pdpType, int32_t *failureTypePtr, int32_t *failureCodePtr)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:648le_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:686le_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:599CDMA2000 HRPD (1xEV-DO RevA)Definition: le_mdc_interface.h:446le_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:587le_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:557cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:555le_mdc_DisconnectionReason_t le_mdc_GetDisconnectionReasonExt(le_mdc_ProfileRef_t profileRef, le_mdc_Pdp_t pdpType)