<!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>Read buffer's data</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="eventbufferevent.getoutput.html">EventBufferEvent::getOutput</a></div> <div class="next" style="text-align: right; float: right;"><a href="eventbufferevent.readbuffer.html">EventBufferEvent::readBuffer</a></div> <div class="up"><a href="class.eventbufferevent.html">EventBufferEvent</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="eventbufferevent.read" class="refentry"> <div class="refnamediv"> <h1 class="refname">EventBufferEvent::read</h1> <p class="verinfo">(PECL event >= 1.2.6-beta)</p><p class="refpurpose"><span class="refname">EventBufferEvent::read</span> — <span class="dc-title">Read buffer's data</span></p> </div> <div class="refsect1 description" id="refsect1-eventbufferevent.read-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>EventBufferEvent::read</strong></span> ( <span class="methodparam"> <span class="type">string</span> <code class="parameter reference">&$data</code> </span> , <span class="methodparam"> <span class="type">int</span> <code class="parameter">$size</code> </span> )</div> <p class="para rdfs-comment"> Removes up to <em><code class="parameter">size</code></em> bytes from the input buffer, storing them into <em><code class="parameter">data</code></em> . </p> </div> <div class="refsect1 parameters" id="refsect1-eventbufferevent.read-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <span class="term"> <em><code class="parameter">data</code></em> </span> <dd> <p class="para"> Storage for the read data. </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">size</code></em> </span> <dd> <p class="para"> Maximum numbe rof bytes to read </p> </dd> </dt> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-eventbufferevent.read-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the number of bytes actually removed. </p> </div> <div class="refsect1 seealso" id="refsect1-eventbufferevent.read-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="eventbufferevent.readbuffer.html" class="methodname" rel="rdfs-seeAlso">EventBufferEvent::readBuffer()</a> - Drains the entire contents of the input buffer and places them into buf</span> </li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="eventbufferevent.getoutput.html">EventBufferEvent::getOutput</a></div> <div class="next" style="text-align: right; float: right;"><a href="eventbufferevent.readbuffer.html">EventBufferEvent::readBuffer</a></div> <div class="up"><a href="class.eventbufferevent.html">EventBufferEvent</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>