Files
doc-en/reference/event/eventbuffer/enablelocking.xml
Ruslan Osmanov 919c8a7992 Refact: applied xml formatting
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329774 c90b9560-bf6c-de11-be94-00142212c4b1
2013-03-13 18:14:25 +00:00

64 lines
1.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventbuffer.enablelocking" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventBuffer::enableLocking</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>void</type>
<methodname>EventBuffer::enableLocking</methodname>
<void />
</methodsynopsis>
<para>
Enable locking on an
<classname>EventBuffer</classname>
so that it can safely be used by multiple threads at the same time. When
locking is enabled, the lock will be held when callbacks are invoked. This
could result in deadlock if you aren't careful. Plan accordingly!
</para>
</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>
<link
xlink:href="http://www.wangafu.net/~nickm/libevent-book/Ref7_evbuffer.html#_evbuffers_and_thread_safety">Evbuffers and Thread-safety</link>
</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
-->