<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Passenger: Passenger::MessageServer::Handler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacePassenger.html">Passenger</a>::<a class="el" href="classPassenger_1_1MessageServer.html">MessageServer</a>::<a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html">Handler</a>
</div>
</div>
<div class="contents">
<h1>Passenger::MessageServer::Handler Class Reference</h1><!-- doxytag: class="Passenger::MessageServer::Handler" -->
<p>An abstract message handler class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="MessageServer_8h_source.html">MessageServer.h</a>></code></p>
<p>Inherited by ExitHandler, ExitHandler, and TimerUpdateHandler.</p>
<p><a href="classPassenger_1_1MessageServer_1_1Handler-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual ClientContextPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html#a8693a487d0b53266943cc718c95d5552">newClient</a> (<a class="el" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html">CommonClientContext</a> &context)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a new client has connected to the <a class="el" href="classPassenger_1_1MessageServer.html" title="Simple pluggable request/response messaging server framework.">MessageServer</a>. <a href="#a8693a487d0b53266943cc718c95d5552"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html#aabbc0f2b4ff4676b34a79a6cb550253f">clientDisconnected</a> (<a class="el" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html">MessageServer::CommonClientContext</a> &context, MessageServer::ClientContextPtr &handlerSpecificContext)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a client has disconnected from the <a class="el" href="classPassenger_1_1MessageServer.html" title="Simple pluggable request/response messaging server framework.">MessageServer</a>. <a href="#aabbc0f2b4ff4676b34a79a6cb550253f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html#ab5c45d7f498f6ab71d665e341bddd86f">processMessage</a> (<a class="el" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html">CommonClientContext</a> &commonContext, ClientContextPtr &handlerSpecificContext, const vector< string > &args)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called then a client has sent a request message. <a href="#ab5c45d7f498f6ab71d665e341bddd86f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An abstract message handler class. </p>
<p>The methods defined in this class are allowed to throw arbitrary exceptions. Such exceptions are caught and logged, after which the connection to the client is closed. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aabbc0f2b4ff4676b34a79a6cb550253f"></a><!-- doxytag: member="Passenger::MessageServer::Handler::clientDisconnected" ref="aabbc0f2b4ff4676b34a79a6cb550253f" args="(MessageServer::CommonClientContext &context, MessageServer::ClientContextPtr &handlerSpecificContext)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Passenger::MessageServer::Handler::clientDisconnected </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html">MessageServer::CommonClientContext</a> & </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MessageServer::ClientContextPtr & </td>
<td class="paramname"> <em>handlerSpecificContext</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when a client has disconnected from the <a class="el" href="classPassenger_1_1MessageServer.html" title="Simple pluggable request/response messaging server framework.">MessageServer</a>. </p>
<p>The default implementation does nothing.</p>
<p>This method is called even if <a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html#ab5c45d7f498f6ab71d665e341bddd86f" title="Called then a client has sent a request message.">processMessage()</a> throws an exception. It is however not called if <a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html#a8693a487d0b53266943cc718c95d5552" title="Called when a new client has connected to the MessageServer.">newClient()</a> throws an exception.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>commonContext</em> </td><td>Contains common client-specific information. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handlerSpecificContext</em> </td><td>The client context object as was returned earlier by <a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html#a8693a487d0b53266943cc718c95d5552" title="Called when a new client has connected to the MessageServer.">newClient()</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8693a487d0b53266943cc718c95d5552"></a><!-- doxytag: member="Passenger::MessageServer::Handler::newClient" ref="a8693a487d0b53266943cc718c95d5552" args="(CommonClientContext &context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ClientContextPtr Passenger::MessageServer::Handler::newClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html">CommonClientContext</a> & </td>
<td class="paramname"> <em>context</em></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when a new client has connected to the <a class="el" href="classPassenger_1_1MessageServer.html" title="Simple pluggable request/response messaging server framework.">MessageServer</a>. </p>
<p>This method is called after the client has authenticated itself.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>Contains common client-specific information. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A client context object for storing handler-specific client information, or null. The default implementation returns null. </dd></dl>
</div>
</div>
<a class="anchor" id="ab5c45d7f498f6ab71d665e341bddd86f"></a><!-- doxytag: member="Passenger::MessageServer::Handler::processMessage" ref="ab5c45d7f498f6ab71d665e341bddd86f" args="(CommonClientContext &commonContext, ClientContextPtr &handlerSpecificContext, const vector< string > &args)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool Passenger::MessageServer::Handler::processMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html">CommonClientContext</a> & </td>
<td class="paramname"> <em>commonContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ClientContextPtr & </td>
<td class="paramname"> <em>handlerSpecificContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector< string > & </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called then a client has sent a request message. </p>
<p>This method is called after <a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html#a8693a487d0b53266943cc718c95d5552" title="Called when a new client has connected to the MessageServer.">newClient()</a> is called.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>commonContext</em> </td><td>Contains common client-specific information. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handlerSpecificContext</em> </td><td>The client context object as was returned earlier by <a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html#a8693a487d0b53266943cc718c95d5552" title="Called when a new client has connected to the MessageServer.">newClient()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>The request message's contents. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Whether this handler has processed the message. Return false if the message is unrecognized. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="MessageServer_8h_source.html">MessageServer.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>