<!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>Returns most recent OpenSSL error reported on the buffer event</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbufferevent.setwatermark.html">EventBufferEvent::setWatermark</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbufferevent.sslfilter.html">EventBufferEvent::sslFilter</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.sslerror" class="refentry">
<div class="refnamediv">
<h1 class="refname">EventBufferEvent::sslError</h1>
<p class="verinfo">(PECL event >= 1.2.6-beta)</p><p class="refpurpose"><span class="refname">EventBufferEvent::sslError</span> — <span class="dc-title">Returns most recent OpenSSL error reported on the buffer event</span></p>
</div>
<div class="refsect1 description" id="refsect1-eventbufferevent.sslerror-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>EventBufferEvent::sslError</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Returns most recent OpenSSL error reported on the buffer event.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function is available only if
<em>Event</em>
is compiled with OpenSSL support.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-eventbufferevent.sslerror-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-eventbufferevent.sslerror-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>FALSE</code></strong>, if there is no more error to return.
</p>
</div>
<div class="refsect1 examples" id="refsect1-eventbufferevent.sslerror-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4256">
<p><strong>Example #1
<span class="function"><strong>EventBufferEvent::sslError()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// This callback is invoked when some even occurs on the event listener,<br />// e.g. connection closed, or an error occured<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">ssl_event_cb</span><span style="color: #007700">(</span><span style="color: #0000BB">$bev</span><span style="color: #007700">, </span><span style="color: #0000BB">$events</span><span style="color: #007700">, </span><span style="color: #0000BB">$ctx</span><span style="color: #007700">) {<br /> if (</span><span style="color: #0000BB">$events </span><span style="color: #007700">& </span><span style="color: #0000BB">EventBufferEvent</span><span style="color: #007700">::</span><span style="color: #0000BB">ERROR</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Fetch errors from the SSL error stack<br /> </span><span style="color: #007700">while (</span><span style="color: #0000BB">$err </span><span style="color: #007700">= </span><span style="color: #0000BB">$bev</span><span style="color: #007700">-></span><span style="color: #0000BB">sslError</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">fprintf</span><span style="color: #007700">(</span><span style="color: #0000BB">STDERR</span><span style="color: #007700">, </span><span style="color: #DD0000">"Bufferevent error %s.\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$err</span><span style="color: #007700">);<br /> }<br /> }<br /><br /> if (</span><span style="color: #0000BB">$events </span><span style="color: #007700">& (</span><span style="color: #0000BB">EventBufferEvent</span><span style="color: #007700">::</span><span style="color: #0000BB">EOF </span><span style="color: #007700">| </span><span style="color: #0000BB">EventBufferEvent</span><span style="color: #007700">::</span><span style="color: #0000BB">ERROR</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$bev</span><span style="color: #007700">-></span><span style="color: #0000BB">free</span><span style="color: #007700">();<br /> }<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-eventbufferevent.sslerror-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member">
<span class="methodname"><a href="eventbufferevent.sslrenegotiate.html" class="methodname" rel="rdfs-seeAlso">EventBufferEvent::sslRenegotiate()</a> - Tells a bufferevent to begin SSL renegotiation.</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.setwatermark.html">EventBufferEvent::setWatermark</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbufferevent.sslfilter.html">EventBufferEvent::sslFilter</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>
