JP1/Base 運用ガイド
API設定ファイル(api)の詳細について説明します。
- <この項の構成>
- (1) 格納先ディレクトリ
- (2) パラメーター一覧
- (3) パラメーターの説明
(1) 格納先ディレクトリ
API設定ファイルの格納先ディレクトリを次に示します。
- Windowsの場合
- インストール先フォルダ\conf\event\api
- UNIXの場合
- /etc/opt/jp1base/conf/event/api
(2) パラメーター一覧
API設定は,次に示すパラメーターの集まりです。
パラメーター名 内 容 server 使用する接続先IPアドレスとポート番号を指定する。 client 使用する接続元IPアドレスを指定する。 log-keep APIログファイル(IMEvapi.*)の数を指定する。 log-size APIログファイル(IMEvapi.*)の容量を指定する。
(3) パラメーターの説明
API設定の各パラメーターを説明します。
(a) server イベントサーバ名 通信タイプ [アドレス [ポート指定] ]
イベントサーバに接続する方法を指定します。異なるイベントサーバ名で指定する場合,このパラメーターは複数指定できます。
- イベントサーバ名
- 定義するイベントサーバ名を,次に示すどちらかの形式で指定します。
- イベントサーバ名
個別のイベントサーバ名を,255バイト以内で指定します。
- *
個別に指定しなかったイベントサーバ名に対する省略値を指定します。
この指定がない場合は,個別に指定していないイベントサーバには接続できません。
- 通信タイプ
- 指定したイベントサーバへの接続の方法を指定します。なお,自ホスト上のイベントサーバに接続する場合は,この指定は無効で,常にkeep-aliveの扱いとなります。
- keep-alive
アプリケーションプログラムが明示的に接続を切らないかぎり,TCP/IPのコネクションは張ったままで再利用します。
- close
1件のJP1イベントの取得ごとに,TCP/IPのコネクションを切断します。電話回線を使用しているなどの理由で,コネクションを常時接続していたくない場合に使用してください。ただし,効率は悪くなります。
- アドレス
- 使用する接続先IPアドレスを次に示すどちらかの形式で指定します。対象とするイベントサーバの,イベントサーバ設定ファイルに記述されたportsパラメーターの指定と一致させてください。省略すると,ホスト名としてイベントサーバ名を仮定します。
- IPアドレス
ピリオドで区切った10進数(例: 172.16.50.50)で指定します。
- ホスト名
システムのhostsファイル,ネームサーバなどでIPアドレスに変換できる255バイト以内の名称を指定します。
- 0.0.0.0
アプリケーションプログラムから,イベントの発行・取得が一切できなくなります(JP1のプログラムを含みますが,バージョン5以前の製品であるJP1/SES,JP1/AJSの関数やコマンドを使用した場合を除きます)。
JP1/AJS2など,多くのプログラムは,特に設定がなくてもイベントを発行しますが,イベントサービスが不要な場合は,「0.0.0.0」を指定すると,イベントの発行処理のオーバーヘッドを削減し,処理性能を向上させることができます。
- ポート指定
- 使用するポート番号を次に示すどちらかの形式で指定します。対象とするイベントサーバの,イベントサーバ設定ファイルに記述されたportsパラメーターの指定と一致させてください。指定を省略すると,サービス名として jp1imevtapi を仮定します。
- ポート番号
ポート番号を,10進数で指定します。
- サービス名
システムのservicesファイルで定義されているtcpのサービス名を指定します。
(b) client イベントサーバ名 接続元アドレス
イベントサーバに接続する際に使用する接続元アドレスを指定します。デフォルトの設定では接続元アドレスはOSが自動的に割り当てる設定になっていますが,複数のNICを割り当てている環境で使用する接続元アドレスを明示的に指定する必要がある場合にこのパラメーターを定義します。このパラメーターは複数指定できます。
- イベントサーバ名
- 接続先イベントサーバ名を,次に示すどちらかの形式で指定します。
- イベントサーバ名
個別のイベントサーバ名を,255バイト以内で指定します。
- *
個別に指定しなかったイベントサーバ名に対する省略値を指定します。
この指定がない場合,接続元アドレスは0.0.0.0になります。
- 接続元アドレス
- 使用する接続元アドレスを次に示すどちらかの形式で指定します。
- IPアドレス
ピリオドで区切った10進数(例: 172.16.50.50)で指定します。ここに指定するIPアドレスは自ホストに割り当てられているものでなければなりません。
- 0.0.0.0
使用する接続元IPアドレスをOSが自動的に割り当てます。
(c) log-keep ログファイルの個数
イベントサービスAPI用ログファイル(IMEvapi.*)の保存ファイル数を指定します。log-sizeで指定した容量を超えると切り替わり,ファイル数が最大になると,最も古いファイルを削除します。値は,0〜50の10進数で指定します。省略すると,5を仮定します。0を指定するとログを保存しません。
(d) log-size ファイルサイズ
イベントサービスAPI用ログファイル(IMEvapi.*)の最大容量(バイト数)を指定します。値は,65,536〜2,147,483,647までの10進数で指定します。省略すると,1,000,000バイトを仮定します。ログ情報は,APIのロード時,およびエラーが発生した場合だけ出力されます。
All Rights Reserved. Copyright (C) 2006, 2008, Hitachi, Ltd.