mysqli::ping

mysqli_ping

サーバーとの接続をチェックし、もし切断されている場合は再接続を試みる

警告

この関数は PHP 8.4.0 で 非推奨になります。この関数に頼らないことを強く推奨します。

説明

オブジェクト指向型

public bool mysqli::ping()

手続き型

bool mysqli_ping(mysqli $mysql)

サーバーとの接続が動作中かどうかを確かめます。もし切断されており、グローバルオプション mysqli.reconnect が有効な場合は再接続を試みます。

注意: mysqlnd ドライバは、php.ini 設定項目 mysqli.reconnect を無視します。自動再接続は行われません。

この関数は、長期間アイドル状態にあるクライアントが、サーバーの状態を確認して必要なら再接続するために使用します。

パラメータ

link: 手続き型のみ: mysqli_connect あるいは mysqli_init が返す mysqliオブジェクト。

戻り値

成功した場合に true を、失敗した場合に false を返します。

エラー / 例外

mysqli のエラー報告 (MYSQLI_REPORT_ERROR) が有効になっており、かつ要求された操作が失敗した場合は、警告が発生します。さらに、エラー報告のモードが MYSQLI_REPORT_STRICT に設定されていた場合は、mysqli_sql_exception が代わりにスローされます。

変更履歴

バージョン	説明
8.4.0	mysqli::ping と mysqli_ping は非推奨となりました。 `reconnect` 機能は PHP 8.2.0 で廃止されたため、この関数はもはや必要ありません。

例

例1 mysqli::ping の例

オブジェクト指向型

<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

/* 接続状況をチェックします */
if ($mysqli->connect_errno) {
    printf("Connect failed: %s\n", $mysqli->connect_error);
    exit();
}

/* サーバーが稼動中かどうかを確認します */
if ($mysqli->ping()) {
    printf ("Our connection is ok!\n");
} else {
    printf ("Error: %s\n", $mysqli->error);
}

/* 接続を閉じます */
$mysqli->close();
?>

手続き型

<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

/* 接続状況をチェックします */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

/* サーバーが稼動中かどうかを確認します */
if (mysqli_ping($link)) {
    printf ("Our connection is ok!\n");
} else {
    printf ("Error: %s\n", mysqli_error($link));
}

/* 接続を閉じます */
mysqli_close($link);
?>

上の例の出力は以下となります。

Our connection is ok!