le_data_interface.h
Go to the documentation of this file.
23 * be called indicating it's now connected. The interface name is sent only when the data connection25 * called with the new state. To release a data connection, an application can use le_data_Release().29 * If the default data connection is not currently available when le_data_Request() is called, the30 * data connection service first ensures all pre-conditions are satisfied (e.g., modem is registered34 * connection will not be started. Instead, the existing data connection will be used. This happens40 * transmitting data when the state is connected, and should stop transmitting data when the state42 * establish or re-establish the connection endlessly until le_data_Release() is called. There's no46 * le_data_Release(). The data connection will be released only after le_data_Release() is called by49 * @note When using the cellular technology, the data connection service can use a specific cellular52 * retrieved by le_data_GetCellularProfileIndex(). The profile to use is loaded when the first data74 * @note The default route activation status can be retrieved with le_data_GetDefaultRouteStatus().79 * A sample code showing how to set the modem default route if it isn't set by the data connection81 * @snippet "apps/test/dataConnectionService/dataConnectionServiceRouteTest/dcsRouteTestComp/dcsRouteTest.c" DefaultRoute100 * one in the list is used for the default data connection. If the connection is also unavailable115 * and @c r+n+1. Technologies with ranks under @c r are not impacted. If the technology is already123 * @warning To get the date and time, use GetDateTime rather than sequential calls to GetDate and127 * When the data connection service is connected, the date and time can be retrieved from a distant128 * server using le_data_GetDate() and le_data_GetTime(). The time protocol and time server to use136 * <tt> time.nist.gov </tt> for @ref LE_DATA_TP and to <tt> pool.ntp.org </tt> for @ref LE_DATA_NTP.138 * @note The configured time protocol needs to be supported by your platform to be used by the data209 //--------------------------------------------------------------------------------------------------213 //--------------------------------------------------------------------------------------------------216 //--------------------------------------------------------------------------------------------------219 * Connect the current client thread to the service providing this API. Block until the service is222 * For each thread that wants to use this API, either ConnectService or TryConnectService must be223 * called before any other functions in this API. Normally, ConnectService is automatically called228 //--------------------------------------------------------------------------------------------------234 //--------------------------------------------------------------------------------------------------237 * Try to connect the current client thread to the service providing this API. Return with an error240 * For each thread that wants to use this API, either ConnectService or TryConnectService must be241 * called before any other functions in this API. Normally, ConnectService is automatically called250 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).253 //--------------------------------------------------------------------------------------------------259 //--------------------------------------------------------------------------------------------------263 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants266 //--------------------------------------------------------------------------------------------------273 //--------------------------------------------------------------------------------------------------279 * longer a connection to the service, and the functions in this API can't be used. For details, see284 //--------------------------------------------------------------------------------------------------291 //--------------------------------------------------------------------------------------------------295 //--------------------------------------------------------------------------------------------------298 //--------------------------------------------------------------------------------------------------302 //--------------------------------------------------------------------------------------------------305 //--------------------------------------------------------------------------------------------------309 //--------------------------------------------------------------------------------------------------312 //--------------------------------------------------------------------------------------------------316 //--------------------------------------------------------------------------------------------------319 //--------------------------------------------------------------------------------------------------323 //--------------------------------------------------------------------------------------------------326 //--------------------------------------------------------------------------------------------------332 //--------------------------------------------------------------------------------------------------341 //--------------------------------------------------------------------------------------------------345 //--------------------------------------------------------------------------------------------------352 //--------------------------------------------------------------------------------------------------360 //--------------------------------------------------------------------------------------------------366 //--------------------------------------------------------------------------------------------------370 //--------------------------------------------------------------------------------------------------377 //--------------------------------------------------------------------------------------------------386 //--------------------------------------------------------------------------------------------------395 //--------------------------------------------------------------------------------------------------402 //--------------------------------------------------------------------------------------------------408 //--------------------------------------------------------------------------------------------------415 //--------------------------------------------------------------------------------------------------421 //--------------------------------------------------------------------------------------------------430 //--------------------------------------------------------------------------------------------------436 //--------------------------------------------------------------------------------------------------444 //--------------------------------------------------------------------------------------------------450 //--------------------------------------------------------------------------------------------------465 //--------------------------------------------------------------------------------------------------473 //--------------------------------------------------------------------------------------------------475 * Delete a route on the data connection service interface, if the data session is connected using488 //--------------------------------------------------------------------------------------------------496 //--------------------------------------------------------------------------------------------------498 * Get the cellular profile index used by the data connection service when the cellular technology504 //--------------------------------------------------------------------------------------------------510 //--------------------------------------------------------------------------------------------------512 * Set the cellular profile index used by the data connection service when the cellular technology520 //--------------------------------------------------------------------------------------------------527 //--------------------------------------------------------------------------------------------------531 * @warning To get the date and time, use GetDateTime rather than sequential calls to GetDate and541 //--------------------------------------------------------------------------------------------------552 //--------------------------------------------------------------------------------------------------556 * @warning To get the date and time, use GetDateTime rather than sequential calls to GetDate and566 //--------------------------------------------------------------------------------------------------579 //--------------------------------------------------------------------------------------------------590 //--------------------------------------------------------------------------------------------------le_result_t le_data_GetDate(uint16_t *yearPtr, uint16_t *monthPtr, uint16_t *dayPtr)void le_data_ConnectService(void)void le_data_Release(le_data_RequestObjRef_t requestRef)LE_FULL_API void le_data_SetServerDisconnectHandler(le_data_DisconnectHandler_t disconnectHandler, void *contextPtr)le_data_RequestObjRef_t le_data_Request(void)le_result_t le_data_GetDateTime(uint16_t *yearPtr, uint16_t *monthPtr, uint16_t *dayPtr, uint16_t *hoursPtr, uint16_t *minutesPtr, uint16_t *secondsPtr, uint16_t *millisecondsPtr)void 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)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:214bool 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)