FireDAC.Comp.Client.TFDCustomConnection.Ping

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function Ping: Boolean;

C++

bool __fastcall Ping();

プロパティ

種類 可視性 ソース ユニット
function public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomConnection

説明

DBMS サーバーに ping を実行します。


Ping メソッドは、DBMS サーバーへの接続が生きているかどうかを確認します。接続がダウンしていて、ResourceOptions.AutoReconnectTrue であると、自動的に再接続を試みます。

接続がアクティブではないとき、Ping メソッドは、接続を開くことを試みます。

この機能を使用するのは、長時間アイドル状態であるクライアント、または不安定な環境(たとえば、劣悪のネットワーク接続)にあるクライアントで、サーバーが接続を閉じたか、アクセスできない状態かどうかを確認するため、さらに必要な場合(サーバーが接続を開くためにアクセス可能である場合)に再接続するためです。

Ping は、DBMS への接続が機能している場合に、True を返します。

 procedure TMyDataModule.DoPing(ASender: TObject);
 begin
   if not FDConnection1.Ping then
     ShowMessage('Connection is lost!');
 end;
 .......
 FTimer := TTimer.Create;
 FTimer.OnTimer := DoPing;
 FTimer.Interval := 30000; // each 30 secs
 FTimer.Enabled := True;

関連項目