le_rtc_common.h

    1 
    2 /*
    3  * ====================== WARNING ======================
    4  *
    5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    6  * DO NOT MODIFY IN ANY WAY.
    7  *
    8  * ====================== WARNING ======================
    9  */
   10 /**
   11  * @file le_rtc_common.h
   12  *
   13  * Type definitions for le_rtc.
   14  *
   15  */
   16 #ifndef LE_RTC_COMMON_H_INCLUDE_GUARD
   17 #define LE_RTC_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 #define IFGEN_LE_RTC_PROTOCOL_ID "88750cf71cdf94a8a7d68de367465558"
   23 #define IFGEN_LE_RTC_MSG_SIZE 20
   24 /** @addtogroup le_rtc
   25  *  @{ **/
   26 
   27 
   28 
   29 //--------------------------------------------------------------------------------------------------
   30 /**
   31  * Get if this client bound locally.
   32  */
   33 //--------------------------------------------------------------------------------------------------
   34 LE_SHARED bool ifgen_le_rtc_HasLocalBinding
   35 (
   36     void
   37 );
   38 
   39 
   40 //--------------------------------------------------------------------------------------------------
   41 /**
   42  * Init data that is common across all threads
   43  */
   44 //--------------------------------------------------------------------------------------------------
   45 LE_SHARED void ifgen_le_rtc_InitCommonData
   46 (
   47     void
   48 );
   49 
   50 
   51 //--------------------------------------------------------------------------------------------------
   52 /**
   53  * Perform common initialization and open a session
   54  */
   55 //--------------------------------------------------------------------------------------------------
   56 LE_SHARED le_result_t ifgen_le_rtc_OpenSession
   57 (
   58     le_msg_SessionRef_t _ifgen_sessionRef,
   59     bool isBlocking
   60 );
   61 
   62 //--------------------------------------------------------------------------------------------------
   63 /**
   64  * Get the current time from the RTC
   65  *
   66  * @return
   67  *      - LE_OK            Function succeeded.
   68  *      - LE_FAULT         Function failed.
   69  */
   70 //--------------------------------------------------------------------------------------------------
   71 LE_SHARED le_result_t ifgen_le_rtc_GetUserTime
   72 (
   73     le_msg_SessionRef_t _ifgen_sessionRef,
   74         uint64_t* millisecondsPastGpsEpochPtr
   75         ///< [OUT]
   76 );
   77 
   78 //--------------------------------------------------------------------------------------------------
   79 /**
   80  * Set the RTC with the given time string
   81  *
   82  * @return
   83  *      - LE_OK            Function succeeded.
   84  *      - LE_FAULT         Function failed.
   85  */
   86 //--------------------------------------------------------------------------------------------------
   87 LE_SHARED le_result_t ifgen_le_rtc_SetUserTime
   88 (
   89     le_msg_SessionRef_t _ifgen_sessionRef,
   90         uint64_t millisecondsPastGpsEpoch
   91         ///< [IN]
   92 );
   93 /** @} **/
   94 #endif // LE_RTC_COMMON_H_INCLUDE_GUARD
LE_SHARED
#define LE_SHARED
Definition: le_basics.h:300
le_result_t
le_result_t
Definition: le_basics.h:46
le_msg_SessionRef_t
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
legato.h