upscli_sendline_timeout(3)

upscli_sendline_timeout3

Send a single command to a ups

Part of upscli_sendline(3).

Usage

#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);

Overview

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.

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

From libupsclient-dev 2.8.1-5 in Debian 13 (Trixie). Parsed by carta from the page's man source.