aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libsimple_multimespec.3
blob: 82872beb8dd42270e29761947d50d10e8b3f26a8 (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
.TH LIBSIMPLE_MULTIMESPEC 3 libsimple
.SH NAME
libsimple_multimespec, libsimple_multimeval \- multiply a duration with an integer

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

int libsimple_multimespec(struct timespec *\fIprod\fP, const struct timespec *\fImultiplicand\fP, int \fImultiplier\fP);
int libsimple_multimeval(struct timeval *\fIprod\fP, const struct timeval *\fImultiplicand\fP, int \fImultiplier\fP);

#ifndef multimespec
# define multimespec libsimple_multimespec
#endif
#ifndef multimeval
# define multimeval libsimple_multimeval
#endif
.fi
.PP
Link with
.IR \-lsimple .

.SH DESCRIPTION
The
.BR libsimple_multimespec ()
and
.BR libsimple_multimeval ()
functions calculates the product of
.I multiplicand
and
.I multiplier
and stores the result in
.IR prod .
.PP
These functions assume that
.I multiplicand->tv_nsec
is in its valid range ([0, 1000000000) for
.BR libsimple_multimespec ()
and [0, 1000000) for
.BR libsimple_multimeval ()).

.SH RETURN VALUE
The
.BR libsimple_multimespec ()
and
.BR libsimple_multimeval ()
functions return 0 on successful completion;
otherwise, \-1 is returned and
.I errno
is set to indicate the error.

.SH ERRORS
The
.BR libsimple_multimespec ()
and
.BR libsimple_multimeval ()
functions fail if:
.TP
.B ERANGE
The result is too large or too small to be stored; if the
result is too large
.I *diff
will be set to
.I {.tv_sec=TIME_MAX,.tv_nsec=999999999L}
for the
.BR libsimple_multimespec ()
function and to
.I {.tv_sec=TIME_MAX,.tv_usec=999999L}
for the
.BR libsimple_multimeval ()
function, if the result is too small
.I *diff
will be set to
.I {.tv_sec=TIME_MIN,.tv_nsec=0}
for the
.BR libsimple_multimespec ()
function and to
.I {.tv_sec=TIME_MIN,.tv_usec=0}
for the
.BR libsimple_multimeval ()
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_multimespec ()
.br
.BR libsimple_multimeval ()
T}	Thread safety	MT-Safe
T{
.BR libsimple_multimespec ()
.br
.BR libsimple_multimeval ()
T}	Async-signal safety	AS-Safe
T{
.BR libsimple_multimespec ()
.br
.BR libsimple_multimeval ()
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_sumtimespec (3),
.BR libsimple_difftimespec (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)