使い方

利用環境構築

FULLOCKライブラリをご利用の環境にインストールするには、2つの方法があります。
ひとつは、packagecloud.ioからFULLOCKライブラリのパッケージをダウンロードし、インストールする方法です。
もうひとつは、ご自身でFULLOCKライブラリをソースコードからビルドし、インストールする方法です。
これらの方法について、以下に説明します。

パッケージのインストール

FULLOCKライブラリは、誰でも利用できるようにpackagecloud.io - AntPickax stable repositoryでパッケージを公開しています。
FULLOCKライブラリのパッケージは、Debianパッケージ、RPMパッケージの形式で公開しています。
お使いのOSによりインストール方法が異なりますので、以下の手順を確認してインストールしてください。

DebianベースLinuxの利用者は、以下の手順に従ってください。

$ 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

開発者向けパッケージをインストールする場合は、以下のパッケージをインストールしてください。

$ sudo apt-get install libfullock-dev

RPMベースのLinuxの場合は、以下の手順に従ってください。

$ 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

開発者向けパッケージをインストールする場合は、以下のパッケージをインストールしてください。

$ sudo dnf install libfullock-devel

ALPINEベースのLinuxの場合は、以下の手順に従ってください。

# apk update
# apk add curl
# curl -s https://packagecloud.io/install/repositories/antpickax/stable/script.alpine.sh | sh
# apk add libfullock

開発者向けパッケージをインストールする場合は、以下のパッケージをインストールしてください。

# apk add libfullock-dev

上記以外のOS

上述したOS以外をお使いの場合は、パッケージが準備されていないため、直接インストールすることはできません。
この場合には、後述のソースコードからビルドし、インストールするようにしてください。

ソースコードからビルド・インストール

FULLOCKライブラリをソースコードからビルドし、インストールする方法は、ビルドを参照してください。

利用方法

FULLOCKライブラリをプログラムにリンクするだけで利用できます。

FULLOCKライブラリをリンクしたプログラムを起動すると、自動的に共有メモリが作成され、利用できる準備がなされます。
プログラムでFULLOCKを利用する時には、初期化などは不要であり、そのままFULLOCKのI/Fを呼び出し利用できます。

初期設定（共有メモリへのファイルパス、他）を変更する場合には、変更用のI/F、環境変数が準備されていますので、利用を開始する前に設定することでプログラム固有でカスタマイズできます。