upscli_sendline - Man Page

send a single command to a UPS

Synopsis

#include <upsclient.h>
#include <time.h> /* or <sys/time.h> on some platforms */
int upscli_sendline(UPSCONN_t *ups, const char *buf, size_t buflen);
int upscli_sendline_timeout(UPSCONN_t *ups, const char *buf, size_t buflen,
                               const time_t timeout);

Description

The upscli_sendline() and upscli_sendline_timeout() functions take the pointer ups to a UPSCONN_t state structure and transmit a buffer buf of size buflen to the server.

The data in buf must be a fully formatted protocol command as no parsing of the buffer occurs within this function.

The difference between the two functions is that upscli_sendline_timeout() lets the caller decide the amount of time (timeout seconds) after which it should give up and return, whereas upscli_sendline() does not offer this freedom, and uses an immediate timeout (0 second).

Return Value

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

See Also

upscli_fd(3), upscli_get(3), upscli_readline(3), upscli_sendline(3), upscli_ssl(3), upscli_strerror(3), upscli_upserror(3)

Referenced By

upsclient(3), upscli_list_start(3), upscli_readline(3), upscli_splitaddr(3), upscli_splitname(3), upscli_ssl(3), upscli_strerror(3), upscli_upserror(3).

The man page upscli_sendline_timeout(3) is an alias of upscli_sendline(3).

07/03/2024 Network UPS Tools 2.8.2. NUT Manual