Embedded Multicore Building Blocks V1.0.0
time.h
1 /*
2  * Copyright (c) 2014-2017, Siemens AG. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef EMBB_BASE_C_TIME_H_
28 #define EMBB_BASE_C_TIME_H_
29 
38 #include <embb/base/c/duration.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
47 #ifdef DOXYGEN
48 typedef opaque_type embb_time_t;
49 #else
50 typedef struct embb_time_t {
54  unsigned long long seconds;
58  unsigned long nanoseconds;
59 } embb_time_t;
60 #endif /* else defined(DOXYGEN) */
61 
68 void embb_time_now(
69  embb_time_t* time
71  );
72 
82 int embb_time_in(
83  embb_time_t* time,
85  const embb_duration_t* duration
87  );
88 
100  const embb_time_t* lhs,
102  const embb_time_t* rhs
104  );
105 
106 #ifdef __cplusplus
107 } /* Close extern "C" { */
108 #endif
109 
115 #endif /* EMBB_BASE_C_TIME_H_ */
void embb_time_now(embb_time_t *time)
Sets time point to now.
int embb_time_in(embb_time_t *time, const embb_duration_t *duration)
Sets time point to now plus the given duration.
int embb_time_compare(const embb_time_t *lhs, const embb_time_t *rhs)
Compares two time points.
opaque_type embb_time_t
Opaque type representing an absolute time point.
Definition: time.h:48
opaque_type embb_duration_t
Opaque type representing a relative time duration.
Definition: duration.h:52