<!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 contents of the buffer to a file or socket</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbuffer.unlock.html">EventBuffer::unlock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.eventbufferevent.html">EventBufferEvent</a></div>
<div class="up"><a href="class.eventbuffer.html">EventBuffer</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="eventbuffer.write" class="refentry">
<div class="refnamediv">
<h1 class="refname">EventBuffer::write</h1>
<p class="verinfo">(PECL event >= 1.6.0)</p><p class="refpurpose"><span class="refname">EventBuffer::write</span> — <span class="dc-title">Write contents of the buffer to a file or socket</span></p>
</div>
<div class="refsect1 description" id="refsect1-eventbuffer.write-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type"><span class="type void">void</span></span>
<span class="methodname"><strong>EventBuffer::write</strong></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">$fd</code>
</span>
[, <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$howmuch</code>
</span>
] )</div>
<p class="para rdfs-comment">
Write contents of the buffer to a file descriptor. The buffer will be
drained after the bytes have been successfully written.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-eventbuffer.write-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term">
<em><code class="parameter">fd</code></em>
</span>
<dd>
<p class="para">
Socket resource, stream or numeric file descriptor associated normally
associated with a socket.
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">howmuch</code></em>
</span>
<dd>
<p class="para">
The maximum number of bytes to write.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-eventbuffer.write-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the number of bytes written, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-eventbuffer.write-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member">
<span class="methodname"><a href="eventbuffer.read.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::read()</a> - Read data from an evbuffer and drain the bytes read</span>
</li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbuffer.unlock.html">EventBuffer::unlock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.eventbufferevent.html">EventBufferEvent</a></div>
<div class="up"><a href="class.eventbuffer.html">EventBuffer</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
