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 the48 * A pre-defined data profile can also be retrieved using le_mdc_GetProfileFromApn() thanks to its79 * The current state of a data session can be queried using le_mdc_GetSessionState(). An application128 * These values correspond to the number of bytes received/transmitted since the last software reset168 //--------------------------------------------------------------------------------------------------171 * Connect the current client thread to the service providing this API. Block until the service is174 * For each thread that wants to use this API, either ConnectService or TryConnectService must be175 * called before any other functions in this API. Normally, ConnectService is automatically called180 //--------------------------------------------------------------------------------------------------186 //--------------------------------------------------------------------------------------------------189 * Try to connect the current client thread to the service providing this API. Return with an error192 * For each thread that wants to use this API, either ConnectService or TryConnectService must be193 * called before any other functions in this API. Normally, ConnectService is automatically called200 * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.201 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).204 //--------------------------------------------------------------------------------------------------210 //--------------------------------------------------------------------------------------------------216 * longer a connection to the service, and the functions in this API can't be used. For details, see221 //--------------------------------------------------------------------------------------------------228 //--------------------------------------------------------------------------------------------------232 //--------------------------------------------------------------------------------------------------236 //--------------------------------------------------------------------------------------------------240 //--------------------------------------------------------------------------------------------------244 //--------------------------------------------------------------------------------------------------248 //--------------------------------------------------------------------------------------------------252 //--------------------------------------------------------------------------------------------------256 //--------------------------------------------------------------------------------------------------260 //--------------------------------------------------------------------------------------------------264 //--------------------------------------------------------------------------------------------------268 //--------------------------------------------------------------------------------------------------272 //--------------------------------------------------------------------------------------------------276 //--------------------------------------------------------------------------------------------------280 //--------------------------------------------------------------------------------------------------284 //--------------------------------------------------------------------------------------------------288 //--------------------------------------------------------------------------------------------------292 //--------------------------------------------------------------------------------------------------296 //--------------------------------------------------------------------------------------------------300 //--------------------------------------------------------------------------------------------------304 //--------------------------------------------------------------------------------------------------308 //--------------------------------------------------------------------------------------------------312 //--------------------------------------------------------------------------------------------------316 //--------------------------------------------------------------------------------------------------320 //--------------------------------------------------------------------------------------------------324 //--------------------------------------------------------------------------------------------------328 //--------------------------------------------------------------------------------------------------332 //--------------------------------------------------------------------------------------------------336 //--------------------------------------------------------------------------------------------------340 //--------------------------------------------------------------------------------------------------344 //--------------------------------------------------------------------------------------------------348 //--------------------------------------------------------------------------------------------------352 //--------------------------------------------------------------------------------------------------400 //--------------------------------------------------------------------------------------------------404 //--------------------------------------------------------------------------------------------------422 //--------------------------------------------------------------------------------------------------426 //--------------------------------------------------------------------------------------------------441 //--------------------------------------------------------------------------------------------------445 //--------------------------------------------------------------------------------------------------466 //--------------------------------------------------------------------------------------------------470 //--------------------------------------------------------------------------------------------------614 //--------------------------------------------------------------------------------------------------618 //--------------------------------------------------------------------------------------------------622 //--------------------------------------------------------------------------------------------------626 //--------------------------------------------------------------------------------------------------630 //--------------------------------------------------------------------------------------------------640 //--------------------------------------------------------------------------------------------------642 (649 //--------------------------------------------------------------------------------------------------657 //--------------------------------------------------------------------------------------------------659 (665 //--------------------------------------------------------------------------------------------------676 //--------------------------------------------------------------------------------------------------678 (684 //--------------------------------------------------------------------------------------------------688 * This event provides information on data session connection state changes for the given profileRef.690 //--------------------------------------------------------------------------------------------------703 //--------------------------------------------------------------------------------------------------707 //--------------------------------------------------------------------------------------------------714 //--------------------------------------------------------------------------------------------------718 * This event provides information on data session connection state changes for the given profileRef.720 //--------------------------------------------------------------------------------------------------730 //--------------------------------------------------------------------------------------------------734 //--------------------------------------------------------------------------------------------------741 //--------------------------------------------------------------------------------------------------753 //--------------------------------------------------------------------------------------------------760 //--------------------------------------------------------------------------------------------------770 //--------------------------------------------------------------------------------------------------777 //--------------------------------------------------------------------------------------------------790 //--------------------------------------------------------------------------------------------------797 //--------------------------------------------------------------------------------------------------804 //--------------------------------------------------------------------------------------------------817 //--------------------------------------------------------------------------------------------------829 //--------------------------------------------------------------------------------------------------836 //--------------------------------------------------------------------------------------------------843 //--------------------------------------------------------------------------------------------------856 //--------------------------------------------------------------------------------------------------868 //--------------------------------------------------------------------------------------------------875 //--------------------------------------------------------------------------------------------------887 //--------------------------------------------------------------------------------------------------897 //--------------------------------------------------------------------------------------------------909 //--------------------------------------------------------------------------------------------------922 //--------------------------------------------------------------------------------------------------935 //--------------------------------------------------------------------------------------------------948 //--------------------------------------------------------------------------------------------------950 * Get the gateway IPv4 address for the given profile, if the data session is connected and has an961 //--------------------------------------------------------------------------------------------------974 //--------------------------------------------------------------------------------------------------989 //--------------------------------------------------------------------------------------------------1008 //--------------------------------------------------------------------------------------------------1021 //--------------------------------------------------------------------------------------------------1034 //--------------------------------------------------------------------------------------------------1036 * Get the gateway IPv6 address for the given profile, if the data session is connected and has an1047 //--------------------------------------------------------------------------------------------------1060 //--------------------------------------------------------------------------------------------------1075 //--------------------------------------------------------------------------------------------------1094 //--------------------------------------------------------------------------------------------------1096 * Allow the caller to know if the given profile is actually supporting IPv4, if the data session1104 //--------------------------------------------------------------------------------------------------1111 //--------------------------------------------------------------------------------------------------1113 * Allow the caller to know if the given profile is actually supporting IPv6, if the data session1121 //--------------------------------------------------------------------------------------------------1128 //--------------------------------------------------------------------------------------------------1139 //--------------------------------------------------------------------------------------------------1152 //--------------------------------------------------------------------------------------------------1163 //--------------------------------------------------------------------------------------------------1173 //--------------------------------------------------------------------------------------------------1181 //--------------------------------------------------------------------------------------------------1187 //--------------------------------------------------------------------------------------------------1199 //--------------------------------------------------------------------------------------------------1209 //--------------------------------------------------------------------------------------------------1219 //--------------------------------------------------------------------------------------------------1226 //--------------------------------------------------------------------------------------------------1242 //--------------------------------------------------------------------------------------------------1252 //--------------------------------------------------------------------------------------------------1265 //--------------------------------------------------------------------------------------------------1272 //--------------------------------------------------------------------------------------------------1285 //--------------------------------------------------------------------------------------------------1298 //--------------------------------------------------------------------------------------------------1312 * @note Both PAP and CHAP authentification can be set for 3GPP network: in this case, the device1317 //--------------------------------------------------------------------------------------------------1333 //--------------------------------------------------------------------------------------------------1346 //--------------------------------------------------------------------------------------------------1368 //--------------------------------------------------------------------------------------------------1375 //--------------------------------------------------------------------------------------------------1381 //--------------------------------------------------------------------------------------------------1390 //--------------------------------------------------------------------------------------------------1400 //--------------------------------------------------------------------------------------------------1409 //--------------------------------------------------------------------------------------------------1416 //--------------------------------------------------------------------------------------------------1425 //--------------------------------------------------------------------------------------------------1432 //--------------------------------------------------------------------------------------------------1439 //--------------------------------------------------------------------------------------------------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:619le_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:599void le_mdc_ConnectService(void)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:479void 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:584le_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:659bool le_mdc_IsIPv6(le_mdc_ProfileRef_t profileRef)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:551le_result_t le_mdc_GetBytesCounters(uint64_t *rxBytesPtr, uint64_t *txBytesPtr)cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:509cf. 3GPP 24.008 Annex I2Definition: le_mdc_interface.h:590CDMA2000 HRPD (1xEV-DO)Definition: le_mdc_interface.h:388cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:572le_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:542le_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:506le_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:494le_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:627le_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:678cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:563CDMA2000 HRPD (1xEV-DO RevA)Definition: le_mdc_interface.h:391le_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:642le_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:545cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:500cf. 3GPP 24.008 Annex I1Definition: le_mdc_interface.h:497void le_mdc_RemoveMtPdpSessionStateHandler(le_mdc_MtPdpSessionStateHandlerRef_t addHandlerRef)