File: libnutclient_misc.txt

package info (click to toggle)
nut 2.7.4-8
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 10,964 kB
  • sloc: ansic: 70,278; sh: 12,814; python: 2,202; cpp: 1,715; makefile: 1,406; perl: 705; xml: 40
file content (52 lines) | stat: -rw-r--r-- 1,533 bytes parent folder | download | duplicates (4)
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
LIBNUTCLIENT_MISC(3)
====================

NAME
----

libnutclient_misc, nutclient_authenticate, nutclient_logout, 
nutclient_device_login, nutclient_get_device_num_logins, 
nutclient_device_master, nutclient_device_forced_shutdown -
Miscelaneous functions in Network UPS Tools high-level client access library

SYNOPSIS
--------

	#include <nutclient.h>

	typedef void* NUTCLIENT_t;

	void nutclient_authenticate(NUTCLIENT_t client, const char* login, const char* passwd);
	void nutclient_logout(NUTCLIENT_t client);
	void nutclient_device_login(NUTCLIENT_t client, const char* dev);
	int nutclient_get_device_num_logins(NUTCLIENT_t client, const char* dev);
	void nutclient_device_master(NUTCLIENT_t client, const char* dev);
	void nutclient_device_forced_shutdown(NUTCLIENT_t client, const char* dev);

DESCRIPTION
-----------

The *nutclient_authenticate()* function authenticate the user.

'login' is the user name.

'passwd' is the user password.

The *nutclient_logout()* function disconnect gracefully from the server.

The *nutclient_device_login()* function log the fact that a system
is drawing power from this UPS.

The *nutclient_get_device_num_logins()* function retrieve the number of clients
which have been logged for this device.

The *nutclient_device_master()* function make sure that master-level
functions like FSD are available if necessary.

The *nutclient_device_forced_shutdown()* function sets the "forced shutdown" flag on the device.

'dev' is the device name.

SEE ALSO
--------
linkman:libnutclient[3]