Usage

Creating a usage environment

There are two ways to install FULLOCK library in your environment.
One is to download and install the package of FULLOCK library from packagecloud.io.
The other way is to build and install FULLOCK library from source code yourself.
These methods are described below.

Installing packages

The FULLOCK library publishes packages in packagecloud.io - AntPickax stable repository so that anyone can use it.
The package of the FULLOCK library is released in the form of Debian package, RPM package.
Since the installation method differs depending on your OS, please check the following procedure and install it.

For recent Debian-based Linux distributions users, follow the steps below:

$ sudo apt-get update -y
$ sudo apt-get install curl -y
$ curl -s https://packagecloud.io/install/repositories/antpickax/stable/script.deb.sh | sudo bash
$ sudo apt-get install libfullock

To install the developer package, please install the following package.

$ sudo apt-get install libfullock-dev

For users who use supported Fedora other than latest version, follow the steps below:

$ sudo dnf makecache
$ sudo dnf install curl -y
$ curl -s https://packagecloud.io/install/repositories/antpickax/stable/script.rpm.sh | sudo bash
$ sudo dnf install libfullock

To install the developer package, please install the following package.

$ sudo dnf install libfullock-devel

For other recent RPM-based Linux distributions users, follow the steps below:

$ sudo yum makecache
$ sudo yum install curl -y
$ curl -s https://packagecloud.io/install/repositories/antpickax/stable/script.rpm.sh | sudo bash
$ sudo yum install libfullock

To install the developer package, please install the following package.

$ sudo yum install libfullock-devel

Other OS

If you are not using the above OS, packages are not prepared and can not be installed directly.
In this case, build from the source code described below and install it.

Build and install from source code

For details on how to build and install FULLOCK library from source code, please see Build.

How to linking

You can use it by linking the FULLOCK library to the program.

When you start the program linking the FULLOCK library, shared memory is automatically created and ready for use.
When the program uses the function of FULLOCK, you do not need to initialize about FULLOCK, and you can immediately call and use FULLOCK I/F.

If you want to change the default setting(the file path to shared memory, etc.), you can change those by calling I/F or FULLOCK environment.
It can be customized program-specific by setting before using FULLOCK function.