libswocserver.h File Reference

Header file for Server Wait on Clients server-side library. More...

#include <libmgec/mge-portability.h>

Include dependency graph for libswocserver.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	sws_show_status (void)
	Display clients with active locks to stdout.
int	sws_show_block_status (void)
	Display status of server blocking.
int	sws_srv_block (void)
	Request server blocking.
int	sws_srv_unblock (void)
	Request removal of server blocking.
int	sws_show_cli_blocklist (void)
	Display list of blocked clients to stdout.
int	sws_server_wait (void)
	Wait until no client locks remain.
int	sws_release (const char *lockname)
	Remove a lock.
int	sws_cli_block (const char *blockname)
	Set a client to blocked.
int	sws_cli_unblock (const char *blockname)
	Unblock a client block.
int	sws_end_daemon (void)
	Terminate the daemon.
int	sws_reload_config (void)
	Request the daemon to reload the config file.
	__attribute__ ((const)) const char *libswocserver_get_pkg_version(void)
	Get the git-describe based package version.
void	libswocserver_print_pkg_version (void)
	Print the package version string to stdout.
void	libswocserver_print_src_version (void)
	Print the source version string to stdout.

Variables
BEGIN_C_DECLS char	locks_held []
	Holds the number of locks currently held during swc_client_wait().

Detailed Description

Header file for Server Wait on Clients server-side library.

Author

Copyright (C) 2016-2019, 2021-2023 Mark Grant

Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only

Version

v1.1.0 ==== 25/11/2023

Function Documentation

__attribute__()

__attribute__

(

(const)

)

const

Get the git-describe based package version.

Get the source version.

Returns

The package version string.

The source version string.

libswocserver_print_pkg_version()

void libswocserver_print_pkg_version

(

void

)

Print the package version string to stdout.

libswocserver_print_src_version()

void libswocserver_print_src_version

(

void

)

Print the source version string to stdout.

sws_cli_block()

int sws_cli_block

(

const char *

blockname

)

Set a client to blocked.

On error mge_errno is set.

Parameters

blockname

Client to block.

Returns

0 on success, < zero on failure.

sws_cli_unblock()

int sws_cli_unblock

(

const char *

blockname

)

Unblock a client block.

On error mge_errno is set.

Parameters

blockname

Client to unblock.

Returns

0 on success, < zero on failure.

sws_end_daemon()

int sws_end_daemon

(

void

)

Terminate the daemon.

Send a message to the daemon asking it to terminate. On error mge_errno is set.

Returns

0 on success, < zero on failure.

sws_release()

int sws_release

(

const char *

lockname

)

Remove a lock.

On error mge_errno is set.

Parameters

lockname

Client whose lock is to be removed.

Returns

0 on success, < zero on failure.

sws_reload_config()

int sws_reload_config

(

void

)

Request the daemon to reload the config file.

Send a message to the daemon asking it to reload it's configuration file. On error mge_errno is set.

Returns

0 on success, < zero on failure.

sws_server_wait()

int sws_server_wait

(

void

)

Wait until no client locks remain.

On error mge_errno is set.

Returns

0 on success, < zero on failure.

sws_show_block_status()

int sws_show_block_status

(

void

)

Display status of server blocking.

On error mge_errno is set.

Returns

0 on success, < zero on failure.

sws_show_cli_blocklist()

int sws_show_cli_blocklist

(

void

)

Display list of blocked clients to stdout.

On error mge_errno is set.

Returns

The number of blocked or < zero on error.

sws_show_status()

int sws_show_status

(

void

)

Display clients with active locks to stdout.

On error mge_errno is set.

Returns

The number of clients with locks or < zero on error.

sws_srv_block()

int sws_srv_block

(

void

)

Request server blocking.

On error mge_errno is set.

Returns

0 on success, < zero on failure.

sws_srv_unblock()

int sws_srv_unblock

(

void

)

Request removal of server blocking.

On error mge_errno is set.

Returns

0 on success, < zero on failure.

Variable Documentation

locks_held

BEGIN_C_DECLS char locks_held[]

extern

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().

This value can be accessed in a handler if a signal is received.