archived-doc-ru/reference/network/functions/openlog.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: bfl Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.openlog" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openlog</refname>
  <refpurpose>Открывает соединение к системному журналу</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</type><methodname>openlog</methodname>
   <methodparam><type>string</type><parameter>prefix</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   <methodparam><type>int</type><parameter>facility</parameter></methodparam>
  </methodsynopsis>
  <para>
   Функция <function>openlog</function> открывает соединение к системному журналу для программы.
  </para>
  <para>
   Использование <function>openlog</function> не является обязательным. Эта функция при необходимости будет вызвана  функцией <function>syslog</function> автоматически, при этом параметр <parameter>prefix</parameter> будет по умолчанию равен &false;.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>prefix</parameter></term>
     <listitem>
      <para>
       Строка <parameter>prefix</parameter> добавляется к каждому сообщению.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Аргумент <parameter>flags</parameter> используется для указания используемых опций журналирования при создании записи журнала.
       <table>
        <title>Опции <function>openlog</function></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Константа</entry>
           <entry>Описание</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>LOG_CONS</constant></entry>
           <entry>
            если при отправке данных системному журналу происходит ошибка, перевести вывод непосредственно в системную консоль
           </entry>
          </row>
          <row>
           <entry><constant>LOG_NDELAY</constant></entry>
           <entry>
            открыть соединение с журналом без задержки
           </entry>
          </row>
          <row>
           <entry><constant>LOG_ODELAY</constant></entry>
           <entry>
            (по умолчанию) отложить открытие соединения до вывода первого сообщения в журнал
           </entry>
          </row>
          <row>
           <entry><constant>LOG_PERROR</constant></entry>
           <entry>выводить вместе со стандартной ошибкой сообщение журнала</entry>
          </row>
          <row>
           <entry><constant>LOG_PID</constant></entry>
           <entry>добавить PID к каждому сообщению</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
       Можно использовать одну или сразу несколько опций. При использовании нескольких опций необходимо разделять их <literal>OR</literal>, к примеру, для открытия соединения без задержки, записи в консоль и включения PID в каждое из сообщений, необходима следующая комбинация опций: <literal>LOG_CONS | LOG_NDELAY | LOG_PID</literal>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>facility</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>facility</parameter> используется для определения типа программы, создавшей сообщение журнала. Это позволяет определить (в конфигурации syslog) как будут обработаны сообщения журнала, поступающие из разных объектов.
       <table>
        <title>Типы программ <function>openlog</function></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Константа</entry>
           <entry>Описание</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>LOG_AUTH</constant></entry>
           <entry>
            сообщения по безопасности/авторизации (необходимо взамен
            использовать <constant>LOG_AUTHPRIV</constant>
            в системах, где эта константа предопределена)
           </entry>
          </row>
          <row>
           <entry><constant>LOG_AUTHPRIV</constant></entry>
           <entry>сообщения по безопасности/авторизации (частное)</entry>
          </row>
          <row>
           <entry><constant>LOG_CRON</constant></entry>
           <entry>планировщик задач (cron и at)</entry>
          </row>
          <row>
           <entry><constant>LOG_DAEMON</constant></entry>
           <entry>другие системные службы</entry>
          </row>
          <row>
           <entry><constant>LOG_KERN</constant></entry>
           <entry>сообщения ядра</entry>
          </row>
          <row>
           <entry><constant>LOG_LOCAL0</constant> ... <constant>LOG_LOCAL7</constant></entry>
           <entry>зарезервированы для локального использования, недоступны в Windows</entry>
          </row>
          <row>
           <entry><constant>LOG_LPR</constant></entry>
           <entry>подсистема печати LPR</entry>
          </row>
          <row>
           <entry><constant>LOG_MAIL</constant></entry>
           <entry>почтовая подсистема</entry>
          </row>
          <row>
           <entry><constant>LOG_NEWS</constant></entry>
           <entry>подсистема новостей USENET</entry>
          </row>
          <row>
           <entry><constant>LOG_SYSLOG</constant></entry>
           <entry>внутренние сообщения syslogd</entry>
          </row>
          <row>
           <entry><constant>LOG_USER</constant></entry>
           <entry>общие сообщения на уровне пользователя</entry>
          </row>
          <row>
           <entry><constant>LOG_UUCP</constant></entry>
           <entry>подсистема UUCP</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
      <note>
       <para>
        <constant>LOG_USER</constant> - единственный верный тип журналирования в операционных системах Windows
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.true.always;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.2.0</entry>
      <entry>
       Теперь функция каждый раз возвращает &true;. Раньше функция возвращала &false;, если возникла ошибка.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>syslog</function></member>
    <member><function>closelog</function></member>
   </simplelist>
  </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
-->