1UPSCLI_SENDLINE(3)                NUT Manual                UPSCLI_SENDLINE(3)
2
3
4

NAME

6       upscli_sendline, upscli_sendline_timeout - send a single command to a
7       UPS
8

SYNOPSIS

10       #include <upsclient.h>
11       #include <time.h> /* or <sys/time.h> on some platforms */
12
13       int upscli_sendline(UPSCONN_t *ups, const char *buf, size_t buflen);
14
15       int upscli_sendline_timeout(UPSCONN_t *ups, const char *buf, size_t buflen,
16                                      const time_t timeout);
17

DESCRIPTION

19       The upscli_sendline() and upscli_sendline_timeout() functions take the
20       pointer ups to a UPSCONN_t state structure and transmit a buffer buf of
21       size buflen to the server.
22
23       The data in buf must be a fully formatted protocol command as no
24       parsing of the buffer occurs within this function.
25
26       The difference between the two functions is that
27       upscli_sendline_timeout() lets the caller decide the amount of time
28       (timeout seconds) after which it should give up and return, whereas
29       upscli_sendline() does not offer this freedom, and uses an immediate
30       timeout (0 second).
31

RETURN VALUE

33       The upscli_sendline() and upscli_sendline_timeout() functions return 0
34       on success, or -1 if an error occurs.
35

SEE ALSO

37       upscli_fd(3), upscli_get(3), upscli_readline(3), upscli_sendline(3),
38       upscli_ssl(3), upscli_strerror(3), upscli_upserror(3)
39
40
41
42Network UPS Tools 2.8.0           04/26/2022                UPSCLI_SENDLINE(3)
Impressum