Server Wait On Clients System - API Documentation  v1.6.4
Server Wait On Clients System.
libswocclient.h
Go to the documentation of this file.
1 
14 /* **********************************************************************
15  * *
16  * Changelog *
17  * *
18  * Date Author Version Description *
19  * *
20  * 16/07/2016 MG 1.0.1 First version release. *
21  * 17/07/2016 MG 1.0.2 Move towards kernel coding style. *
22  * 06/01/2017 MG 1.0.3 Modify to use swocserverd daemon and *
23  * TCP stream. *
24  * 06/02/2017 MG 1.0.4 Add pollint and wait function. *
25  * 02/10/2017 MG 1.0.5 Move validate config to common. *
26  * 11/11/2017 MG 1.0.6 Add Doxygen comments. *
27  * Add SPDX license tag. *
28  * 02/02/2018 MG 1.0.7 Add number of locks parameter to wait. *
29  * 18/03/2018 MG 1.0.8 Add locks_held for use during signal *
30  * handling, primarily in swocclient -w. *
31  * 02/05/2018 MG 1.0.9 Add support for client block list. *
32  * 18/05/2018 MG 1.0.10 Add show server block status. *
33  * 18/05/2019 MG 1.0.11 Merge sub-projects into one. *
34  * 11/10/2021 MG 1.0.12 Move to inc directory. *
35  * 08/12/2021 MG 1.0.13 Tighten SPDX tag. *
36  * 17/09/2022 MG 1.0.14 Rename portability.h *
37  * Use pkginclude location. *
38  * *
39  ************************************************************************
40  */
41 
42 #ifndef LIBSWOCCLIENT_H
43 #define LIBSWOCCLIENT_H
44 
45 #include <libmgec/mge-portability.h>
46 
47 BEGIN_C_DECLS
48 
49 extern char locks_held[];
50 
51 int swc_show_status(void);
52 
54 
55 int swc_block(void);
56 
57 int swc_unblock(void);
58 
59 int swc_set_lock(void);
60 
61 int swc_rel_lock(void);
62 
63 int swc_client_wait(char *cnumlocks);
64 
65 int swc_reset(void);
66 
68 
70 
72 
74 
75 END_C_DECLS
76 
77 #endif /* ndef LIBSWOCCLIENT_H */
BEGIN_C_DECLS char locks_held[]
Holds the number of locks currently held during swc_client_wait().
Definition: optionproc.c:106
void libswocclient_print_src_version(void)
Print the source version string to stdout.
Definition: version.c:76
int swc_set_lock(void)
Set lock flag on server.
Definition: optionproc.c:314
int swc_client_wait(char *cnumlocks)
Wait until only a maximum of cnumlocks for this client remains.
Definition: optionproc.c:416
int swc_reset(void)
Reset the client on the server to 0 locks and unblocked.
Definition: optionproc.c:495
void libswocclient_print_pkg_version(void)
Print the package version string to stdout.
Definition: version.c:67
int swc_block(void)
Set block flag on server to prevent this client from setting any more locks.
Definition: optionproc.c:216
int swc_show_status(void)
Display client's lock status.
Definition: optionproc.c:113
int swc_show_srv_block_status(void)
Display status of server blocking.
Definition: optionproc.c:165
int swc_unblock(void)
Remove block flag on server to allow this client to set locks.
Definition: optionproc.c:265
char * libswocclient_get_pkg_version(void)
Get the git-describe based package version.
Definition: version.c:50
int swc_rel_lock(void)
Release lock flag on server.
Definition: optionproc.c:363
char * libswocclient_get_src_version(void)
Get the source version.
Definition: version.c:59