Server Wait On Clients System - API Documentation  v1.7.4
Server Wait On Clients System.
Overview

General

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.

Components

The system is split into 9 packages providing the various elememts:

libswoccommon
Library containing functions common to server and client.


libswoccommon-dev
Development files for the libswoccommon library (Include files, man pages, etc).


libswocclient
Library containing client-side functions.


libswocclient-dev
Development files for the libswocclient library (Include files, man pages, etc).


swocclient-c
The command line program for controlling locks from the client side.


libswocserver
Library containing server-side functions.


libswocserver-dev
Development files for the libswocserver library (Include files, man pages, etc).


swocserver-c
The command line program for controlling locks from the server-side.


swoc-doc
This documentation package.


Requirements

The system requires the following packages:-

For Run-Time

  • The MGE General C Library (libmgec).
  • The MGE System Utilities Library (libmgesysutils).
  • The SSH library (libssh). The distro package comes in multiple flavours depending on which encryption library libssh has been linked against. An example on Debian would be libssh-gcrypt-4.

For Development

  • The MGE General C Library development package(libmgec-dev).
  • The MGE System Utilities Library development package (libmgesysutils-dev).
  • The SSH library development package. Use the development package associated with the choice above. In this case on Debian it would be libssh-gcrypt-dev.
  • Doxygen.