Feature TOP Build

使い方

K2HDKC Node.jsをビルドした後で、動作確認をしてみます。

1. 実行環境の構築

まず、実行環境を構築します。
構築は、パッケージから構築する方法と、k2hdkc nodejs addonライブラリをビルドして利用する方法があります。

1.1 パッケージを利用して環境を構築

パッケージを利用して実行環境を構築する方法を説明します。
k2hdkc nodejs addonライブラリのパッケージは、npmにあります。

このパッケージをインストールする前に、K2HDKCの開発者パッケージが必要となりますので、K2HDKCのドキュメントを参照してください。
K2HDKCをインストールする方法も、パッケージからのインストールと、K2HDKCを自身でビルドする方法がありますので、使い方もしくはビルドのドキュメントを参照してください。

事前にK2HDKCをインストールした後、k2hdkc nodejs addonライブラリのnpmパッケージは、以下のようにインストールします。
npmコマンドの詳細についてはこちらを参照してください。

$ npm install k2hdkc

1.2 ビルドして環境を構築

ソースコードからk2hdkc nodejs addonライブラリをビルドすることができます。
ソースコードのgithubリポジトリをcloneし、ビルドする方法はこちらを参照してください。

2. K2HDKCサーバーノードプロセスとCHMPXプロセスの起動

K2HDKC Node.jsが使うK2HDKCサーバーノードプロセスが必要となります。
K2HDKCサーバーノードプロセスとクライアントプログラムの通信には、通信ミドルウエアであるCHMPXのサーバーノード、スレーブノードも必要となります。
これらのプロセスの起動方法についての詳細は、K2HDKC 使い方とCHMPX 使い方を参照してください。

テストのために起動するこれらのプロセスは以下のようにして起動することができます。

$ cd k2hdkc_nodejs
$ test/run_process_helper.sh start_all

run_process_helper.shスクリプトは、テストで使用されているヘルパスクリプトであり、ローカルホスト上にCHMPXサーバーノード×2、K2HDKCプロセス×2、CHMPXスレーブノード×1を起動します。
以下に示すようにプロセスの起動を確認できます。

$ ps ax
3156 pts/1    Sl     0:00 chmpx -conf /home/guest/k2hdkc_nodejs/test/test_server.ini -ctlport 8021
3162 pts/1    Sl     0:00 chmpx -conf /home/guest/k2hdkc_nodejs/test/test_server.ini -ctlport 8023
3168 pts/1    Sl     0:00 k2hdkc -conf /home/guest/k2hdkc_nodejs/test/test_server.ini -ctlport 8021
3176 pts/1    Sl     0:00 k2hdkc -conf /home/guest/k2hdkc_nodejs/test/test_server.ini -ctlport 8023
3185 pts/1    Sl     0:00 chmpx -conf /home/guest/k2hdkc_nodejs/test/test_slave.ini

これらのプロセスを終了する場合は以下に示すようにします。

$ test/run_process_helper.sh stop_all

これらの詳細については、testディレクトリのrun_process_helper.shスクリプトと設定ファイル（*.ini）を確認してください。

3. サンプル

以下のようなファイルを作成し、ファイル作成、キーと値の書き込み、読み出しができるか確認してみてください。

var k2hdkc = require('k2hdkc');                                     // import k2hdkc nodejs addon library
var	dkcobj = new k2hdkc('test_slave.ini', 8031, null, true, false); // initialize for permanent connecting

dkcobj.setValue('key', 'value', 'subkey', null, 0);                 // test for writing

dkcobj.getValue('subkey', null, true, null);                        // test for reading by subkey directly
dkcobj.getValue('key', 'subkey', true, null);                       // test for reading with key and subkey

dkcobj.clean();                                                     // cleanup

4. ロード・実行

基本として、JavaScript言語でライブラリを読み込むためのrequireでK2HDKC Node.js アドオンライブラリを読み込みます。
その後は、K2HDKC Node.js アドオンライブラリが提供するクラス・関数・メソッドを呼び出してください。
具体的には、環境や言語（TypeScriptなど）に応じて利用してください。

4. その他のテスト

K2HDKC Node.jsでは、MochaとChaiを使ったテストを実行できます。
以下のようにnpmコマンドを使い、作成したK2HDKC Node.jsをテストすることができます。

$ npm run test
Feature TOP Build