sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-28 23:08:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
php-doc-en/reference/event/eventutil.xml
Ruslan Osmanov 83ae6fd821 sync event extension docs with it's 1.6.0 release 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329987 c90b9560-bf6c-de11-be94-00142212c4b1
2013-04-03 10:20:56 +00:00

509 lines
15 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.eventutil" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The EventUtil class</title>
<titleabbrev>EventUtil</titleabbrev>
<partintro>
<!-- {{{ EventUtil intro -->
<section xml:id="eventutil.intro">
&reftitle.intro;
<para>
<classname>EventUtil</classname>
is a singleton with supplimentary methods and constants.
</para>
</section>
<!-- }}} -->
<section xml:id="eventutil.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>EventUtil</classname>
</ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>EventUtil</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.af-inet">EventUtil::AF_INET</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.af-inet6">EventUtil::AF_INET6</varname>
<initializer>10</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.af-unspec">EventUtil::AF_UNSPEC</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.libevent-version-number">EventUtil::LIBEVENT_VERSION_NUMBER</varname>
<initializer>33559808</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-debug">EventUtil::SO_DEBUG</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-reuseaddr">EventUtil::SO_REUSEADDR</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-keepalive">EventUtil::SO_KEEPALIVE</varname>
<initializer>9</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-dontroute">EventUtil::SO_DONTROUTE</varname>
<initializer>5</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-linger">EventUtil::SO_LINGER</varname>
<initializer>13</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-broadcast">EventUtil::SO_BROADCAST</varname>
<initializer>6</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-oobinline">EventUtil::SO_OOBINLINE</varname>
<initializer>10</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-sndbuf">EventUtil::SO_SNDBUF</varname>
<initializer>7</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-rcvbuf">EventUtil::SO_RCVBUF</varname>
<initializer>8</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-sndlowat">EventUtil::SO_SNDLOWAT</varname>
<initializer>19</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-rcvlowat">EventUtil::SO_RCVLOWAT</varname>
<initializer>18</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-sndtimeo">EventUtil::SO_SNDTIMEO</varname>
<initializer>21</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-rcvtimeo">EventUtil::SO_RCVTIMEO</varname>
<initializer>20</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-type">EventUtil::SO_TYPE</varname>
<initializer>3</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.so-error">EventUtil::SO_ERROR</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.sol-socket">EventUtil::SOL_SOCKET</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.sol-tcp">EventUtil::SOL_TCP</varname>
<initializer>6</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.sol-udp">EventUtil::SOL_UDP</varname>
<initializer>17</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.ipproto-ip">EventUtil::IPPROTO_IP</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventutil.constants.ipproto-ipv6">EventUtil::IPPROTO_IPV6</varname>
<initializer>41</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.eventutil')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ EventUtil constants -->
<section xml:id="eventutil.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="eventutil.constants.af-inet">
<term>
<constant>EventUtil::AF_INET</constant>
</term>
<listitem>
<para>
IPv4 address family
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.af-inet6">
<term>
<constant>EventUtil::AF_INET6</constant>
</term>
<listitem>
<para>
IPv6 address family
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.af-unspec">
<term>
<constant>EventUtil::AF_UNSPEC</constant>
</term>
<listitem>
<para>
Unspecified IP address family
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-debug">
<term>
<constant>EventUtil::SO_DEBUG</constant>
</term>
<listitem>
<para>
Socket option. Enable socket debugging. Only allowed for processes with
the
<literal>CAP_NET_ADMIN</literal>
capability or an effective user ID of
<constant>0</constant>
. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-reuseaddr">
<term>
<constant>EventUtil::SO_REUSEADDR</constant>
</term>
<listitem>
<para>
Socket option. Indicates that the rules used in validating addresses
supplied in a
<literal>bind(2)</literal>
call should allow reuse of local addresses. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-keepalive">
<term>
<constant>EventUtil::SO_KEEPALIVE</constant>
</term>
<listitem>
<para>
Socket option. Enable sending of keep-alive messages on
connection-oriented sockets. Expects an integer boolean flag. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-dontroute">
<term>
<constant>EventUtil::SO_DONTROUTE</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-linger">
<term>
<constant>EventUtil::SO_LINGER</constant>
</term>
<listitem>
<para>
Socket option. When enabled, a
<literal>close(2)</literal>
or
<literal>shutdown(2)</literal>
will not return until all queued messages for the socket have been
successfully sent or the linger timeout has been reached. Otherwise,
the call returns immediately and the closing is done in the background.
See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-broadcast">
<term>
<constant>EventUtil::SO_BROADCAST</constant>
</term>
<listitem>
<para>
Socket option. Reports whether transmission of broadcast messages is
supported. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-oobinline">
<term>
<constant>EventUtil::SO_OOBINLINE</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-sndbuf">
<term>
<constant>EventUtil::SO_SNDBUF</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-rcvbuf">
<term>
<constant>EventUtil::SO_RCVBUF</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-sndlowat">
<term>
<constant>EventUtil::SO_SNDLOWAT</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-rcvlowat">
<term>
<constant>EventUtil::SO_RCVLOWAT</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-sndtimeo">
<term>
<constant>EventUtil::SO_SNDTIMEO</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-rcvtimeo">
<term>
<constant>EventUtil::SO_RCVTIMEO</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-type">
<term>
<constant>EventUtil::SO_TYPE</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.so-error">
<term>
<constant>EventUtil::SO_ERROR</constant>
</term>
<listitem>
<para>
Socket option. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.sol-socket">
<term>
<constant>EventUtil::SOL_SOCKET</constant>
</term>
<listitem>
<para>
Socket option level. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.sol-tcp">
<term>
<constant>EventUtil::SOL_TCP</constant>
</term>
<listitem>
<para>
Socket option level. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.sol-udp">
<term>
<constant>EventUtil::SOL_UDP</constant>
</term>
<listitem>
<para>
Socket option level. See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.ipproto-ip">
<term>
<constant>EventUtil::IPPROTO_IP</constant>
</term>
<listitem>
<para>
See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.ipproto-ipv6">
<term>
<constant>EventUtil::IPPROTO_IPV6</constant>
</term>
<listitem>
<para>
See the
<literal>socket(7)</literal>
manual page. (Added in event-1.6.0.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventutil.constants.libevent-version-number">
<term>
<constant>EventUtil::LIBEVENT_VERSION_NUMBER</constant>
</term>
<listitem>
<para>
Libevent&apos; version number at the time when Event extension had been
compiled with the library.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.event.entities.eventutil;
</phpdoc:classref>
<!-- 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
-->
Reference in a new issue View git blame Copy permalink