API設定ファイル
形式
|
server イベントサーバ名 通信タイプ [アドレス [ポート指定] ] client イベントサーバ名 接続元アドレス log-keep ログファイルの個数 log-size ファイルサイズ |
パラメーターの分類
- 必須パラメーター
-
-
server（イベントサーバ名，通信タイプ）
-
- 選択パラメーター
-
-
server（アドレス，ポート指定）
-
client
-
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\conf\event\
- UNIXの場合
-
/etc/opt/jp1base/conf/event/
説明
アプリケーションプログラムからイベントサーバへの接続方法や使用するポートを設定しておくファイルです。通常は，初期設定を変更する必要はありません。他ホスト上のイベントサーバから，JP1イベントを取得するアプリケーションプログラムを自ホスト上で実行したい場合に指定を追加します。
また，イベントサーバ設定ファイル（conf）のportsパラメーターを初期設定から変更した場合は，それに合わせて変更する必要があります。
定義の反映時期
JP1/Baseのイベント変換機能や，イベントサービスと連携するJP1/IMやJP1/AJSなどのプログラムを起動または再起動すると，設定が有効になります。
記述内容
API設定ファイル（api）には，次に示す規則があります。
-
1行1,024バイト以内，ファイルサイズ2ギガバイト以内のテキストファイルにしてください。
-
パラメーターの各単語は，半角スペース（0x20）またはタブ（0x09）で区切ります。
-
各行の先頭のパラメーター名および#（0x23）の前には，空白などは入れられません。
-
行の先頭に#（0x23）を指定すると，その行はコメント行になります。コメントと空行は，ファイル中の任意の場所に記述できます。
-
英字の大文字小文字は区別されます。
- server イベントサーバ名 通信タイプ [アドレス [ポート指定] ]
-
イベントサーバに接続する方法を指定します。異なるイベントサーバ名で指定する場合，このパラメーターは複数指定できます。
- イベントサーバ名
-
定義するイベントサーバ名を，次に示すどちらかの形式で指定します。
-
イベントサーバ名
個別のイベントサーバ名を，255バイト以内で指定します。
-
*
個別に指定しなかったイベントサーバに対する値を指定します。
この指定がない場合は，個別に指定していないイベントサーバには接続できません。
-
- 通信タイプ
-
指定したイベントサーバへの接続の方法を指定します。
-
keep-alive
アプリケーションプログラムが明示的に接続を切らないかぎり，TCP/IPのコネクションは張ったままで再利用します。
-
close
1件のJP1イベントの取得ごとに，TCP/IPのコネクションを切断します。電話回線を使用しているなどの理由で，コネクションを常時接続していたくない場合に使用してください。ただし，効率は悪くなります。
-
- 注意事項
-
-
JP1/AJS，JP1/IM，JP1/Power Monitorでイベントサービスと連携する場合は，必ずkeep-aliveを設定してください。
-
次に示す場合は，closeを設定した場合でもkeep-aliveとして動作します。
イベントサービスと連携するプログラム（JP1/AJS，JP1/IM，JP1/Power Monitorなど）が接続しようとするイベントサービスのIPアドレスが，物理ホスト名（hostnameコマンドで返されるホスト名）でOSから解決されるIPアドレスと同じである場合。
-
- アドレス
-
使用する接続先IPアドレスを次に示すどれかの形式で指定します。対象とするイベントサーバの，イベントサーバ設定ファイル（conf）に記述されたportsパラメーターの指定と一致させてください。省略すると，ホスト名としてイベントサーバ名を仮定します。特別な事情がないかぎり，<jp1hosts2>での運用を推奨します。
-
IPアドレス
ピリオドで区切った10進数（例：172.16.50.50）で指定します。
-
<jp1hosts2>
アプリケーションプログラムからイベントサーバへの接続に，JP1/Baseの通信方式を使用する場合，<jp1hosts2>と指定します。また，IPv6アドレスを使用して通信する場合も，<jp1hosts2>と指定します。接続先のIPアドレス解決時に，jp1hosts2情報を参照しますが，jp1hosts情報は参照しません。
-
ホスト名
システムのhostsファイル，ネームサーバなどでIPアドレスに変換できる255バイト以内の名称を指定します。
-
0.0.0.0
アプリケーションプログラムから，イベントの発行・取得が一切できなくなります（JP1のプログラムを含みますが，バージョン5以前の製品であるJP1/SES，JP1/AJSの関数やコマンドを使用した場合を除きます）。
JP1/AJSなど，多くのプログラムは，特に設定がなくてもイベントを発行しますが，イベントサービスが不要な場合は，「0.0.0.0」を指定すると，イベントの発行処理のオーバーヘッドを削減し，処理性能を向上できます。
-
- ポート指定
-
使用するポート番号を次に示すどちらかの形式で指定します。対象とするイベントサーバの，イベントサーバ設定ファイル（conf）に記述されたportsパラメーターの指定と一致させてください。指定を省略すると，サービス名としてjp1imevtapiを仮定します。
-
ポート番号
ポート番号を，10進数で指定します。
-
サービス名
システムのservicesファイルで定義されているtcpのサービス名を指定します。
-
- client イベントサーバ名 接続元アドレス
-
イベントサーバに接続する際に使用する接続元アドレスを指定します。初期設定ではclientパラメーターの設定は省略されています。省略時には，接続元アドレスはOSが自動的に割り当てる設定になっています。複数のNICを割り当てている環境で，使用する接続元アドレスを明示的に指定する必要がある場合にこのパラメーターを定義します。このパラメーターは複数指定できます。
- イベントサーバ名
-
接続先イベントサーバ名を，次に示すどちらかの形式で指定します。
-
イベントサーバ名
個別のイベントサーバ名を，255バイト以内で指定します。
-
*
個別に指定しなかったイベントサーバに対する値を指定します。
この指定がない場合，接続元アドレスは0.0.0.0になります。
-
- 接続元アドレス
-
使用する接続元アドレスを次に示すどれかの形式で指定します。
-
IPv4アドレス
ピリオドで区切った10進数（例：172.16.50.50）で指定します。ここに指定するIPアドレスは自ホストに割り当てられているものでなければなりません。
-
IPv6アドレス
コロンで区切った16進数（例：2001:db8::28）で指定します。ここに指定するIPアドレスは自ホストに割り当てられているものでなければなりません。
-
0.0.0.0
使用する接続元IPアドレスをOSが自動的に割り当てます。
-
- log-keep ログファイルの個数
-
- ログファイルの個数
-
イベントサービスAPI用ログファイル（IMEvapi.*）の保存ファイル数を指定します。log-sizeで指定した容量を超えると切り替わり，ファイル数が最大になると，最も古いファイルを削除します。値は，0〜50の10進数で指定します。省略すると，5を仮定します。0を指定するとログを保存しません。
- log-size ファイルサイズ
-
- ファイルサイズ
-
イベントサービスAPI用ログファイル（IMEvapi.*）の最大容量（バイト数）を指定します。値は，65,536〜2,147,483,647までの10進数で指定します。省略すると，1,000,000バイトを仮定します。ログ情報は，APIのロード時，およびエラーが発生した場合だけ出力されます。