constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="network.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.constants;
 &extension.constants.core;

 <variablelist>
  <title>
   Available <parameter>flags</parameter> for
   <function>openlog</function>
  </title>

  <varlistentry xml:id="constant.log-cons">
   <term>
    <constant>LOG_CONS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     If there is an error while sending data to the system logger,
     write directly to the system console.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-ndelay">
   <term>
    <constant>LOG_NDELAY</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Open the connection to the logger immediately.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-odelay">
   <term>
    <constant>LOG_ODELAY</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Delay opening the connection until the first message is logged.
     This is the default behaviour.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-nowait">
   <term>
    <constant>LOG_NOWAIT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-perror">
   <term>
    <constant>LOG_PERROR</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Additionally log messages to <constant>STDERR</constant>.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-pid">
   <term>
    <constant>LOG_PID</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Include the PID with each log message.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title>
   Available <parameter>facility</parameter> for
   <function>openlog</function>
  </title>

  <varlistentry xml:id="constant.log-auth">
   <term>
    <constant>LOG_AUTH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For security/authorization messages.
    </simpara>
    <note>
     <simpara>
      Use <constant>LOG_AUTHPRIV</constant> instead when available.
     </simpara>
    </note>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-authpriv">
   <term>
    <constant>LOG_AUTHPRIV</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For private security/authorization messages.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-cron">
   <term>
    <constant>LOG_CRON</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For clock daemon messages.
     For example <command>cron</command> or <command>at</command>.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-daemon">
   <term>
    <constant>LOG_DAEMON</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For system daemon messages.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-kern">
   <term>
    <constant>LOG_KERN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For kernel messages.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-local0">
   <term>
    <constant>LOG_LOCAL0</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Reserved for local use.
    </simpara>
    <warning>
     <simpara>
      Not available on Windows.
     </simpara>
    </warning>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-local1">
   <term>
    <constant>LOG_LOCAL1</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Reserved for local use.
    </simpara>
    <warning>
     <simpara>
      Not available on Windows.
     </simpara>
    </warning>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-local2">
   <term>
    <constant>LOG_LOCAL2</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Reserved for local use.
    </simpara>
    <warning>
     <simpara>
      Not available on Windows.
     </simpara>
    </warning>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-local3">
   <term>
    <constant>LOG_LOCAL3</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Reserved for local use.
    </simpara>
    <warning>
     <simpara>
      Not available on Windows.
     </simpara>
    </warning>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-local4">
   <term>
    <constant>LOG_LOCAL4</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Reserved for local use.
    </simpara>
    <warning>
     <simpara>
      Not available on Windows.
     </simpara>
    </warning>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-local5">
   <term>
    <constant>LOG_LOCAL5</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Reserved for local use.
    </simpara>
    <warning>
     <simpara>
      Not available on Windows.
     </simpara>
    </warning>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-local6">
   <term>
    <constant>LOG_LOCAL6</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Reserved for local use.
    </simpara>
    <warning>
     <simpara>
      Not available on Windows.
     </simpara>
    </warning>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-local7">
   <term>
    <constant>LOG_LOCAL7</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Reserved for local use.
    </simpara>
    <warning>
     <simpara>
      Not available on Windows.
     </simpara>
    </warning>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-lpr">
   <term>
    <constant>LOG_LPR</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For messages from the line printer subsystem.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-mail">
   <term>
    <constant>LOG_MAIL</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For messages from the mail subsystem.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-news">
   <term>
    <constant>LOG_NEWS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For messages from the USENET news subsystem.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-syslog">
   <term>
    <constant>LOG_SYSLOG</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For messages generated internally by <command>syslogd</command>.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-user">
   <term>
    <constant>LOG_USER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For generic user-level messages.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-uucp">
   <term>
    <constant>LOG_UUCP</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For messages from the UUCP subsystem.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title>
   Available <parameter>priority</parameter> for
   <function>syslog</function>
  </title>

  <simpara>
   The priority constants are listed from urgent, to debug messages.
  </simpara>

  <varlistentry xml:id="constant.log-emerg">
   <term>
    <constant>LOG_EMERG</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Emergency, the system is unusable.
     This corresponds to a panic condition.
     Usually broadcast to all processes.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-alert">
   <term>
    <constant>LOG_ALERT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Alert, immediate action is required.
     For example, a corrupted system database.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-crit">
   <term>
    <constant>LOG_CRIT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Critical, action is required.
     For example, a hard device errors.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-err">
   <term>
    <constant>LOG_ERR</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Errors messages.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-warning">
   <term>
    <constant>LOG_WARNING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Warning messages.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-notice">
   <term>
    <constant>LOG_NOTICE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Notice messages, corresponds to conditions that are not error conditions,
     but that may require special handling.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-info">
   <term>
    <constant>LOG_INFO</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Informational messages.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.log-debug">
   <term>
    <constant>LOG_DEBUG</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Debugging messages that contain information normally of use only when
     debugging a program.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title>
   Available <parameter>type</parameter>s for
   <function>dns_get_record</function>
  </title>


  <varlistentry xml:id="constant.dns-any">
   <term>
    <constant>DNS_ANY</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Any Resource Record.
     On most systems this returns all resource records,
     however due to eccentricities in the performance of
     <literal>libresolv</literal> between platforms this is not guaranteed.
    </simpara>
    <simpara>
     The slower <constant>DNS_ALL</constant> will collect all records more reliably.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-all">
   <term>
    <constant>DNS_ALL</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Iteratively query the name server for each available record type.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-a">
   <term>
    <constant>DNS_A</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     IPv4 Address Resource.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-aaaa">
   <term>
    <constant>DNS_AAAA</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     IPv6 Address Resource.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-a6">
   <term>
    <constant>DNS_A6</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Defined as part of early IPv6, but downgraded to historic by
     <link xlink:href="&url.rfc;6563">RFC 6563</link>.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-caa">
   <term>
    <constant>DNS_CAA</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Certification Authority Authorization Resource.
     Available as of PHP 7.0.16 and 7.1.2.
    </simpara>
    <warning>
     <simpara>
      Not available on Windows.
     </simpara>
    </warning>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-cname">
   <term>
    <constant>DNS_CNAME</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Alias (Canonical Name) Resource.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-hinfo">
   <term>
    <constant>DNS_HINFO</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Host Info Resource.
     For more explanations and meanings of these values, visit IANA's page on
     <link xlink:href="&url.iana.system-names;">Operating System Names</link>.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-mx">
   <term>
    <constant>DNS_MX</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Mail Exchanger Resource.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-naptr">
   <term>
    <constant>DNS_NAPTR</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Naming Authority Pointer.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-ns">
   <term>
    <constant>DNS_NS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Authoritative Name Server Resource.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-ptr">
   <term>
    <constant>DNS_PTR</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Pointer Resource.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-soa">
   <term>
    <constant>DNS_SOA</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Start of Authority Resource.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-srv">
   <term>
    <constant>DNS_SRV</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Service locator.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.dns-txt">
   <term>
    <constant>DNS_TXT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Text Resource.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

</appendix>
<!-- 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
-->