プログラムによるサーバー接続チェック
#avFrameworkManager.avCheckConnectionメソッドはフィルターおよびコマンド・ハンドラー・コードで使用できます。
このメソッドは、接続を使用する操作(検索や保存など)の直前に、コマンド・ハンドラーまたはフィルター内でサーバー接続のチェックに使用します。
このメソッドを起動するとサーバー・チェック・ファンクションがサーバー上に呼び出されるので、起動する頻度がパフォーマンスに与える影響を考慮し、さらにテストで確認することをお勧めします。例えば、100データベース行を挿入するループが反復するごとに、このメソッドを起動することをお勧めします。
メソッド: avCheckConnection
パラメータ:
名前
|
使用方法
|
クラス
|
説明
|
省略値
|
Server
|
入力-任意
|
アルファベット-32文字以内
|
チェックするサーバー(ユーザー・オブジェクト名/サーバーのタイプ)
|
現在のサーバー
|
AttemptReconnect
|
入力-任意
|
ブール値
|
接続に失敗したことが検出されると、再接続を試行
|
TRUE
|
IssueMessages
|
入力-任意
|
ブール値
|
接続の失敗をユーザーに通知するメッセージを発行
FALSEに設定されている場合は、ActionOnFailパラメータが無視され、ユーザーとの通信は試行されません。
|
TRUE
|
ActionOnFail
|
入力-任意
|
ブール値
|
再接続の試行が失敗したときの対応。ABORTまたはNOTIFY/RETRY
- ユーザーに通知され、これ以上の処理は実行されず、タイマーが非アクティブになります。
- ユーザーがその後avCheckConnectionを開始すると、接続がもう1度試行されます。
- ユーザーに通知し、ユーザーからの再試行の指示を待機して、ユーザーが[OK]を押したら再試行します。
- ループごとに、ユーザーは[OK]または[キャンセル]を選択できます。[キャンセル]を選択した場合は、次のようになります。
- これ以上の処理は実行されず、タイマーが非アクティブ化されます。
- ユーザーがその後avCheckConnectionを開始すると、通知/再試行の全サイクルが再開されます。
|
サーバー値(サーバー・プロパティで設定)
|
OfflineOK
|
入力-任意
|
ブール値
|
TRUEに設定されており、ユーザーがこのサーバーに接続したことがない(例:オフラインで作業している、またはシステムがローカル・データベースを使用するように定義されている)場合は、avCheckConnectionがOKを返します。
FALSEに設定されており、ユーザーがこのサーバーに接続したことがない場合は、avCheckConnectionがERを返します。
|
TRUE
|
ReturnValue
|
出力 - オプション
|
アルファベット- 2 文字以内
|
通常はOK(接続中)またはER(未接続)。ただし、ファンクションIIPの接続テストのコードを記述して、他の値を返すようにすることができます。
|
|
|
例