<!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>Write data to a 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-watermark-set.html">event_buffer_watermark_set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.event-del.html">event_del</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-write" class="refentry">
<div class="refnamediv">
<h1 class="refname">event_buffer_write</h1>
<p class="verinfo">(PECL libevent >= 0.0.1)</p><p class="refpurpose"><span class="refname">event_buffer_write</span> — <span class="dc-title">Write data to a buffered event</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.event-buffer-write-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>event_buffer_write</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$bevent</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$data_size</code><span class="initializer"> = -1</span></span>
] )</div>
<p class="para rdfs-comment">
Writes data to the specified buffered event. The data is appended to the
output buffer and written to the descriptor when it becomes available for
writing.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.event-buffer-write-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">bevent</code></dt>
<dd>
<p class="para">
Valid buffered event resource.
</p>
</dd>
<dt>
<code class="parameter">data</code></dt>
<dd>
<p class="para">
The data to be written.
</p>
</dd>
<dt>
<code class="parameter">data_size</code></dt>
<dd>
<p class="para">
Optional size parameter. <span class="function"><strong>event_buffer_write()</strong></span> writes
all the <code class="parameter">data</code> by default.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.event-buffer-write-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>event_buffer_write()</strong></span> returns <strong><code>TRUE</code></strong> 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-watermark-set.html">event_buffer_watermark_set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.event-del.html">event_del</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>
