ping.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3b3be96b737e3c90e42a92e0959ed788f06dbbb7 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="solrclient.ping" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SolrClient::ping</refname>
  <refpurpose>Проверяет, работает ли сервер Solr</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>SolrPingResponse</type><methodname>SolrClient::ping</methodname>
   <void />
  </methodsynopsis>
  <para>
   Проверяет, доступен ли ещё сервер Solr. Отправляет запрос HEAD на сервер Apache Solr.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает объект <type>SolrPingResponse</type> в случае успешного выполнения или выбрасывает исключение в случае возникновения ошибки.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Выбрасывает <classname>SolrClientException</classname>, если клиент отказал или возникла проблема с подключением.
  </para>
  <para>
   Выбрасывает <classname>SolrServerException</classname>, если сервер Solr не смог обработать запрос.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <methodname>SolrClient::ping</methodname></title>
    <programlisting role="php">
<![CDATA[
<?php
$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$pingresponse = $client->ping();

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[

]]>
    </screen>
   </example>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->