<!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>Set callback for connection close</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventhttpconnection.makerequest.html">EventHttpConnection::makeRequest</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventhttpconnection.setlocaladdress.html">EventHttpConnection::setLocalAddress</a></div>
<div class="up"><a href="class.eventhttpconnection.html">EventHttpConnection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="eventhttpconnection.setclosecallback" class="refentry">
<div class="refnamediv">
<h1 class="refname">EventHttpConnection::setCloseCallback</h1>
<p class="verinfo">(PECL event >= 1.8.0)</p><p class="refpurpose"><span class="refname">EventHttpConnection::setCloseCallback</span> — <span class="dc-title">Set callback for connection close</span></p>
</div>
<div class="refsect1 description" id="refsect1-eventhttpconnection.setclosecallback-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>EventHttpConnection::setCloseCallback</strong></span>
( <span class="methodparam">
<span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span>
<code class="parameter">$callback</code>
</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">$data</code>
</span>
] )</div>
<p class="para rdfs-comment">
Sets callback for connection close.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-eventhttpconnection.setclosecallback-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term">
<em><code class="parameter">callback</code></em>
</span>
<dd>
<p class="para">
Callback which is called when connection is closed. Should match the
following prototype:
</p>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span>
<span class="methodname"><strong>callback</strong></span>
([ <span class="methodparam">
<span class="type"><a href="class.eventhttpconnection.html" class="type EventHttpConnection">EventHttpConnection</a></span>
<code class="parameter">$conn</code>
<span class="initializer"> = <strong><code>NULL</code></strong></span>
</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">$arg</code>
<span class="initializer"> = <strong><code>NULL</code></strong></span>
</span>
]] )</div>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-eventhttpconnection.setclosecallback-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-eventhttpconnection.setclosecallback-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4268">
<p><strong>Example #1
<span class="methodname"><strong>EventHttpConnection::setCloseCallback()</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">/*<br /> * Setting up close-connection callback<br /> *<br /> * The script handles closed connections using HTTP API.<br /> *<br /> * Usage:<br /> * 1) Launch the server:<br /> * $ php examples/http_closecb.php 4242<br /> *<br /> * 2) Launch a client in another terminal. Telnet-like<br /> * session should look like the following:<br /> *<br /> * $ nc -t 127.0.0.1 4242<br /> * GET / HTTP/1.0<br /> * Connection: close<br /> *<br /> * The server will output something similar to the following:<br /> *<br /> * HTTP/1.0 200 OK<br /> * Content-Type: multipart/x-mixed-replace;boundary=boundarydonotcross<br /> * Connection: close<br /> *<br /> * <html><br /> *<br /> * 3) Terminate the client connection abruptly,<br /> * i.e. kill the process, or just press Ctrl-C.<br /> *<br /> * 4) Check if the server called _close_callback.<br /> * The script should output "_close_callback" string to standard output.<br /> *<br /> * 5) Check if the server's process has no orphaned connections,<br /> * e.g. with `lsof` utility.<br /> */<br /><br /></span><span style="color: #007700">function </span><span style="color: #0000BB">_close_callback</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">__FUNCTION__</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />}<br /><br />function </span><span style="color: #0000BB">_http_default</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">, </span><span style="color: #0000BB">$dummy</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">$req</span><span style="color: #007700">-></span><span style="color: #0000BB">getConnection</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">setCloseCallback</span><span style="color: #007700">(</span><span style="color: #DD0000">'_close_callback'</span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">/*<br /> By enabling Event::READ we protect the server against unclosed conections.<br /> This is a peculiarity of Libevent. The library disables Event::READ events<br /> on this connection, and the server is not notified about terminated<br /> connections.<br /><br /> So each time client terminates connection abruptly, we get an orphaned<br /> connection. For instance, the following is a part of `lsof -p $PID | grep TCP`<br /> command after client has terminated connection:<br /><br /> 57-php 15057 ruslan 6u unix 0xffff8802fb59c780 0t0 125187 socket<br /> 58:php 15057 ruslan 7u IPv4 125189 0t0 TCP *:4242 (LISTEN)<br /> 59:php 15057 ruslan 8u IPv4 124342 0t0 TCP localhost:4242->localhost:37375 (CLOSE_WAIT)<br /><br /> where $PID is our process ID. <br /><br /> The following block of code fixes such kind of orphaned connections.<br /> */<br /> </span><span style="color: #0000BB">$bev </span><span style="color: #007700">= </span><span style="color: #0000BB">$req</span><span style="color: #007700">-></span><span style="color: #0000BB">getBufferEvent</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$bev</span><span style="color: #007700">-></span><span style="color: #0000BB">enable</span><span style="color: #007700">(</span><span style="color: #0000BB">Event</span><span style="color: #007700">::</span><span style="color: #0000BB">READ</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$req</span><span style="color: #007700">-></span><span style="color: #0000BB">addHeader</span><span style="color: #007700">(</span><span style="color: #DD0000">'Content-Type'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'multipart/x-mixed-replace;boundary=boundarydonotcross'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">EventHttpRequest</span><span style="color: #007700">::</span><span style="color: #0000BB">OUTPUT_HEADER</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$buf </span><span style="color: #007700">= new </span><span style="color: #0000BB">EventBuffer</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$buf</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'<html>'</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$req</span><span style="color: #007700">-></span><span style="color: #0000BB">sendReply</span><span style="color: #007700">(</span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #DD0000">"OK"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$req</span><span style="color: #007700">-></span><span style="color: #0000BB">sendReplyChunk</span><span style="color: #007700">(</span><span style="color: #0000BB">$buf</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$port </span><span style="color: #007700">= </span><span style="color: #0000BB">4242</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">$argc </span><span style="color: #007700">> </span><span style="color: #0000BB">1</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$port </span><span style="color: #007700">= (int) </span><span style="color: #0000BB">$argv</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">];<br />}<br />if (</span><span style="color: #0000BB">$port </span><span style="color: #007700"><= </span><span style="color: #0000BB">0 </span><span style="color: #007700">|| </span><span style="color: #0000BB">$port </span><span style="color: #007700">> </span><span style="color: #0000BB">65535</span><span style="color: #007700">) {<br /> exit(</span><span style="color: #DD0000">"Invalid port"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$base </span><span style="color: #007700">= new </span><span style="color: #0000BB">EventBase</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$http </span><span style="color: #007700">= new </span><span style="color: #0000BB">EventHttp</span><span style="color: #007700">(</span><span style="color: #0000BB">$base</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$http</span><span style="color: #007700">-></span><span style="color: #0000BB">setDefaultCallback</span><span style="color: #007700">(</span><span style="color: #DD0000">"_http_default"</span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$http</span><span style="color: #007700">-></span><span style="color: #0000BB">bind</span><span style="color: #007700">(</span><span style="color: #DD0000">"0.0.0.0"</span><span style="color: #007700">, </span><span style="color: #0000BB">$port</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$base</span><span style="color: #007700">-></span><span style="color: #0000BB">loop</span><span style="color: #007700">();</span>
</span>
</code></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventhttpconnection.makerequest.html">EventHttpConnection::makeRequest</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventhttpconnection.setlocaladdress.html">EventHttpConnection::setLocalAddress</a></div>
<div class="up"><a href="class.eventhttpconnection.html">EventHttpConnection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
