php-doc-en/reference/event/eventhttprequest/getbufferevent.xml
2014-11-20 09:57:42 +00:00

72 lines
2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventhttprequest.getbufferevent" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventHttpRequest::getBufferEvent</refname>
<refpurpose>Returns EventBufferEvent object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>EventBufferEvent</type>
<methodname>EventHttpRequest::closeConnection</methodname>
<void />
</methodsynopsis>
<para>
Returns
<classname>EventBufferEvent</classname>
object which represents buffer event that the connection is using.
</para>
<warning>
<para>
The reference counter of the returned object will be incremented by one to
protect internal structures against premature destruction when the method
is called from a user callback. So the
<classname>EventBufferEvent</classname> object should be freed explicitly
with <methodname>EventBufferEvent::free</methodname> method.
Otherwise memory will leak.
</para>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns
<classname>EventBufferEvent</classname>
object.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EventHttpRequest::getConnection</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
-->