<!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>Removes specified number of bytes from the front of the buffer without copying it anywhere</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="eventbuffer.copyout.html">EventBuffer::copyout</a></div> <div class="next" style="text-align: right; float: right;"><a href="eventbuffer.enablelocking.html">EventBuffer::enableLocking</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.drain" class="refentry"> <div class="refnamediv"> <h1 class="refname">EventBuffer::drain</h1> <p class="verinfo">(PECL event >= 1.2.6-beta)</p><p class="refpurpose"><span class="refname">EventBuffer::drain</span> — <span class="dc-title">Removes specified number of bytes from the front of the buffer without copying it anywhere</span></p> </div> <div class="refsect1 description" id="refsect1-eventbuffer.drain-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::drain</strong></span> ( <span class="methodparam"> <span class="type">int</span> <code class="parameter">$len</code> </span> )</div> <p class="para rdfs-comment"> Behaves as <span class="methodname"><a href="eventbuffer.read.html" class="methodname">EventBuffer::read()</a></span> , except that it does not copy the data: it just removes it from the front of the buffer. </p> </div> <div class="refsect1 parameters" id="refsect1-eventbuffer.drain-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <span class="term"> <em><code class="parameter">len</code></em> </span> <dd> <p class="para"> The number of bytes to remove from the buffer. </p> </dd> </dt> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-eventbuffer.drain-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success. Otherwise <strong><code>FALSE</code></strong>. </p> </div> <div class="refsect1 seealso" id="refsect1-eventbuffer.drain-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> <li class="member"> <span class="methodname"><a href="eventbuffer.appendfrom.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::appendFrom()</a> - Moves the specified number of bytes from a source buffer to the end of the current buffer</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.copyout.html">EventBuffer::copyout</a></div> <div class="next" style="text-align: right; float: right;"><a href="eventbuffer.enablelocking.html">EventBuffer::enableLocking</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>