mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
[pecl][event] Changes in API 1.10.0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335163 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Ruslan Osmanov
parent
dbdc52230d
commit
04f603bc6c
10 changed files with 373 additions and 6 deletions
73
reference/event/eventbase/free.xml
Normal file
73
reference/event/eventbase/free.xml
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="eventbase.free" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>EventBase::free</refname>
|
||||
<refpurpose>Free resources allocated for this event base</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>void</type>
|
||||
<methodname>EventBase::free</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Deallocates resources allocated by libevent for the <classname>EventBase</classname> object.
|
||||
</para>
|
||||
<warning>
|
||||
<para>
|
||||
The
|
||||
<methodname>EventBase::free</methodname>
|
||||
method doesn't destruct the object itself. To destruct the
|
||||
object completely call
|
||||
<function>unset</function>
|
||||
, or assign &null;.
|
||||
</para>
|
||||
<para>
|
||||
This method does not deallocate or detach any of the events that are
|
||||
currently associated with the <classname>EventBase</classname> object, or
|
||||
close any of their sockets - beware.
|
||||
</para>
|
||||
</warning>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member>
|
||||
<methodname>EventBase::__construct</methodname>
|
||||
</member>
|
||||
</simplelist>
|
||||
</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
|
||||
-->
|
||||
54
reference/event/eventbufferevent/close.xml
Normal file
54
reference/event/eventbufferevent/close.xml
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="eventbufferevent.close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>EventBufferEvent::close</refname>
|
||||
<refpurpose>Closes file descriptor associated with the current buffer event</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>void</type>
|
||||
<methodname>EventBufferEvent::close</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Closes file descriptor associated with the current buffer event.
|
||||
</para>
|
||||
<para>
|
||||
This method may be used in cases when the
|
||||
<constant>EventBufferEvent::OPT_CLOSE_ON_FREE</constant> option is not appropriate.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</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
|
||||
-->
|
||||
|
|
@ -42,14 +42,16 @@
|
|||
<para>
|
||||
Should contain an IP address with optional port number, or a path to
|
||||
UNIX domain socket. Recognized formats are:
|
||||
<screen><![CDATA[
|
||||
<screen>
|
||||
<![CDATA[
|
||||
[IPv6Address]:port
|
||||
[IPv6Address]
|
||||
IPv6Address
|
||||
IPv4Address:port
|
||||
IPv4Address
|
||||
unix:path
|
||||
]]></screen>
|
||||
]]>
|
||||
</screen>
|
||||
Note,
|
||||
<literal>'unix:'</literal>
|
||||
prefix is currently not case sensitive.
|
||||
|
|
|
|||
|
|
@ -93,12 +93,14 @@
|
|||
<listitem>
|
||||
<para>
|
||||
Hostname to connect to. Recognized formats are:
|
||||
<screen><![CDATA[
|
||||
<screen>
|
||||
<![CDATA[
|
||||
www.example.com (hostname)
|
||||
1.2.3.4 (ipv4address)
|
||||
::1 (ipv6address)
|
||||
[::1] ([ipv6address])
|
||||
]]></screen>
|
||||
]]>
|
||||
</screen>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
|||
59
reference/event/eventbufferevent/sslgetcipherinfo.xml
Normal file
59
reference/event/eventbufferevent/sslgetcipherinfo.xml
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="eventbufferevent.sslgetcipherinfo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>EventBufferEvent::sslGetCipherInfo</refname>
|
||||
<refpurpose>Returns a textual description of the cipher.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>string</type>
|
||||
<methodname>EventBufferEvent::sslGetCipherInfo</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Retrieves description of the current cipher by means of the
|
||||
<literal>SSL_CIPHER_description</literal> SSL API function (see
|
||||
<emphasis>SSL_CIPHER_get_name(3)</emphasis> man page).
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This function is available only if
|
||||
<literal>Event</literal>
|
||||
is compiled with OpenSSL support.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns a textual description of the cipher on success, or &false; on error.
|
||||
</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
|
||||
-->
|
||||
57
reference/event/eventbufferevent/sslgetciphername.xml
Normal file
57
reference/event/eventbufferevent/sslgetciphername.xml
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="eventbufferevent.sslgetciphername" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>EventBufferEvent::sslGetCipherName</refname>
|
||||
<refpurpose>Returns the current cipher name of the SSL connection.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>string</type>
|
||||
<methodname>EventBufferEvent::sslGetCipherName</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Retrieves name of cipher used by current SSL connection.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This function is available only if
|
||||
<literal>Event</literal>
|
||||
is compiled with OpenSSL support.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the current cipher name of the SSL connection, or &false; on error.
|
||||
</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
|
||||
-->
|
||||
57
reference/event/eventbufferevent/sslgetcipherversion.xml
Normal file
57
reference/event/eventbufferevent/sslgetcipherversion.xml
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="eventbufferevent.sslgetcipherversion" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>EventBufferEvent::sslGetCipherVersion</refname>
|
||||
<refpurpose>Returns version of cipher used by current SSL connection.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>string</type>
|
||||
<methodname>EventBufferEvent::sslGetCipherVersion</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Retrieves version of cipher used by current SSL connection.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This function is available only if
|
||||
<literal>Event</literal>
|
||||
is compiled with OpenSSL support.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the current cipher version of the SSL connection, or &false; on error.
|
||||
</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
|
||||
-->
|
||||
57
reference/event/eventbufferevent/sslgetprotocol.xml
Normal file
57
reference/event/eventbufferevent/sslgetprotocol.xml
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="eventbufferevent.sslgetprotocol" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>EventBufferEvent::sslGetProtocol</refname>
|
||||
<refpurpose>Returns the name of the protocol used for current SSL connection.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>string</type>
|
||||
<methodname>EventBufferEvent::sslGetProtocol</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the name of the protocol used for current SSL connection.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This function is available only if
|
||||
<literal>Event</literal>
|
||||
is compiled with OpenSSL support.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the name of the protocol used for current SSL connection.
|
||||
</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
|
||||
-->
|
||||
|
|
@ -770,7 +770,7 @@ HTTP/1.0 200 OK
|
|||
Content-Type: text/html; charset=ISO-8859-1
|
||||
Connection: close
|
||||
]]>
|
||||
</screen>
|
||||
</screen>
|
||||
</example>
|
||||
<example>
|
||||
<title>Simple HTTPS server</title>
|
||||
|
|
@ -1014,7 +1014,7 @@ Body:
|
|||
PHP, date:
|
||||
2013-03-13T20:27:52+05:00
|
||||
]]>
|
||||
</screen>
|
||||
</screen>
|
||||
</example>
|
||||
<example>
|
||||
<title>
|
||||
|
|
|
|||
|
|
@ -23,6 +23,7 @@
|
|||
<function name="event::delsignal" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name='eventbase' from='PECL event >= 1.2.6-beta'/>
|
||||
<function name="eventbase::__construct" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbase::free" from="PECL event >= 1.10.0"/>
|
||||
<function name="eventbase::getmethod" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbase::getfeatures" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbase::priorityinit" from="PECL event >= 1.2.6-beta"/>
|
||||
|
|
@ -41,6 +42,7 @@
|
|||
<function name='eventbufferevent' from='PECL event >= 1.2.6-beta'/>
|
||||
<function name="eventbufferevent::__construct" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbufferevent::free" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbufferevent::close" from="PECL event >= 1.10.0"/>
|
||||
<function name="eventbufferevent::connect" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbufferevent::connecthost" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbufferevent::getdnserrorstring" from="PECL event >= 1.2.6-beta"/>
|
||||
|
|
@ -62,6 +64,10 @@
|
|||
<function name="eventbufferevent::sslsocket" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbufferevent::sslerror" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbufferevent::sslrenegotiate" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbufferevent::sslgetcipherinfo" from="PECL event >= 1.10.0"/>
|
||||
<function name="eventbufferevent::sslgetciphername" from="PECL event >= 1.10.0"/>
|
||||
<function name="eventbufferevent::sslgetcipherversion" from="PECL event >= 1.10.0"/>
|
||||
<function name="eventbufferevent::sslgetprotocol" from="PECL event >= 1.10.0"/>
|
||||
<function name='eventbuffer' from='PECL event >= 1.5.0'/>
|
||||
<function name="eventbuffer::__construct" from="PECL event >= 1.2.6-beta"/>
|
||||
<function name="eventbuffer::freeze" from="PECL event >= 1.2.6-beta"/>
|
||||
|
|
|
|||
Loading…
Reference in a new issue