10.3 hamon_patrolstart(UAPの監視開始)
形式
#include <HA_mon_uap.h> long hamon_patrolstart(int signum,int *inf,void *opt);
機能
UAPの監視開始をHAモニタに要求します。
UAPの起動時には,あらかじめHAMON_UAPNAME環境変数に,モニタモードのプログラム対応の環境設定のnameオペランドに指定したプログラム名を設定しておく必要があります。
なお,HAMON_API_PATROL環境変数にnouseを指定した場合は,HAモニタへの要求は行わないでリターンコード0でリターンします。
UAPの環境変数については,「6.17.2 UAPの環境変数の設定」を参照してください。
UAPで値を設定する引数
-
signum
シグナル番号を指定します。0または捕捉できるシグナル番号を指定してください。UAPのプロセスに加えてUAPの稼働報告を監視したい場合は,0以外を指定します。UAPのプロセスだけを監視したい場合は,0を指定します。
なお,0以外を指定した場合でも,モニタモードのプログラム対応の環境設定のpatrolオペランドを省略したときは,UAPのプロセスの監視だけを行います。
-
opt
予備領域です。NULLを指定します。
HAモニタから値が返される引数
-
inf
エラー時の詳細コードを返却するための領域です。詳細コードについては,「10.5 詳細コードの一覧」を参照してください。
リターンコード
値 |
意味 |
---|---|
0 |
HAモニタは,この関数を発行したUAPの監視を開始します。 |
-1 |
エラーが発生しました。HAモニタは,この関数を発行したUAPの監視を開始しません。ただし,すでに監視を開始している場合は,監視が継続されます。詳細については,「10.5 詳細コードの一覧」を参照してください。 |
注意事項
-
この関数は,同一プロセスから連続して複数回発行しないでください。
-
1プロセスでAPIを発行できるのは1スレッドだけです。