diff --git a/Doxyfile b/Doxyfile index 6c2abb67..9bfd5da0 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = $(DOXYGEN_PROJECT_NAME) # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = v1.6.3 +PROJECT_NUMBER = vPublish-Docs # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -952,7 +952,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = ../../src/prg/c/inc-tmp # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/Doxyfile.in b/Doxyfile.in index f2ca7fb1..2175418c 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -952,7 +952,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = @top_srcdir@/src/prg/c/inc-tmp # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/Makefile b/Makefile index d938b32e..224e595b 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ -# Makefile.in generated by automake 1.16.1 from Makefile.am. +# Makefile.in generated by automake 1.16.5 from Makefile.am. # docs/doxygen/Makefile. Generated from Makefile.in by configure. -# Copyright (C) 1994-2018 Free Software Foundation, Inc. +# Copyright (C) 1994-2021 Free Software Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, @@ -58,6 +58,10 @@ # 17/07/2022 MG 1.0.9 Add a doxygen target. # # Add dependency on document sources and # # C sources. # +# 08/09/2022 MG 1.0.10 Remove all doxygen tarballs. Orphaned # +# tarballs can be left if git describe # +# changes and no make clean has been # +# performed. # # # ######################################################################### @@ -205,14 +209,14 @@ am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) am__DIST_COMMON = $(srcdir)/Doxyfile.in $(srcdir)/Makefile.in DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) pkglibexecdir = ${libexecdir}/${PACKAGE} -ACLOCAL = ${SHELL} /home/runner/work/swoc/swoc/missing aclocal-1.16 +ACLOCAL = ${SHELL} '/home/runner/work/swoc/swoc/build-aux/missing' aclocal-1.16 AMTAR = $${TAR-tar} AM_DEFAULT_VERBOSITY = 0 AR = ar ARFLAGS = cr -AUTOCONF = ${SHELL} /home/runner/work/swoc/swoc/missing autoconf -AUTOHEADER = ${SHELL} /home/runner/work/swoc/swoc/missing autoheader -AUTOMAKE = ${SHELL} /home/runner/work/swoc/swoc/missing automake-1.16 +AUTOCONF = ${SHELL} '/home/runner/work/swoc/swoc/build-aux/missing' autoconf +AUTOHEADER = ${SHELL} '/home/runner/work/swoc/swoc/build-aux/missing' autoheader +AUTOMAKE = ${SHELL} '/home/runner/work/swoc/swoc/build-aux/missing' automake-1.16 AWK = gawk BASH = /bin/bash CC = gcc @@ -220,6 +224,8 @@ CCDEPMODE = depmode=gcc3 CFLAGS = CPP = gcc -E CPPFLAGS = +CSCOPE = cscope +CTAGS = ctags CXX = g++ CXXCPP = g++ -E CXXDEPMODE = depmode=gcc3 @@ -236,6 +242,7 @@ ECHO_C = ECHO_N = -n ECHO_T = EGREP = /usr/bin/grep -E +ETAGS = etags EXEEXT = FGREP = /usr/bin/grep -F GETOPT = yes @@ -245,16 +252,17 @@ INSTALL_DATA = ${INSTALL} -m 644 INSTALL_PROGRAM = ${INSTALL} INSTALL_SCRIPT = ${INSTALL} INSTALL_STRIP_PROGRAM = $(install_sh) -c -s +IWYU = LD = /usr/bin/ld -m elf_x86_64 LDFLAGS = LIBGNU_LIBDEPS = LIBGNU_LTLIBDEPS = -LIBMGEC_CFLAGS = +LIBMGEC_CFLAGS = -I/usr/include/libmgec LIBMGEC_LIBS = -lmgec -LIBMGESYSUTILS_CFLAGS = +LIBMGESYSUTILS_CFLAGS = -I/usr/include/libmgesysutils -I/usr/include/libmgec LIBMGESYSUTILS_LIBS = -lmgesysutils -lmgec LIBOBJS = -LIBS = -lssh -lmgec -lmgesysutils +LIBS = LIBSSH_CFLAGS = LIBSSH_LIBS = -lssh LIBTOOL = $(SHELL) $(top_builddir)/libtool @@ -262,12 +270,12 @@ LIPO = LN_S = ln -s LTLIBOBJS = LT_SYS_LIBRARY_PATH = -MAKEINFO = ${SHELL} /home/runner/work/swoc/swoc/missing makeinfo +MAKEINFO = ${SHELL} '/home/runner/work/swoc/swoc/build-aux/missing' makeinfo MANIFEST_TOOL = : -MG_ANALYZER_CFLAGS = -MG_CFLAGS = -g -Wall -Wextra -fstack-protector-strong -grecord-gcc-switches -std=gnu11 -Wbad-function-cast -Wconversion -Wformat-security -Wdeclaration-after-statement -Wmissing-include-dirs -Wmissing-prototypes -Wredundant-decls -Wshadow -Wstrict-prototypes -fasynchronous-unwind-tables -Wduplicated-cond -Wnull-dereference -fstack-clash-protection -Wmultistatement-macros -O2 +MG_ANALYZER_CFLAGS = -fanalyzer +MG_CFLAGS = -g -Wall -Wextra -fstack-protector-strong -grecord-gcc-switches -std=gnu11 -Wbad-function-cast -Wconversion -Wdeclaration-after-statement -Wformat-security -Wmissing-include-dirs -Wmissing-prototypes -Wredundant-decls -Wshadow -Wstrict-prototypes -fasynchronous-unwind-tables -Wduplicated-cond -Wnull-dereference -fstack-clash-protection -Wmultistatement-macros -O2 MG_CPPFLAGS = -DHAVE_WINSOCK2_H=0 -Wdate-time -D_FORTIFY_SOURCE=2 -MG_DEBUG_CFLAGS = -g -Wall -Wextra -fstack-protector-strong -grecord-gcc-switches -std=gnu11 -Wbad-function-cast -Wconversion -Wformat-security -Wdeclaration-after-statement -Wmissing-include-dirs -Wmissing-prototypes -Wredundant-decls -Wshadow -Wstrict-prototypes -fasynchronous-unwind-tables -Wduplicated-cond -Wnull-dereference -fstack-clash-protection -Wmultistatement-macros -ggdb3 -O0 +MG_DEBUG_CFLAGS = -g -Wall -Wextra -fstack-protector-strong -grecord-gcc-switches -std=gnu11 -Wbad-function-cast -Wconversion -Wdeclaration-after-statement -Wformat-security -Wmissing-include-dirs -Wmissing-prototypes -Wredundant-decls -Wshadow -Wstrict-prototypes -fasynchronous-unwind-tables -Wduplicated-cond -Wnull-dereference -fstack-clash-protection -Wmultistatement-macros -ggdb3 -O0 MG_DEBUG_CPPFLAGS = -DHAVE_WINSOCK2_H=0 -Wdate-time MG_LDFLAGS = -Wl,-z,relro MKDIR_P = /usr/bin/mkdir -p @@ -280,19 +288,18 @@ OTOOL64 = PACKAGE = swoc PACKAGE_BUGREPORT = m.grant.prg@gmail.com PACKAGE_NAME = Server Wait On Client Package -PACKAGE_STRING = Server Wait On Client Package 1.6.3 +PACKAGE_STRING = Server Wait On Client Package Publish-Docs PACKAGE_TARNAME = swoc PACKAGE_URL = -PACKAGE_VERSION = 1.6.3 +PACKAGE_VERSION = Publish-Docs PATH_SEPARATOR = : PKGCONFIG = yes -PKG_CONFIG = /usr/bin/pkg-config -PKG_CONFIG_LIBDIR = -PKG_CONFIG_PATH = PTHREAD_CC = gcc PTHREAD_CFLAGS = -pthread -PTHREAD_LIBS = +PTHREAD_CXX = g++ +PTHREAD_LIBS = -lpthread RANLIB = ranlib +SCAN_BUILD = SED = /usr/bin/sed SET_MAKE = SHELL = /bin/bash @@ -300,7 +307,7 @@ STRIP = strip TAR = yes TXT2MAN = yes TXT2MANWRAP = yes -VERSION = 1.6.3 +VERSION = Publish-Docs abs_builddir = /home/runner/work/swoc/swoc/docs/doxygen abs_srcdir = /home/runner/work/swoc/swoc/docs/doxygen abs_top_builddir = /home/runner/work/swoc/swoc @@ -333,7 +340,7 @@ datarootdir = ${prefix}/share docbaseloc = ${prefix}/share/doc-base docdir = ${datarootdir}/doc/${PACKAGE_TARNAME} dvidir = ${docdir} -edit = /usr/bin/sed -e 's|@bashlocation@|$(BASH)|g' -e 's|@package_version@|$(package_version)|g' -e 's|@docbaseloc@|$(docbaseloc)|g' -e 's|@prefix@|$(prefix)|g' -e 's|@exec_prefix@|$(exec_prefix)|g' -e 's|@bindir@|$(bindir)|g' -e 's|@sbindir@|$(sbindir)|g' -e 's|@libexecdir@|$(libexecdir)|g' -e 's|@libdir@|$(libdir)|g' -e 's|@sysconfdir@|$(sysconfdir)|g' -e 's|@sharedstatedir@|$(sharedstatedir)|g' -e 's|@localstatedir@|$(localstatedir)|g' -e 's|@runstatedir@|$(runstatedir)|g' -e 's|@includedir@|$(includedir)|g' -e 's|@oldincludedir@|$(oldincludedir)|g' -e 's|@datarootdir@|$(datarootdir)|g' -e 's|@localedir@|$(localedir)|g' -e 's|@datadir@|$(datadir)|g' -e 's|@mandir@|$(mandir)|g' -e 's|@infodir@|$(infodir)|g' -e 's|@docdir@|$(docdir)|g' -e 's|@htmldir@|$(htmldir)|g' -e 's|@dvidir@|$(dvidir)|g' -e 's|@pdfdir@|$(pdfdir)|g' -e 's|@psdir@|$(psdir)|g' -e 's|@lispdir@|$(lispdir)|g' -e 's|@pkgdatadir@|$(pkgdatadir)|g' -e 's|@pkgincludedir@|$(pkgincludedir)|g' -e 's|@pkglibdir@|$(pkglibdir)|g' -e 's|@pkglibexecdir@|$(pkglibexecdir)|g' +edit = /usr/bin/sed -e 's|@cli_pc_requires@|$(cli_pc_requires)|g' -e 's|@cli_pc_requires_private@|$(cli_pc_requires_private)|g' -e 's|@com_pc_requires@|$(com_pc_requires)|g' -e 's|@com_pc_requires_private@|$(com_pc_requires_private)|g' -e 's|@srv_pc_requires@|$(srv_pc_requires)|g' -e 's|@srv_pc_requires_private@|$(srv_pc_requires_private)|g' -e 's|@pkgversion@|$(pkgversion)|g' -e 's|@bashlocation@|$(BASH)|g' -e 's|@docbaseloc@|$(docbaseloc)|g' -e 's|@CC@|$(CC)|g' -e 's|@prefix@|$(prefix)|g' -e 's|@exec_prefix@|$(exec_prefix)|g' -e 's|@bindir@|$(bindir)|g' -e 's|@sbindir@|$(sbindir)|g' -e 's|@libexecdir@|$(libexecdir)|g' -e 's|@libdir@|$(libdir)|g' -e 's|@sysconfdir@|$(sysconfdir)|g' -e 's|@sharedstatedir@|$(sharedstatedir)|g' -e 's|@localstatedir@|$(localstatedir)|g' -e 's|@runstatedir@|$(runstatedir)|g' -e 's|@includedir@|$(includedir)|g' -e 's|@oldincludedir@|$(oldincludedir)|g' -e 's|@datarootdir@|$(datarootdir)|g' -e 's|@localedir@|$(localedir)|g' -e 's|@datadir@|$(datadir)|g' -e 's|@mandir@|$(mandir)|g' -e 's|@infodir@|$(infodir)|g' -e 's|@docdir@|$(docdir)|g' -e 's|@htmldir@|$(htmldir)|g' -e 's|@dvidir@|$(dvidir)|g' -e 's|@pdfdir@|$(pdfdir)|g' -e 's|@psdir@|$(psdir)|g' -e 's|@lispdir@|$(lispdir)|g' -e 's|@pkgdatadir@|$(pkgdatadir)|g' -e 's|@pkgincludedir@|$(pkgincludedir)|g' -e 's|@pkglibdir@|$(pkglibdir)|g' -e 's|@pkglibexecdir@|$(pkglibexecdir)|g' exec_prefix = ${prefix} gl_LIBOBJS = gl_LTLIBOBJS = @@ -348,7 +355,7 @@ host_vendor = pc htmldir = ${docdir} includedir = ${prefix}/include infodir = ${datarootdir}/info -install_sh = ${SHELL} /home/runner/work/swoc/swoc/install-sh +install_sh = ${SHELL} /home/runner/work/swoc/swoc/build-aux/install-sh libdir = ${exec_prefix}/lib libexecdir = ${exec_prefix}/libexec lispdir = ${datarootdir}/emacs/site-lisp @@ -357,8 +364,8 @@ localstatedir = ${prefix}/var mandir = ${datarootdir}/man mkdir_p = $(MKDIR_P) oldincludedir = /usr/include -package_version = 1.6.3 pdfdir = ${docdir} +pkgversion = Publish-Docs prefix = /usr/local program_transform_name = s,x,x, psdir = ${docdir} @@ -402,9 +409,7 @@ docbase_DATA = swoc swoc-int EXTRA_DIST = $(docpkg) $(intdocpkg) $(srcdir)/src $(srcdir)/swoc.in \ $(srcdir)/swoc-int.in -CLEANFILES = doxywarn.txt doxygen.stamp doxygen1.stamp $(docpkg) $(intdocpkg) \ - swoc swoc-int - +CLEANFILES = doxywarn.txt doxygen.stamp doxygen1.stamp swoc swoc-int all: all-am .SUFFIXES: @@ -514,7 +519,6 @@ ctags CTAGS: cscope cscopelist: - distdir: $(BUILT_SOURCES) $(MAKE) $(AM_MAKEFLAGS) distdir-am @@ -751,6 +755,7 @@ uninstall-local: cd $(DESTDIR)$(intdir) && rm -rf html-int clean-local: + rm -rf html html-int swoc*doxy*.tar.gz rm -rf html html-int # Tell versions [3.59,3.63) of GNU make to not export all variables. diff --git a/Makefile.am b/Makefile.am index f7730176..2e585de5 100644 --- a/Makefile.am +++ b/Makefile.am @@ -42,6 +42,10 @@ # 17/07/2022 MG 1.0.9 Add a doxygen target. # # Add dependency on document sources and # # C sources. # +# 08/09/2022 MG 1.0.10 Remove all doxygen tarballs. Orphaned # +# tarballs can be left if git describe # +# changes and no make clean has been # +# performed. # # # ######################################################################### @@ -167,9 +171,9 @@ EXTRA_DIST = $(docpkg) $(intdocpkg) $(srcdir)/src $(srcdir)/swoc.in \ $(srcdir)/swoc-int.in -CLEANFILES = doxywarn.txt doxygen.stamp doxygen1.stamp $(docpkg) $(intdocpkg) \ - swoc swoc-int +CLEANFILES = doxywarn.txt doxygen.stamp doxygen1.stamp swoc swoc-int clean-local: + rm -rf html html-int swoc*doxy*.tar.gz rm -rf html html-int diff --git a/Makefile.in b/Makefile.in index df0af46d..f418a6b9 100644 --- a/Makefile.in +++ b/Makefile.in @@ -1,7 +1,7 @@ -# Makefile.in generated by automake 1.16.1 from Makefile.am. +# Makefile.in generated by automake 1.16.5 from Makefile.am. # @configure_input@ -# Copyright (C) 1994-2018 Free Software Foundation, Inc. +# Copyright (C) 1994-2021 Free Software Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, @@ -58,6 +58,10 @@ # 17/07/2022 MG 1.0.9 Add a doxygen target. # # Add dependency on document sources and # # C sources. # +# 08/09/2022 MG 1.0.10 Remove all doxygen tarballs. Orphaned # +# tarballs can be left if git describe # +# changes and no make clean has been # +# performed. # # # ######################################################################### @@ -220,6 +224,8 @@ CCDEPMODE = @CCDEPMODE@ CFLAGS = @CFLAGS@ CPP = @CPP@ CPPFLAGS = @CPPFLAGS@ +CSCOPE = @CSCOPE@ +CTAGS = @CTAGS@ CXX = @CXX@ CXXCPP = @CXXCPP@ CXXDEPMODE = @CXXDEPMODE@ @@ -236,6 +242,7 @@ ECHO_C = @ECHO_C@ ECHO_N = @ECHO_N@ ECHO_T = @ECHO_T@ EGREP = @EGREP@ +ETAGS = @ETAGS@ EXEEXT = @EXEEXT@ FGREP = @FGREP@ GETOPT = @GETOPT@ @@ -245,6 +252,7 @@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +IWYU = @IWYU@ LD = @LD@ LDFLAGS = @LDFLAGS@ LIBGNU_LIBDEPS = @LIBGNU_LIBDEPS@ @@ -286,13 +294,12 @@ PACKAGE_URL = @PACKAGE_URL@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ PKGCONFIG = @PKGCONFIG@ -PKG_CONFIG = @PKG_CONFIG@ -PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ -PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ PTHREAD_CC = @PTHREAD_CC@ PTHREAD_CFLAGS = @PTHREAD_CFLAGS@ +PTHREAD_CXX = @PTHREAD_CXX@ PTHREAD_LIBS = @PTHREAD_LIBS@ RANLIB = @RANLIB@ +SCAN_BUILD = @SCAN_BUILD@ SED = @SED@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ @@ -357,8 +364,8 @@ localstatedir = @localstatedir@ mandir = @mandir@ mkdir_p = @mkdir_p@ oldincludedir = @oldincludedir@ -package_version = @package_version@ pdfdir = @pdfdir@ +pkgversion = @pkgversion@ prefix = @prefix@ program_transform_name = @program_transform_name@ psdir = @psdir@ @@ -402,9 +409,7 @@ docbase_DATA = swoc swoc-int EXTRA_DIST = $(docpkg) $(intdocpkg) $(srcdir)/src $(srcdir)/swoc.in \ $(srcdir)/swoc-int.in -CLEANFILES = doxywarn.txt doxygen.stamp doxygen1.stamp $(docpkg) $(intdocpkg) \ - swoc swoc-int - +CLEANFILES = doxywarn.txt doxygen.stamp doxygen1.stamp swoc swoc-int all: all-am .SUFFIXES: @@ -514,7 +519,6 @@ ctags CTAGS: cscope cscopelist: - distdir: $(BUILT_SOURCES) $(MAKE) $(AM_MAKEFLAGS) distdir-am @@ -751,6 +755,7 @@ uninstall-local: @DISTCHECKFAKE_FALSE@ cd $(DESTDIR)$(intdir) && rm -rf html-int clean-local: + rm -rf html html-int swoc*doxy*.tar.gz rm -rf html html-int # Tell versions [3.59,3.63) of GNU make to not export all variables. diff --git a/html-int/100-overview_8md.html b/html-int/100-overview_8md.html index c2300ed3..58e1a8df 100644 --- a/html-int/100-overview_8md.html +++ b/html-int/100-overview_8md.html @@ -3,7 +3,7 @@
- +
+ Server Wait On Clients System - Full Internal Documentation
+ vPublish-Docs
+
+ Server Wait On Clients System.
+ |
+
Functions to process client lock flag options. +More...
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <syslog.h>
#include <unistd.h>
#include <libmgec.h>
#include <libswocclient.h>
#include <libswoccommon.h>
#include <mge-errno.h>
#include <mgemessage.h>
#include <remsyslog.h>
#include <libmgec/libmgec.h>
#include <libmgec/mge-message.h>
#include <libmgec/mge-errno.h>
#include <libmgesysutils/mge-remsyslog.h>
#include <swoc/libswocclient.h>
#include <swoc/libswoccommon.h>
Macros | |
#define | _Bool signed char |
#define | _Bool signed char |
#define | bool _Bool |
#define | bool _Bool |
#define | false 0 |
#define | false 0 |
#define | true 1 |
#define | true 1 |
#define | __bool_true_false_are_defined 1 |
#define | __bool_true_false_are_defined 1 |
Functions | |
int | swc_show_status (void) |
Display client's lock status. More... | |
int | swc_show_status (void) |
Display client's lock status. More... | |
int | swc_show_srv_block_status (void) |
Display status of server blocking. More... | |
int | swc_show_srv_block_status (void) |
Display status of server blocking. More... | |
int | swc_block (void) |
Set block flag on server to prevent this client from setting any more locks. More... | |
int | swc_block (void) |
Set block flag on server to prevent this client from setting any more locks. More... | |
int | swc_unblock (void) |
Remove block flag on server to allow this client to set locks. More... | |
int | swc_unblock (void) |
Remove block flag on server to allow this client to set locks. More... | |
int | swc_set_lock (void) |
Set lock flag on server. More... | |
int | swc_set_lock (void) |
Set lock flag on server. More... | |
int | swc_rel_lock (void) |
Release lock flag on server. More... | |
int | swc_rel_lock (void) |
Release lock flag on server. More... | |
int | swc_client_wait (char *cnumlocks) |
Wait until only a maximum of cnumlocks for this client remains. More... | |
int | swc_client_wait (char *cnumlocks) |
Wait until only a maximum of cnumlocks for this client remains. More... | |
int | swc_reset (void) |
Reset the client on the server to 0 locks and unblocked. More... | |
int | swc_reset (void) |
Reset the client on the server to 0 locks and unblocked. More... | |
Variables | |
char | locks_held [10] = "0" |
Holds the number of locks currently held during swc_client_wait(). More... | |
char | locks_held [10] = "0" |
Holds the number of locks currently held during swc_client_wait(). More... | |
Functions to process client lock flag options.
+Functions to process client lock flag options.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Holds the number of locks currently held during swc_client_wait().
+Holds the number of locks currently held during swc_client_wait().
This value can be accessed in a handler if a signal is received.
Source for version functions. +More...
#include <stdio.h>
#include <stdlib.h>
#include <config.h>
#include <libswocclient.h>
#include <swoc/libswocclient.h>
Functions | |
char * | libswocclient_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | libswocclient_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | libswocclient_get_src_version (void) |
Get the source version. More... | |
char * | libswocclient_get_src_version (void) |
Get the source version. More... | |
void | libswocclient_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | libswocclient_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | libswocclient_print_src_version (void) |
Print the source version string to stdout. More... | |
void | libswocclient_print_src_version (void) |
Print the source version string to stdout. More... | |
Source for version functions.
- +Source for version functions.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Command line argument processing for swocclient using getopt_long. +More...
#include <getopt.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "internal.h"
#include <cmdlineargs.h>
#include <mge-errno.h>
#include "internal.h"
#include <libmgec/mge-errno.h>
#include <swoc/cmdlineargs.h>
Functions | |
int | process_cla (int argc, char **argv,...) |
Process command line arguments using getopt_long. More... | |
int | process_cla (int argc, char **argv,...) |
Process command line arguments using getopt_long. More... | |
int | cpyarg (char *flagarg, char *srcarg) |
int | cpyarg (char *flagarg, char *srcarg) |
Command line argument processing for swocclient using getopt_long.
+Command line argument processing for swocclient using getopt_long.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
#include <portability.h>
Header file for Server Wait on Clients client-side program. +More...
+#include <libmgec/mge-portability.h>
Go to the source code of this file.
+Go to the source code of this file.
Functions | |
BEGIN_C_DECLS char * | swocclient_get_pkg_version (void) |
Get the git-describe based package version. More... | |
BEGIN_C_DECLS char * | swocclient_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | swocclient_get_src_version (void) |
Get the source version. More... | |
char * | swocclient_get_src_version (void) |
Get the source version. More... | |
void | swocclient_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | swocclient_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | swocclient_print_src_version (void) |
Print the source version string to stdout. More... | |
void | swocclient_print_src_version (void) |
Print the source version string to stdout. More... | |
Header file for Server Wait on Clients client-side program.
- +Header file for Server Wait on Clients client-side program.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Server Wait On Clients client program. +More...
#include <stdio.h>
#include <stdlib.h>
#include "internal.h"
#include "signalhandle.h"
#include <cmdlineargs.h>
#include <libswocclient.h>
#include <mge-errno.h>
#include <libmgec/mge-errno.h>
#include <swoc/cmdlineargs.h>
#include <swoc/libswocclient.h>
#include <swoc/signalhandle.h>
Functions | |
int | main (int argc, char **argv) |
Program entry point. More... | |
int | main (int argc, char **argv) |
Program entry point. More... | |
Variables | |
static char * | prog_name |
The name of this program. More... | |
static char * | prog_name |
The name of this program. More... | |
Server Wait On Clients client program. To enable a client to place lock flags on a server which will then wait for them to be cleared before continuing processing, (by use of swocserver -w).
+Server Wait On Clients client program.
+To enable a client to place lock flags on a server which will then wait for them to be cleared before continuing processing, (by use of swocserver -w).
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
#include <errno.h>
#include <signal.h>
Signal handling functions. +More...
+#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <signalhandle.h>
#include <libswocclient.h>
#include <swoc/libswocclient.h>
#include <swoc/signalhandle.h>
Functions | |
void | init_sig_handle (void) |
Initialise signal handler. More... | |
void | init_sig_handle (void) |
Initialise signal handler. More... | |
void | termination_handler (int signum) |
Handler for caught signals. More... | |
void | termination_handler (int signum) |
Handler for caught signals. More... | |
Signal handling functions.
+Signal handling functions.
- +Likely terminate signals to handle.
SIGTERM
@@ -136,10 +137,10 @@SIGCONT
SIGTSTP (Ctrl-Z)
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Source for version functions. +More...
Functions | |
char * | swocclient_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | swocclient_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | swocclient_get_src_version (void) |
Get the source version. More... | |
char * | swocclient_get_src_version (void) |
Get the source version. More... | |
void | swocclient_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | swocclient_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | swocclient_print_src_version (void) |
Print the source version string to stdout. More... | |
void | swocclient_print_src_version (void) |
Print the source version string to stdout. More... | |
Source for version functions.
- +Source for version functions.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Header file for command line processing. +More...
#include <limits.h>
#include <portability.h>
#include <libmgec/mge-portability.h>
Header file for command line processing.
- +Header file for command line processing.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
To parse and validate the config file. +More...
#include <ctype.h>
#include <errno.h>
#include <limits.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <syslog.h>
#include <configmake.h>
#include <configfile.h>
#include <libswoccommon.h>
#include <mge-errno.h>
#include <libmgec/mge-errno.h>
#include <libmgesysutils/mge-configfile.h>
#include <swoc/libswoccommon.h>
Functions | |
static int | validateconfigfileparams (const struct confsection *) |
static int | validateconfigfileparams (const struct confsection *) |
static int | validatepollint (const struct confsection *) |
static int | validatepollint (const struct confsection *) |
static int | validatessh (const struct confsection *ps) |
static int | validatessh (const struct confsection *ps) |
static int | validateserver (const struct confsection *) |
static int | validateserver (const struct confsection *) |
static int | validatesrvportno (const struct confsection *) |
static int | validatesrvportno (const struct confsection *) |
static int | validatesshportno (const struct confsection *) |
static int | validatesshportno (const struct confsection *) |
static int | validatesshuser (const struct confsection *ps) |
static int | validatesshuser (const struct confsection *ps) |
int | swcom_validate_config (void) |
Parse and validate the config file. More... | |
int | swcom_validate_config (void) |
Parse and validate the config file. More... | |
Variables | |
int | pollint |
Polling interval. More... | |
int | pollint |
Polling interval. More... | |
int | ssh |
Use SSH false == 0, true == 1. More... | |
int | ssh |
Use SSH false == 0, true == 1. More... | |
char | server [_POSIX_HOST_NAME_MAX] |
Server name. More... | |
char | server [_POSIX_HOST_NAME_MAX] |
Server name. More... | |
int | srvportno |
Server port number. More... | |
int | srvportno |
Server port number. More... | |
int | sshportno |
Local port to use if using SSH. More... | |
int | sshportno |
Local port to use if using SSH. More... | |
char | sshuser [_POSIX_LOGIN_NAME_MAX] |
Server username for SSH. More... | |
char | sshuser [_POSIX_LOGIN_NAME_MAX] |
Server username for SSH. More... | |
To parse and validate the config file.
+To parse and validate the config file.
Used for swocserver and swocclient not swocserverd.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Source for version functions. +More...
#include <stdio.h>
#include <stdlib.h>
#include <config.h>
#include <libswoccommon.h>
#include <swoc/libswoccommon.h>
Functions | |
char * | libswoccommon_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | libswoccommon_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | libswoccommon_get_src_version (void) |
Get the source version. More... | |
char * | libswoccommon_get_src_version (void) |
Get the source version. More... | |
void | libswoccommon_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | libswoccommon_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | libswoccommon_print_src_version (void) |
Print the source version string to stdout. More... | |
void | libswoccommon_print_src_version (void) |
Print the source version string to stdout. More... | |
Source for version functions.
- +Source for version functions.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
#include <errno.h>
Comms functions associated with the swocserverd daemon. +More...
+#include <netdb.h>
#include <netinet/in.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/epoll.h>
#include <sys/socket.h>
#include <syslog.h>
#include <unistd.h>
#include "internal.h"
#include <bstree.h>
#include <libmgec.h>
#include <libswoccommon.h>
#include <mge-errno.h>
#include <mgebuffer.h>
#include <mgemessage.h>
#include <libmgec/libmgec.h>
#include <libmgec/mge-bstree.h>
#include <libmgec/mge-buffer.h>
#include <libmgec/mge-errno.h>
#include <libmgec/mge-message.h>
#include <swoc/libswoccommon.h>
Comms functions associated with the swocserverd daemon.
+Comms functions associated with the swocserverd daemon.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
+ Server Wait On Clients System - Full Internal Documentation
+ vPublish-Docs
+
+ Server Wait On Clients System.
+ |
+
File in src/prg/c/src/cli-lib | Includes file in src/prg/c/inc |
---|---|
optionproc.c | swoc / libswocclient.h |
optionproc.c | swoc / libswoccommon.h |
version.c | swoc / libswocclient.h |
File in src/prg/c/src/cli-lib | Includes file in src/prg/c/inc |
---|---|
libswocclient / optionproc.c | api / libswocclient.h |
libswocclient / optionproc.c | internal / libswoccommon.h |
libswocclient / version.c | api / libswocclient.h |
File in src/prg/c/src/srv-lib | Includes file in src/prg/c/inc |
---|---|
optionproc.c | swoc / libswoccommon.h |
optionproc.c | swoc / libswocserver.h |
version.c | swoc / libswocserver.h |
File in src/prg/c/src/cli-lib/libswocclient | Includes file in src/prg/c/inc |
---|---|
optionproc.c | api / libswocclient.h |
optionproc.c | internal / libswoccommon.h |
version.c | api / libswocclient.h |
File in src/prg/c/src/cli-prg | Includes file in src/prg/c/inc |
---|---|
cmdlineargs.c | swoc / cmdlineargs.h |
main.c | swoc / cmdlineargs.h |
main.c | swoc / libswocclient.h |
main.c | swoc / signalhandle.h |
signalhandle.c | swoc / libswocclient.h |
signalhandle.c | swoc / signalhandle.h |
File in src/prg/c/src/srv-lib | Includes file in src/prg/c/inc |
---|---|
libswocserver / optionproc.c | internal / libswoccommon.h |
libswocserver / optionproc.c | api / libswocserver.h |
libswocserver / version.c | api / libswocserver.h |
File in src/prg/c/src/com-lib | Includes file in src/prg/c/inc |
---|---|
messages.c | swoc / libswoccommon.h |
ssh.c | swoc / libswoccommon.h |
tcp.c | swoc / libswoccommon.h |
validateconfig.c | swoc / libswoccommon.h |
version.c | swoc / libswoccommon.h |
File in src/prg/c/src/srv-lib/libswocserver | Includes file in src/prg/c/inc |
---|---|
optionproc.c | internal / libswoccommon.h |
optionproc.c | api / libswocserver.h |
version.c | api / libswocserver.h |
File in src/prg/c/src/srv-prg | Includes file in src/prg/c/inc |
---|---|
swocserver / cmdlineargs.c | swoc / cmdlineargs.h |
swocserver / internal.h | swoc / libswocserver.h |
swocserver / main.c | swoc / cmdlineargs.h |
swocserver / main.c | swoc / libswocserver.h |
swocserver / main.c | swoc / signalhandle.h |
swocserver / signalhandle.c | swoc / libswocserver.h |
swocserver / signalhandle.c | swoc / signalhandle.h |
swocserverd / cmdlineargs.c | swoc / cmdlineargs.h |
swocserverd / comms.c | swoc / libswoccommon.h |
swocserverd / internal.h | swoc / libswoccommon.h |
swocserverd / main.c | swoc / cmdlineargs.h |
swocserverd / main.c | swoc / signalhandle.h |
swocserverd / request.c | swoc / libswoccommon.h |
swocserverd / signalhandle.c | swoc / signalhandle.h |
File in src/prg/c/src/cli-prg | Includes file in src/prg/c/inc |
---|---|
swocclient / cmdlineargs.c | internal / cmdlineargs.h |
swocclient / main.c | internal / signalhandle.h |
swocclient / main.c | internal / cmdlineargs.h |
swocclient / main.c | api / libswocclient.h |
swocclient / signalhandle.c | internal / signalhandle.h |
swocclient / signalhandle.c | api / libswocclient.h |
File in src/prg/c/src/srv-prg/swocserver | Includes file in src/prg/c/inc |
---|---|
cmdlineargs.c | swoc / cmdlineargs.h |
internal.h | swoc / libswocserver.h |
main.c | swoc / cmdlineargs.h |
main.c | swoc / libswocserver.h |
main.c | swoc / signalhandle.h |
signalhandle.c | swoc / libswocserver.h |
signalhandle.c | swoc / signalhandle.h |
File in src/prg/c/src/cli-prg/swocclient | Includes file in src/prg/c/inc |
---|---|
cmdlineargs.c | internal / cmdlineargs.h |
main.c | internal / cmdlineargs.h |
main.c | api / libswocclient.h |
main.c | internal / signalhandle.h |
signalhandle.c | api / libswocclient.h |
signalhandle.c | internal / signalhandle.h |
File in src/prg/c/src/srv-prg/swocserverd | Includes file in src/prg/c/inc |
---|---|
cmdlineargs.c | swoc / cmdlineargs.h |
comms.c | swoc / libswoccommon.h |
internal.h | swoc / libswoccommon.h |
main.c | swoc / cmdlineargs.h |
main.c | swoc / signalhandle.h |
request.c | swoc / libswoccommon.h |
signalhandle.c | swoc / signalhandle.h |
- Server Wait On Clients System - Full Internal Documentation
- v1.6.3
-
- Server Wait On Clients System.
- |
-
File in src/prg/c/src/com-lib | Includes file in src/prg/c/inc |
---|---|
libswoccommon / messages.c | internal / libswoccommon.h |
libswoccommon / ssh.c | internal / libswoccommon.h |
libswoccommon / tcp.c | internal / libswoccommon.h |
libswoccommon / validateconfig.c | internal / libswoccommon.h |
libswoccommon / version.c | internal / libswoccommon.h |
- Server Wait On Clients System - Full Internal Documentation
- v1.6.3
-
- Server Wait On Clients System.
- |
-
File in src/prg/c/src/com-lib/libswoccommon | Includes file in src/prg/c/inc |
---|---|
messages.c | internal / libswoccommon.h |
ssh.c | internal / libswoccommon.h |
tcp.c | internal / libswoccommon.h |
validateconfig.c | internal / libswoccommon.h |
version.c | internal / libswoccommon.h |
- Server Wait On Clients System - Full Internal Documentation
- v1.6.3
-
- Server Wait On Clients System.
- |
-
File in src/prg/c/src/srv-prg | Includes file in src/prg/c/inc |
---|---|
swocserver / cmdlineargs.c | internal / cmdlineargs.h |
swocserver / internal.h | api / libswocserver.h |
swocserver / main.c | internal / cmdlineargs.h |
swocserver / main.c | internal / signalhandle.h |
swocserver / signalhandle.c | api / libswocserver.h |
swocserver / signalhandle.c | internal / signalhandle.h |
swocserverd / cmdlineargs.c | internal / cmdlineargs.h |
swocserverd / comms.c | internal / libswoccommon.h |
swocserverd / internal.h | internal / libswoccommon.h |
swocserverd / main.c | internal / cmdlineargs.h |
swocserverd / main.c | internal / signalhandle.h |
swocserverd / signalhandle.c | internal / signalhandle.h |
- Server Wait On Clients System - Full Internal Documentation
- v1.6.3
-
- Server Wait On Clients System.
- |
-
File in src/prg/c/src/srv-prg/swocserver | Includes file in src/prg/c/inc |
---|---|
cmdlineargs.c | internal / cmdlineargs.h |
internal.h | api / libswocserver.h |
main.c | internal / cmdlineargs.h |
main.c | internal / signalhandle.h |
signalhandle.c | api / libswocserver.h |
signalhandle.c | internal / signalhandle.h |
- Server Wait On Clients System - Full Internal Documentation
- v1.6.3
-
- Server Wait On Clients System.
- |
-
-Files | |
file | optionproc.c |
file | version.c |
- Server Wait On Clients System - Full Internal Documentation
- v1.6.3
-
- Server Wait On Clients System.
- |
-
-Files | |
file | libswocclient.h [code] |
file | libswocserver.h [code] |
Server Wait On Clients System - Full Internal Documentation
- v1.6.3
+ vPublish-Docs
Server Wait On Clients System.
|
@@ -35,10 +35,10 @@
-Directories | |
directory | libswoccommon |
+Files | |
file | ssh.c |
SSH connection processing functions. | |
file | tcp.c |
TCP connection processing functions. | |
file | validateconfig.c |
To parse and validate the config file. | |
file | version.c |
Source for version functions. | |
Directories | |
directory | api |
directory | internal |
directory | swoc |
-Directories | |
directory | swocclient |
+Files | |
file | cmdlineargs.c |
Command line argument processing for swocclient using getopt_long. | |
file | internal.h [code] |
Header file for Server Wait on Clients client-side program. | |
file | main.c |
Server Wait On Clients client program. | |
file | signalhandle.c |
Signal handling functions. | |
file | version.c |
Source for version functions. | |
Files | |
file | cmdlineargs.h [code] |
Header file for command line processing. | |
file | libswocclient.h [code] |
Header file for Server Wait on Clients client-side library. | |
file | libswoccommon.h [code] |
Internal header file for Server Wait on Client common library. | |
file | libswocserver.h [code] |
Header file for Server Wait on Clients server-side library. | |
file | signalhandle.h [code] |
Header file for signal handling. | |
- Server Wait On Clients System - Full Internal Documentation
- v1.6.3
-
- Server Wait On Clients System.
- |
-
-Files | |
file | ssh.c |
file | tcp.c |
file | validateconfig.c |
file | version.c |
- Server Wait On Clients System - Full Internal Documentation
- v1.6.3
-
- Server Wait On Clients System.
- |
-
-Files | |
file | optionproc.c |
file | version.c |
-Directories | |
directory | libswocclient |
+Files | |
file | optionproc.c |
Functions to process client lock flag options. | |
file | version.c |
Source for version functions. | |
- Server Wait On Clients System - Full Internal Documentation
- v1.6.3
-
- Server Wait On Clients System.
- |
-
-Files | |
file | cmdlineargs.c |
file | internal.h [code] |
file | main.c |
file | signalhandle.c |
file | version.c |
-Directories | |
directory | libswocserver |
+Files | |
file | optionproc.c |
Functions to process server lock flag options. | |
file | version.c |
Source for version functions. | |
▼ docs | |
▼ doxygen | |
src | |
src | |
▼ src | |
▼ prg | |
▼ c | |
▼ inc | |
▼ api | |
libswocclient.h | |
libswocserver.h | |
▼ internal | |
cmdlineargs.h | |
libswoccommon.h | |
signalhandle.h | |
▼ src | |
▼ cli-lib | |
▼ libswocclient | |
optionproc.c | |
version.c | |
▼ swoc | |
cmdlineargs.h | Header file for command line processing |
libswocclient.h | Header file for Server Wait on Clients client-side library |
libswoccommon.h | Internal header file for Server Wait on Client common library |
libswocserver.h | Header file for Server Wait on Clients server-side library |
signalhandle.h | Header file for signal handling |
▼ src | |
▼ cli-lib | |
optionproc.c | Functions to process client lock flag options |
version.c | Source for version functions |
▼ cli-prg | |
▼ swocclient | |
cmdlineargs.c | |
internal.h | |
main.c | |
signalhandle.c | |
version.c | |
▼ com-lib | |
▼ libswoccommon | |
messages.c | |
ssh.c | |
tcp.c | |
validateconfig.c | |
version.c | |
cmdlineargs.c | Command line argument processing for swocclient using getopt_long |
internal.h | Header file for Server Wait on Clients client-side program |
main.c | Server Wait On Clients client program |
signalhandle.c | Signal handling functions |
version.c | Source for version functions |
▼ com-lib | |
messages.c | Message processing functions common to swoc programs |
ssh.c | SSH connection processing functions |
tcp.c | TCP connection processing functions |
validateconfig.c | To parse and validate the config file |
version.c | Source for version functions |
▼ srv-lib | |
▼ libswocserver | |
optionproc.c | |
version.c | |
▼ srv-prg | |
▼ swocserver | |
cmdlineargs.c | |
internal.h | |
main.c | |
signalhandle.c | |
version.c | |
▼ swocserverd | |
cmdlineargs.c | |
comms.c | |
internal.h | |
main.c | |
request.c | |
signalhandle.c | |
validateconfig.c | |
version.c | |
optionproc.c | Functions to process server lock flag options |
version.c | Source for version functions |
▼ srv-prg | |
▼ swocserver | |
cmdlineargs.c | Command line argument processing for swocserver using getopt_long |
internal.h | Header file for Server Wait on Clients server-side program |
main.c | Server Wait On Clients server program |
signalhandle.c | Signal handling functions |
version.c | Source for version functions |
▼ swocserverd | |
cmdlineargs.c | Command line argument processing for swocserverd using getopt_long |
comms.c | Comms functions associated with the swocserverd daemon |
internal.h | Header file for Server Wait on Clients server-side daemon |
main.c | Server Wait On Clients server daemon |
request.c | Request processing functions |
signalhandle.c | Signal handling functions |
validateconfig.c | To parse and validate the config file |
version.c | Source for version functions |
The Server Wait On Client (SWOC) system provides a simple lock-flag based method of synchronising activities between 1 or more clients and a server.
Communication is via TCP which can optionally be secured by using an SSH tunnel.
@@ -177,9 +178,7 @@
#include <portability.h>
Header file for Server Wait on Clients client-side library. +More...
+#include <libmgec/mge-portability.h>
Header file for Server Wait on Clients client-side library.
- +Header file for Server Wait on Clients client-side library.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
|
+ +extern | +
Holds the number of locks currently held during swc_client_wait().
+Holds the number of locks currently held during swc_client_wait().
This value can be accessed in a handler if a signal is received.
-Holds the number of locks currently held during swc_client_wait().
+Holds the number of locks currently held during swc_client_wait().
This value can be accessed in a handler if a signal is received.
Internal header file for Server Wait on Client common library. +More...
#include <netdb.h>
#include <sys/types.h>
#include <mgemessage.h>
#include <portability.h>
#include <libmgec/mge-message.h>
#include <libmgec/mge-portability.h>
Enumerations | |
enum | msg_source { swocclient, -swocserver, -swocserverd, -src_err + |
enum | msg_source { swocclient +, swocserver +, swocserverd +, src_err } |
enum identifying the source of a message. More... | |
enum | msg_request { - swocallow, -swocblock, -swocblocklist, -swocblockstatus, - - swocdisallow, -swocend, -swocid, -swoclock, - - swocrelease, -swocreload, -swocreset, -swocstatus, - - swocunblock, -req_err + swocallow +, swocblock +, swocblocklist +, swocblockstatus +, + swocdisallow +, swocend +, swocid +, swoclock +, + swocrelease +, swocreload +, swocreset +, swocstatus +, + swocunblock +, req_err } |
enum identifying the message request. More... | |
enum | msg_arguments { args_ok, -args_err + |
enum | msg_arguments { args_ok +, args_err } |
enum specifying error status of arguments. More... | |
enum | comms_mode { recv_mode, -send_mode + |
enum | comms_mode { recv_mode +, send_mode } |
enum indentify send or receive mode. More... | |
Internal header file for Server Wait on Client common library.
- +Internal header file for Server Wait on Client common library.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
|
+ +extern | +
Polling interval.
@@ -912,11 +923,19 @@
|
+ +extern | +
Server name.
@@ -928,11 +947,19 @@
|
+ +extern | +
Server port number.
@@ -944,11 +971,19 @@
|
+ +extern | +
Use SSH false == 0, true == 1.
@@ -960,11 +995,19 @@
|
+ +extern | +
Local port to use if using SSH.
@@ -976,11 +1019,19 @@
|
+ +extern | +
Server username for SSH.
@@ -992,10 +1043,8 @@#include <portability.h>
Header file for Server Wait on Clients server-side library. +More...
+#include <libmgec/mge-portability.h>
Header file for Server Wait on Clients server-side library.
- +Header file for Server Wait on Clients server-side library.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
|
+ +extern | +
Holds the number of locks currently held during swc_client_wait().
+Holds the number of locks currently held during swc_client_wait().
This value can be accessed in a handler if a signal is received.
-Holds the number of locks currently held during swc_client_wait().
+Holds the number of locks currently held during swc_client_wait().
This value can be accessed in a handler if a signal is received.
+ Server Wait On Clients System - Full Internal Documentation
+ vPublish-Docs
+
+ Server Wait On Clients System.
+ |
+
This documentation covers some important aspects of the AutoTools project structure and build.
+A bash script called bootstrap.sh is provided in the project root directory. It is a helper script to build the project. Apart from the core configure and make it has options to run the analyzer, make check, run sparse, use debugging flags etc. Rather than duplicate documentation here, please see the acmbuild wiki. (acmbuild.sh is just a wrapper to bootstrap.sh and takes all the same arguments). The wiki can be found at:-
+https://github.com/m-grant-prg/acmbuild/wiki
+The initial gnulib setup is performed by the command:-
+Files generated by the configmake modules are not tracked in git but the m4 macros in the m4 directory are. This allows people to work from a source tarball or a git clone without having to install gnulib and running gnulib-tool. This is described as option 3 on:-
+https://www.gnu.org/software/gnulib/manual/html_node/VCS-Issues.html
+The bootstrap.sh script has a -g option which will perform a:-
gnulib-tool --update # If you have gnulib installed. +
The gnulib files committed are updated by the repo owner from the latest version he has installed.
+The Temporary Header / Library concept is designed for use when an application (or library) is in concurrent development with a library on which it depends.
+The library and headers which form the dependency can be copied here from an external project and linked against, thus testing the inter-action between the two.
+Multiple libraries can be handled in this fashion with each library having it's own directory.
+The header files should be located depending on how they are installed. So, if installed in includedir then the header will be in inc-tmp, if pkgincludedir then in a subdirectory named after the package. This is also how they are referenced in code, for example:-
+The resulting structure would look something like:-
+configure.ac provides the inc-tmp Makefile.am with the variable tmpheaders. This contains a space separated list of relative (to inc-tmp) paths to each temporary header file.
+In addition, configure.ac checking of availability of such a header using AC_HEADER_CHECK is conditional on it not being present in inc-tmp.
+As mentioned above, the C include directives are the same for an installed package and for temporary headers.
+Consumption is facilitated in each Makefile.am via the C pre-processor flags xxxxxx_CPPFLAGS. A typical example would be:-
+The files for each library should be copied to their own directory under lib-tmp including the hidden .libs directory. The resulting directory structure would look something like:-
+configure.ac provides Makefile.am's with a variable tmplibraries. This variable contains a space separated list of the absolute paths of all libraries under lib-tmp.
+In addition, configure.ac checks the availability of such libraries in strict order of lib-tmp, PKG_CHECK_MODULES and lastly AC_SEARCH_LIBS.
+To be able to LINK against any temporary libraries, the Makefile.am must have the following line:-
+N.B.
+LDADD as opposed to xxxxxxxxx_LDFLAGS must be used as LDFLAGS does not necessarily set the search path variable LD_LIBRARY_PATH in the desired order, the standard location may precede our temporary library location in the search path.
+It can be useful to be able to prove which libraries are being used in a libtool environment. ldd may be the first thought however it can be quite misleading, as shown run against a project library project test program:-
+The answer is to switch on debugging. This produces voluminous output but near the end of one of the output files you will find the inits and finis for the libraries it is using. (See man 8 ld.so).
+Simplify the search by:-
+So, for libraries go to the .libs directory and use ldd ./library.so and for executables use the debugging shown above.
+Take the scenario where you have written a test program for a project library. Now the previous stable release may be installed on your machine. You do not want to link against that library but the one in development. To achieve this place the following in the test program Makefile.am:-
+LDADD = ../libmgesysutils/libmgesysutils.la
+Installation instructions can be found in the README file at:-
+https://github.com/m-grant-prg/swoc
+and on the wiki:-
+https://github.com/m-grant-prg/swoc/wiki
+Having installed shared libraries it is necessary to run ldconfig to refresh links and cache. This cannot be automatically included in the installation as it will cause downstream package builds to fail when trying to access files (/etc) outside their chroot. It is easier to ask that this be run manually after 'make install'.
+This package produces documentation designed to be registered with scrollkeeper and dochelp. The problem arises when it is required to have an AT installation and a package manager installation residing in parallel. In the case of doc-base this would mean installing 2 sets of documentation with the same docid. Needless to say doc-base does not like this.
+The solution is not to automatically install the doc-base documents unless specifically asked to do so with the –enable-atonly argument supplied to configure.
+Message processing functions common to swoc programs. +More...
#include <arpa/inet.h>
#include <errno.h>
#include <limits.h>
#include <netdb.h>
#include <netinet/in.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <syslog.h>
#include <libswoccommon.h>
#include <mge-errno.h>
#include <mgebuffer.h>
#include <mgemessage.h>
#include <libmgec/mge-buffer.h>
#include <libmgec/mge-errno.h>
#include <libmgec/mge-message.h>
#include <swoc/libswoccommon.h>
Message processing functions common to swoc programs.
+Message processing functions common to swoc programs.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Request processing functions. +More...
#include <arpa/inet.h>
#include <errno.h>
#include <limits.h>
#include <netdb.h>
#include <netinet/in.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/socket.h>
#include <syslog.h>
#include "internal.h"
#include <bstree.h>
#include <libmgec.h>
#include <mge-errno.h>
#include <mgememory.h>
#include <mgemessage.h>
#include <libmgec/libmgec.h>
#include <libmgec/mge-bstree.h>
#include <libmgec/mge-errno.h>
#include <libmgec/mge-memory.h>
#include <libmgec/mge-message.h>
#include <swoc/libswoccommon.h>
Request processing functions.
+Request processing functions.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
#include <portability.h>
Header file for signal handling. +More...
+#include <libmgec/mge-portability.h>
Header file for signal handling.
- +Header file for signal handling.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Functions to process server lock flag options. +More...
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <syslog.h>
#include <unistd.h>
#include <libmgec.h>
#include <libswoccommon.h>
#include <libswocserver.h>
#include <mge-errno.h>
#include <mgemessage.h>
#include <libmgec/libmgec.h>
#include <libmgec/mge-errno.h>
#include <libmgec/mge-message.h>
#include <swoc/libswoccommon.h>
#include <swoc/libswocserver.h>
Macros | |
#define | _Bool signed char |
#define | _Bool signed char |
#define | bool _Bool |
#define | bool _Bool |
#define | false 0 |
#define | false 0 |
#define | true 1 |
#define | true 1 |
#define | __bool_true_false_are_defined 1 |
#define | __bool_true_false_are_defined 1 |
Functions | |
int | sws_show_status (void) |
Display clients with active locks to stdout. More... | |
int | sws_show_status (void) |
Display clients with active locks to stdout. More... | |
int | sws_show_block_status (void) |
Display status of server blocking. More... | |
int | sws_show_block_status (void) |
Display status of server blocking. More... | |
int | sws_srv_block (void) |
Request server blocking. More... | |
int | sws_srv_block (void) |
Request server blocking. More... | |
int | sws_srv_unblock (void) |
Request removal of server blocking. More... | |
int | sws_srv_unblock (void) |
Request removal of server blocking. More... | |
int | sws_show_cli_blocklist (void) |
Display list of blocked clients to stdout. More... | |
int | sws_show_cli_blocklist (void) |
Display list of blocked clients to stdout. More... | |
int | sws_server_wait (void) |
Wait until no client locks remain. More... | |
int | sws_server_wait (void) |
Wait until no client locks remain. More... | |
int | sws_release (char *lockname) |
Remove a lock. More... | |
int | sws_release (char *lockname) |
Remove a lock. More... | |
int | sws_cli_block (char *blockname) |
Set a client to blocked. More... | |
int | sws_cli_block (char *blockname) |
Set a client to blocked. More... | |
int | sws_cli_unblock (char *blockname) |
Unblock a client block. More... | |
int | sws_cli_unblock (char *blockname) |
Unblock a client block. More... | |
int | sws_end_daemon (void) |
Terminate the daemon. More... | |
int | sws_end_daemon (void) |
Terminate the daemon. More... | |
int | sws_reload_config (void) |
Request the daemon to reload the config file. More... | |
int | sws_reload_config (void) |
Request the daemon to reload the config file. More... | |
Variables | |
char | locks_held [12] = "0" |
Holds the number of clients currently holding locks during sws_server_wait(). More... | |
char | locks_held [12] = "0" |
Holds the number of clients currently holding locks during sws_server_wait(). More... | |
Functions to process server lock flag options.
+Functions to process server lock flag options.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Holds the number of clients currently holding locks during sws_server_wait().
-Holds the number of locks currently held during swc_client_wait().
+Holds the number of clients currently holding locks during sws_server_wait().
+Holds the number of locks currently held during swc_client_wait().
This value can be accessed in a handler if a signal is received.
Source for version functions. +More...
#include <stdio.h>
#include <stdlib.h>
#include <config.h>
#include <libswocserver.h>
#include <swoc/libswocserver.h>
Functions | |
char * | libswocserver_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | libswocserver_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | libswocserver_get_src_version (void) |
Get the source version. More... | |
char * | libswocserver_get_src_version (void) |
Get the source version. More... | |
void | libswocserver_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | libswocserver_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | libswocserver_print_src_version (void) |
Print the source version string to stdout. More... | |
void | libswocserver_print_src_version (void) |
Print the source version string to stdout. More... | |
Source for version functions.
- +Source for version functions.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Command line argument processing for swocserver using getopt_long. +More...
#include <getopt.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sysexits.h>
#include "internal.h"
#include <cmdlineargs.h>
#include <mge-errno.h>
#include <libmgec/mge-errno.h>
#include <swoc/cmdlineargs.h>
Command line argument processing for swocserver using getopt_long.
+Command line argument processing for swocserver using getopt_long.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
#include <libswocserver.h>
#include <portability.h>
Header file for Server Wait on Clients server-side program. +More...
+Header file for Server Wait on Clients server-side program.
- +Header file for Server Wait on Clients server-side program.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
|
+ +extern | +
Global swocserver error flag.
@@ -249,9 +260,7 @@Server Wait On Clients server program. +More...
#include <stdio.h>
#include <stdlib.h>
#include "internal.h"
#include <cmdlineargs.h>
#include <mge-errno.h>
#include <signalhandle.h>
#include <libmgec/mge-errno.h>
#include <swoc/cmdlineargs.h>
#include <swoc/libswocserver.h>
#include <swoc/signalhandle.h>
Server Wait On Clients server program. To enable a server to wait on clients releasing flags prior to further server processing. (By use of swocserver -w).
- +Server Wait On Clients server program.
+To enable a server to wait on clients releasing flags prior to further server processing. (By use of swocserver -w).
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
#include <errno.h>
#include <signal.h>
Signal handling functions. +More...
+#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <libswocserver.h>
#include <signalhandle.h>
#include <swoc/libswocserver.h>
#include <swoc/signalhandle.h>
Signal handling functions.
+Signal handling functions.
- +Likely terminate signals to handle.
SIGTERM
@@ -136,10 +137,10 @@SIGCONT
SIGTSTP (Ctrl-Z)
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Source for version functions. +More...
Source for version functions.
+Source for version functions.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Command line argument processing for swocserverd using getopt_long. +More...
#include <getopt.h>
#include <stdio.h>
#include <stdlib.h>
#include <sysexits.h>
#include "internal.h"
#include <cmdlineargs.h>
#include <mge-errno.h>
#include <libmgec/mge-errno.h>
#include <swoc/cmdlineargs.h>
Command line argument processing for swocserverd using getopt_long.
+Command line argument processing for swocserverd using getopt_long.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Header file for Server Wait on Clients server-side daemon. +More...
#include <limits.h>
#include <bstree.h>
#include <libswoccommon.h>
#include <mgemessage.h>
#include <portability.h>
#include <libmgec/mge-bstree.h>
#include <libmgec/mge-message.h>
#include <libmgec/mge-portability.h>
#include <swoc/libswoccommon.h>
Header file for Server Wait on Clients server-side daemon.
- +Header file for Server Wait on Clients server-side daemon.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
|
+ +extern | +
Clients and locks.
@@ -1262,11 +1273,19 @@
|
+ +extern | +
Client name.
@@ -1278,11 +1297,19 @@
|
+ +extern | +
Socket file descriptor in use.
@@ -1294,11 +1321,19 @@
|
+ +extern | +
Debug - 0 false, 1 true.
@@ -1310,11 +1345,19 @@
|
+ +extern | +
End pending.
@@ -1340,11 +1383,19 @@
|
+ +extern | +
Port / socket config mappings.
@@ -1356,11 +1407,19 @@
|
+ +extern | +
Server is blocked?
@@ -1372,11 +1431,19 @@
|
+ +extern | +
swoc daemon error number.
@@ -1389,9 +1456,7 @@Server Wait On Clients server daemon. +More...
#include <errno.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <syslog.h>
#include <unistd.h>
#include "internal.h"
#include <bstree.h>
#include <cmdlineargs.h>
#include <configmake.h>
#include <libmgec.h>
#include <mge-errno.h>
#include <signalhandle.h>
#include "internal.h"
#include <libmgec/libmgec.h>
#include <libmgec/mge-bstree.h>
#include <libmgec/mge-errno.h>
#include <swoc/cmdlineargs.h>
#include <swoc/signalhandle.h>
Server Wait On Clients server daemon. Daemon to enable a server to manage client locks and wait on the removal of those locks prior to further server processing.
+Server Wait On Clients server daemon.
+Daemon to enable a server to manage client locks and wait on the removal of those locks prior to further server processing.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Signal handling functions. +More...
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <syslog.h>
#include "internal.h"
#include <signalhandle.h>
#include <libmgec/mge-bstree.h>
#include <swoc/signalhandle.h>
Signal handling functions.
+Signal handling functions.
- +Likely terminate signals to handle.
SIGTERM
@@ -140,10 +144,10 @@SIGCONT
SIGTSTP (Ctrl-Z)
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
To parse and validate the config file. +More...
#include <ctype.h>
#include <errno.h>
#include <stdio.h>
#include <syslog.h>
#include <configmake.h>
#include "internal.h"
#include <configfile.h>
#include <mge-errno.h>
#include <libmgec/mge-errno.h>
#include <libmgesysutils/mge-configfile.h>
To parse and validate the config file.
- +To parse and validate the config file.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Source for version functions. +More...
Source for version functions.
+Source for version functions.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
#include <errno.h>
#include <libssh/libssh.h>
SSH connection processing functions. +More...
+#include <libssh/libssh.h>
#include <netinet/in.h>
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <strings.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <syslog.h>
#include <libswoccommon.h>
#include <mge-errno.h>
#include <mgememory.h>
#include <unistd.h>
#include <libmgec/mge-errno.h>
#include <libmgec/mge-memory.h>
#include <swoc/libswoccommon.h>
SSH connection processing functions.
+SSH connection processing functions.
Covers tunnel creation and destruction including all authentication. Creates a seperate thread for data relay through the tunnel.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
TCP connection processing functions. +More...
#include <errno.h>
#include <netdb.h>
#include <netinet/in.h>
#include <stdio.h>
#include <string.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <syslog.h>
#include <unistd.h>
#include <libmgec.h>
#include <libswoccommon.h>
#include <mge-errno.h>
#include <libmgec/libmgec.h>
#include <libmgec/mge-errno.h>
#include <swoc/libswoccommon.h>
TCP connection processing functions.
+TCP connection processing functions.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
+ Server Wait On Clients System - API Documentation
+ vPublish-Docs
+
+ Server Wait On Clients System.
+ |
+
Ccla | Command line argument |
+ Server Wait On Clients System - API Documentation
+ vPublish-Docs
+
+ Server Wait On Clients System.
+ |
+
Functions to process client lock flag options. +More...
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <syslog.h>
#include <unistd.h>
#include <libmgec.h>
#include <libswocclient.h>
#include <libswoccommon.h>
#include <mge-errno.h>
#include <mgemessage.h>
#include <remsyslog.h>
#include <libmgec/libmgec.h>
#include <libmgec/mge-message.h>
#include <libmgec/mge-errno.h>
#include <libmgesysutils/mge-remsyslog.h>
#include <swoc/libswocclient.h>
#include <swoc/libswoccommon.h>
Macros | |
#define | _Bool signed char |
#define | _Bool signed char |
#define | bool _Bool |
#define | bool _Bool |
#define | false 0 |
#define | false 0 |
#define | true 1 |
#define | true 1 |
#define | __bool_true_false_are_defined 1 |
#define | __bool_true_false_are_defined 1 |
Functions | |
int | swc_show_status (void) |
Display client's lock status. More... | |
int | swc_show_status (void) |
Display client's lock status. More... | |
int | swc_show_srv_block_status (void) |
Display status of server blocking. More... | |
int | swc_show_srv_block_status (void) |
Display status of server blocking. More... | |
int | swc_block (void) |
Set block flag on server to prevent this client from setting any more locks. More... | |
int | swc_block (void) |
Set block flag on server to prevent this client from setting any more locks. More... | |
int | swc_unblock (void) |
Remove block flag on server to allow this client to set locks. More... | |
int | swc_unblock (void) |
Remove block flag on server to allow this client to set locks. More... | |
int | swc_set_lock (void) |
Set lock flag on server. More... | |
int | swc_set_lock (void) |
Set lock flag on server. More... | |
int | swc_rel_lock (void) |
Release lock flag on server. More... | |
int | swc_rel_lock (void) |
Release lock flag on server. More... | |
int | swc_client_wait (char *cnumlocks) |
Wait until only a maximum of cnumlocks for this client remains. More... | |
int | swc_client_wait (char *cnumlocks) |
Wait until only a maximum of cnumlocks for this client remains. More... | |
int | swc_reset (void) |
Reset the client on the server to 0 locks and unblocked. More... | |
int | swc_reset (void) |
Reset the client on the server to 0 locks and unblocked. More... | |
Variables | |
char | locks_held [10] = "0" |
Holds the number of locks currently held during swc_client_wait(). More... | |
char | locks_held [10] = "0" |
Holds the number of locks currently held during swc_client_wait(). More... | |
Functions to process client lock flag options.
+Functions to process client lock flag options.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Holds the number of locks currently held during swc_client_wait().
+Holds the number of locks currently held during swc_client_wait().
This value can be accessed in a handler if a signal is received.
Source for version functions. +More...
#include <stdio.h>
#include <stdlib.h>
#include <config.h>
#include <libswocclient.h>
#include <swoc/libswocclient.h>
Functions | |
char * | libswocclient_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | libswocclient_get_pkg_version (void) |
Get the git-describe based package version. More... | |
char * | libswocclient_get_src_version (void) |
Get the source version. More... | |
char * | libswocclient_get_src_version (void) |
Get the source version. More... | |
void | libswocclient_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | libswocclient_print_pkg_version (void) |
Print the package version string to stdout. More... | |
void | libswocclient_print_src_version (void) |
Print the source version string to stdout. More... | |
void | libswocclient_print_src_version (void) |
Print the source version string to stdout. More... | |
Source for version functions.
- +Source for version functions.
+Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Command line argument processing for swocclient using getopt_long. +More...
#include <getopt.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "internal.h"
#include <cmdlineargs.h>
#include <mge-errno.h>
#include <libmgec/mge-errno.h>
#include <swoc/cmdlineargs.h>
Functions | |
int | process_cla (int argc, char **argv,...) |
Process command line arguments using getopt_long. More... | |
int | process_cla (int argc, char **argv,...) |
Process command line arguments using getopt_long. More... | |
int | cpyarg (char *flagarg, char *srcarg) |
int | cpyarg (char *flagarg, char *srcarg) |
Command line argument processing for swocclient using getopt_long.
+Command line argument processing for swocclient using getopt_long.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
Server Wait On Clients client program. +More...
#include <stdio.h>
#include <stdlib.h>
#include "internal.h"
#include "signalhandle.h"
#include <cmdlineargs.h>
#include <libswocclient.h>
#include <mge-errno.h>
#include <libmgec/mge-errno.h>
#include <swoc/cmdlineargs.h>
#include <swoc/libswocclient.h>
#include <swoc/signalhandle.h>
Functions | |
int | main (int argc, char **argv) |
Program entry point. More... | |
int | main (int argc, char **argv) |
Program entry point. More... | |
Variables | |
static char * | prog_name |
The name of this program. More... | |
static char * | prog_name |
The name of this program. More... | |
Server Wait On Clients client program. To enable a client to place lock flags on a server which will then wait for them to be cleared before continuing processing, (by use of swocserver -w).
+Server Wait On Clients client program.
+To enable a client to place lock flags on a server which will then wait for them to be cleared before continuing processing, (by use of swocserver -w).
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only