aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libsimple_sumtimespec.3
blob: e72db1dc3d1fb5f2976a729cd34d02c9b5a89e6d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
.TH LIBSIMPLE_SUMTIMESPEC 3 libsimple
.SH NAME
libsimple_sumtimespec, libsimple_sumtimeval \- calculate the sum of two durations

.SH SYNOPSIS
.nf
#include <libsimple.h>

int libsimple_sumtimespec(struct timespec *\fIsum\fP, const struct timespec *\fIaugend\fP, const struct timespec *\fIaddend\fP);
int libsimple_sumtimeval(struct timeval *\fIsum\fP, const struct timeval *\fIaugend\fP, const struct timeval *\fIaddend\fP);

#ifndef sumtimespec
# define sumtimespec libsimple_sumtimespec
#endif
#ifndef sumtimeval
# define sumtimeval libsimple_sumtimeval
#endif
.fi
.PP
Link with
.IR \-lsimple .

.SH DESCRIPTION
The
.BR libsimple_sumtimespec ()
and
.BR libsimple_sumtimeval ()
functions calculates the sum of
.I augend
and
.I addend
and stores the result in
.IR sum .

.SH RETURN VALUE
The
.BR libsimple_sumtimespec ()
and
.BR libsimple_sumtimeval ()
functions return 0 on successful completion;
otherwise, \-1 is returned and
.I errno
is set to indicate the error.
.PP
These functions assume that
.I augend->tv_nsec
and
.I addend->tv_nsec
are in thier valid range ([0, 1000000000) for
.BR libsimple_sumtimespec ()
and [0, 1000000) for
.BR libsimple_sumtimeval ()).

.SH ERRORS
The
.BR libsimple_sumtimespec ()
and
.BR libsimple_sumtimeval ()
functions fail if:
.TP
.B ERANGE
The result is too large or too small to be stored; if the
result is too large
.I *sum
will be set to
.I {.tv_sec=TIME_MAX,.tv_nsec=999999999L}
for the
.BR libsimple_sumtimespec ()
function and to
.I {.tv_sec=TIME_MAX,.tv_usec=999999L}
for the
.BR libsimple_sumtimeval ()
function, if the result is too small
.I *sum
will be set to
.I {.tv_sec=TIME_MIN,.tv_nsec=0}
for the
.BR libsimple_sumtimespec ()
function and to
.I {.tv_sec=TIME_MIN,.tv_usec=0}
for the
.BR libsimple_sumtimeval ()
function.

.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lb lb lb
l l l.
Interface	Attribute	Value
T{
.BR libsimple_sumtimespec ()
.br
.BR libsimple_sumtimeval ()
T}	Thread safety	MT-Safe
T{
.BR libsimple_sumtimespec ()
.br
.BR libsimple_sumtimeval ()
T}	Async-signal safety	AS-Safe
T{
.BR libsimple_sumtimespec ()
.br
.BR libsimple_sumtimeval ()
T}	Async-cancel safety	AC-Safe
.TE

.SH EXAMPLES
None.

.SH APPLICATION USAGE
None.

.SH RATIONALE
None.

.SH FUTURE DIRECTIONS
None.

.SH NOTES
None.

.SH HISTORY
libsimple 1.0

.SH BUGS
None.

.SH SEE ALSO
.BR libsimple_difftimespec (3),
.BR libsimple_multimespec (3),
.BR libsimple_cmptimespec (3),
.BR libsimple_timespectostr (3),
.BR libsimple_strtotimespec (3),
.BR libsimple_timespectodouble (3),
.BR libsimple_doubletotimespec (3),
.BR libsimple_timeval2timespec (3)