<!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>Linearizes data within buffer
and returns it's contents as a string</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbuffer.prependbuffer.html">EventBuffer::prependBuffer</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbuffer.read.html">EventBuffer::read</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.pullup" class="refentry">
<div class="refnamediv">
<h1 class="refname">EventBuffer::pullup</h1>
<p class="verinfo">(PECL event >= 1.2.6-beta)</p><p class="refpurpose"><span class="refname">EventBuffer::pullup</span> — <span class="dc-title">Linearizes data within buffer
and returns it's contents as a string</span></p>
</div>
<div class="refsect1 description" id="refsect1-eventbuffer.pullup-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::pullup</strong></span>
( <span class="methodparam">
<span class="type">string</span>
<code class="parameter">$size</code>
</span>
)</div>
<p class="para rdfs-comment">
"Linearizes" the first
<em><code class="parameter">size</code></em>
bytes of the buffer, copying or moving them as needed to ensure that they
are all contiguous and occupying the same chunk of memory. If size is
negative, the function linearizes the entire buffer.
</p>
<div class="warning"><strong class="warning">Warning</strong>
<p class="para">
Calling
<span class="methodname"><strong>EventBuffer::pullup()</strong></span>
with a large size can be quite slow, since it potentially needs to copy
the entire buffer's contents.
</p>
</div>
</div>
<div class="refsect1 parameters" id="refsect1-eventbuffer.pullup-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term">
<em><code class="parameter">size</code></em>
</span>
<dd>
<p class="para">
The number of bytes required to be contiguous within the buffer.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-eventbuffer.pullup-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If
<em><code class="parameter">size</code></em>
is greater than the number of bytes in the buffer, the function returns
<strong><code>NULL</code></strong>. Otherwise,
<span class="methodname"><strong>EventBuffer::pullup()</strong></span>
returns string.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-eventbuffer.pullup-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member">
<span class="methodname"><a href="eventbuffer.copyout.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::copyout()</a> - Copies out specified number of bytes from the front of the buffer</span>
</li>
<li class="member">
<span class="methodname"><a href="eventbuffer.drain.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::drain()</a> - Removes specified number of bytes from the front of the buffer
without copying it anywhere</span>
</li>
<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.readline.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::readLine()</a> - Extracts a line from the front of the buffer</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.prependbuffer.html">EventBuffer::prependBuffer</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbuffer.read.html">EventBuffer::read</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>
