le_data_interface.h
Go to the documentation of this file.
23 * The data connection service provides a basic API for requesting and releasing a data connection.29 * All the functions of this API are provided by the @b dataConnectionService application service.70 * @note When using the cellular technology, the data connection service can use a specific cellular73 * retrieved by le_data_GetCellularProfileIndex(). The profile to use is loaded when the first data90 * @note The default route activation status can be retrieved with le_data_GetDefaultRouteStatus().95 * A sample code showing how to set the modem default route if it isn't set by the data connection97 * @snippet "apps/test/dataConnectionService/dataConnectionServiceRouteTest/dcsRouteTestComp/dcsRouteTest.c" DefaultRoute116 * one in the list is used for the default data connection. If the connection is also unavailable131 * and @c r+n+1. Technologies with ranks under @c r are not impacted. If the technology is already139 * When the data connection service is connected, the date and time can be retrieved from a distant140 * server using le_data_GetDate() and le_data_GetTime(). The time protocol and time server to use148 * <tt> time.nist.gov </tt> for @ref LE_DATA_TP and to <tt> pool.ntp.org </tt> for @ref LE_DATA_NTP.150 * @note The configured time protocol needs to be supported by your platform to be used by the data214 //--------------------------------------------------------------------------------------------------218 //--------------------------------------------------------------------------------------------------221 //--------------------------------------------------------------------------------------------------224 * Connect the current client thread to the service providing this API. Block until the service is227 * For each thread that wants to use this API, either ConnectService or TryConnectService must be228 * called before any other functions in this API. Normally, ConnectService is automatically called233 //--------------------------------------------------------------------------------------------------239 //--------------------------------------------------------------------------------------------------242 * Try to connect the current client thread to the service providing this API. Return with an error245 * For each thread that wants to use this API, either ConnectService or TryConnectService must be246 * called before any other functions in this API. Normally, ConnectService is automatically called255 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).258 //--------------------------------------------------------------------------------------------------264 //--------------------------------------------------------------------------------------------------268 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants271 //--------------------------------------------------------------------------------------------------278 //--------------------------------------------------------------------------------------------------284 * longer a connection to the service, and the functions in this API can't be used. For details, see289 //--------------------------------------------------------------------------------------------------296 //--------------------------------------------------------------------------------------------------300 //--------------------------------------------------------------------------------------------------303 //--------------------------------------------------------------------------------------------------307 //--------------------------------------------------------------------------------------------------310 //--------------------------------------------------------------------------------------------------314 //--------------------------------------------------------------------------------------------------318 //--------------------------------------------------------------------------------------------------322 //--------------------------------------------------------------------------------------------------335 //--------------------------------------------------------------------------------------------------339 //--------------------------------------------------------------------------------------------------350 //--------------------------------------------------------------------------------------------------354 //--------------------------------------------------------------------------------------------------358 //--------------------------------------------------------------------------------------------------362 //--------------------------------------------------------------------------------------------------364 (373 //--------------------------------------------------------------------------------------------------379 //--------------------------------------------------------------------------------------------------388 //--------------------------------------------------------------------------------------------------392 //--------------------------------------------------------------------------------------------------399 //--------------------------------------------------------------------------------------------------407 //--------------------------------------------------------------------------------------------------413 //--------------------------------------------------------------------------------------------------417 //--------------------------------------------------------------------------------------------------424 //--------------------------------------------------------------------------------------------------433 //--------------------------------------------------------------------------------------------------442 //--------------------------------------------------------------------------------------------------449 //--------------------------------------------------------------------------------------------------455 //--------------------------------------------------------------------------------------------------462 //--------------------------------------------------------------------------------------------------468 //--------------------------------------------------------------------------------------------------478 //--------------------------------------------------------------------------------------------------484 //--------------------------------------------------------------------------------------------------492 //--------------------------------------------------------------------------------------------------498 //--------------------------------------------------------------------------------------------------513 //--------------------------------------------------------------------------------------------------521 //--------------------------------------------------------------------------------------------------523 * Delete a route on the data connection service interface, if the data session is connected using536 //--------------------------------------------------------------------------------------------------544 //--------------------------------------------------------------------------------------------------546 * Get the cellular profile index used by the data connection service when the cellular technology552 //--------------------------------------------------------------------------------------------------558 //--------------------------------------------------------------------------------------------------560 * Set the cellular profile index used by the data connection service when the cellular technology568 //--------------------------------------------------------------------------------------------------575 //--------------------------------------------------------------------------------------------------586 //--------------------------------------------------------------------------------------------------597 //--------------------------------------------------------------------------------------------------608 //--------------------------------------------------------------------------------------------------le_result_t le_data_GetDate(uint16_t *yearPtr, uint16_t *monthPtr, uint16_t *dayPtr)void le_data_ConnectService(void)void(* le_data_ConnectionStateHandlerFunc_t)(const char *LE_NONNULL intfName, bool isConnected, void *contextPtr)Definition: le_data_interface.h:364void le_data_Release(le_data_RequestObjRef_t requestRef)le_data_RequestObjRef_t le_data_Request(void)struct le_data_RequestObj * le_data_RequestObjRef_tDefinition: le_data_interface.h:315void le_data_RemoveConnectionStateHandler(le_data_ConnectionStateHandlerRef_t handlerRef)le_result_t le_data_SetTechnologyRank(uint32_t rank, le_data_Technology_t technology)le_data_Technology_t le_data_GetNextUsedTechnology(void)le_result_t le_data_AddRoute(const char *LE_NONNULL ipDestAddrStr)int32_t le_data_GetCellularProfileIndex(void)le_result_t le_data_TryConnectService(void)void le_data_DisconnectService(void)le_result_t le_data_GetTime(uint16_t *hoursPtr, uint16_t *minutesPtr, uint16_t *secondsPtr, uint16_t *millisecondsPtr)le_result_t le_data_SetCellularProfileIndex(int32_t profileIndex)void le_data_SetServerDisconnectHandler(le_data_DisconnectHandler_t disconnectHandler, void *contextPtr)le_data_Technology_t le_data_GetTechnology(void)le_result_t le_data_DelRoute(const char *LE_NONNULL ipDestAddrStr)void(* le_data_DisconnectHandler_t)(void *)Definition: le_data_interface.h:219struct le_data_ConnectionStateHandler * le_data_ConnectionStateHandlerRef_tDefinition: le_data_interface.h:355bool le_data_GetDefaultRouteStatus(void)le_data_Technology_t le_data_GetFirstUsedTechnology(void)le_data_ConnectionStateHandlerRef_t le_data_AddConnectionStateHandler(le_data_ConnectionStateHandlerFunc_t handlerPtr, void *contextPtr)