CRI ADX  Last Updated: 2024-09-25 17:41 p
通信 モジュール

通信モジュールは、リモート実行操作を行う関数を管理するモジュールです。

注意
通信モジュールは、「リモート実行用プラグインパッケージ」に含まれるリモート実行専用モジュールです。
通信モジュールの戻り値は他のモジュールと異なり、連想配列ではありません。
整数型、または戻り値なしとなります。

モジュール名

cri.atomcraft.criatomcraft_api_lib

次の関数が定義されています。

関数 説明
initialize 通信機能の初期化を行います
finalize 通信機能を終了します
connect CRI Atom Craft との接続を行います
disconnect CRI Atom Craft との接続を解除します
get_status CRI Atom Craft との接続状態を取得します

initialize

通信機能の初期化を行います。
リモート実行のために通信機能を使用する場合、機能使用前に初期化処理が必要です。

書式

result = initialize()

入力パラメーター

なし

戻り値

名前
result 成功した場合は0, 失敗した場合は0以外


finalize

通信機能を終了します。

書式

finalize()

入力パラメーター

なし

戻り値

なし



connect

CRI Atom Craft との接続を開始します。

書式

result = connect(ip_address, port_number)

入力パラメーター

名前
ip_address CRI Atom Craft のIPアドレス
port_number 接続に使用するポート番号

戻り値

名前
result 成功した場合は0, 失敗した場合は0以外


disconnect

CRI Atom Craft との接続を解除します。

書式

disconnect()

入力パラメーター

なし

戻り値

なし



get_status

CRI Atom Craft との接続状態を取得します。

書式

result = get_status()

入力パラメーター

なし

戻り値

名前
result 接続状態の場合は0, 接続状態でない場合は0以外