<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Create new buffered event</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.event-buffer-free.html">event_buffer_free</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.event-buffer-priority-set.html">event_buffer_priority_set</a></div>
<div class="up"><a href="ref.libevent.html">Libevent Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.event-buffer-new" class="refentry">
<div class="refnamediv">
<h1 class="refname">event_buffer_new</h1>
<p class="verinfo">(PECL libevent >= 0.0.1)</p><p class="refpurpose"><span class="refname">event_buffer_new</span> — <span class="dc-title">Create new buffered event</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.event-buffer-new-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>event_buffer_new</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$stream</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$readcb</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$writecb</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$errorcb</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$arg</code></span>
] )</div>
<p class="para rdfs-comment">
Libevent provides an abstraction layer on top of the regular event API.
Using buffered event you don't need to deal with the I/O manually, instead
it provides input and output buffers that get filled and drained
automatically.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.event-buffer-new-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">stream</code></em></span>
<dd>
<p class="para">
Valid PHP stream resource. Must be castable to file descriptor.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">readcb</code></em></span>
<dd>
<p class="para">
Callback to invoke where there is data to read, or <span class="type"><a href="language.types.null.html" class="type NULL">NULL</a></span> if
no callback is desired.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">writecb</code></em></span>
<dd>
<p class="para">
Callback to invoke where the descriptor is ready for writing,
or <span class="type"><a href="language.types.null.html" class="type NULL">NULL</a></span> if no callback is desired.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">errorcb</code></em></span>
<dd>
<p class="para">
Callback to invoke where there is an error on the descriptor, cannot be
<span class="type"><a href="language.types.null.html" class="type NULL">NULL</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">arg</code></em></span>
<dd>
<p class="para">
An argument that will be passed to each of the callbacks (optional).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.event-buffer-new-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>event_buffer_new()</strong></span> returns new buffered event resource
on success or <strong><code>FALSE</code></strong> on error.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.event-buffer-free.html">event_buffer_free</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.event-buffer-priority-set.html">event_buffer_priority_set</a></div>
<div class="up"><a href="ref.libevent.html">Libevent Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
