<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.4"/> <title>ClanLib: CL_HTTPRequestHandler Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">ClanLib  <span id="projectnumber">2.3.7</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.4 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="classCL__HTTPRequestHandler-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">CL_HTTPRequestHandler Class Reference<div class="ingroups"><a class="el" href="group__clanNetwork__Web.html">clanNetwork Web</a></div></div> </div> </div><!--header--> <div class="contents"> <p>HTTP request handler class. <a href="classCL__HTTPRequestHandler.html#details">More...</a></p> <p><code>#include <<a class="el" href="http__request__handler_8h_source.html">http_request_handler.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td colspan="2"><div class="groupHeader">Construction</div></td></tr> <tr class="memitem:a5447161901a01d3fb2a85c74dca7ef2b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__HTTPRequestHandler.html#a5447161901a01d3fb2a85c74dca7ef2b">CL_HTTPRequestHandler</a> ()</td></tr> <tr class="memdesc:a5447161901a01d3fb2a85c74dca7ef2b"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a null instance. <a href="#a5447161901a01d3fb2a85c74dca7ef2b">More...</a><br/></td></tr> <tr class="separator:a5447161901a01d3fb2a85c74dca7ef2b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af1bf6bd12074efe5ca10031a363b2a48"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__HTTPRequestHandler.html#af1bf6bd12074efe5ca10031a363b2a48">CL_HTTPRequestHandler</a> (<a class="el" href="classCL__HTTPRequestHandlerProvider.html">CL_HTTPRequestHandlerProvider</a> *provider)</td></tr> <tr class="memdesc:af1bf6bd12074efe5ca10031a363b2a48"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a HTTPRequestHandler. <a href="#af1bf6bd12074efe5ca10031a363b2a48">More...</a><br/></td></tr> <tr class="separator:af1bf6bd12074efe5ca10031a363b2a48"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abdd656dbf2e532ae89b7377198f0c16c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__HTTPRequestHandler.html#abdd656dbf2e532ae89b7377198f0c16c">~CL_HTTPRequestHandler</a> ()</td></tr> <tr class="separator:abdd656dbf2e532ae89b7377198f0c16c"><td class="memSeparator" colspan="2"> </td></tr> <tr><td colspan="2"><div class="groupHeader">Attributes</div></td></tr> <tr class="memitem:ad6d0ffc3d3a9d9e1e92aa14de59204bc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__HTTPRequestHandler.html#ad6d0ffc3d3a9d9e1e92aa14de59204bc">is_null</a> () const </td></tr> <tr class="memdesc:ad6d0ffc3d3a9d9e1e92aa14de59204bc"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this object is invalid. <a href="#ad6d0ffc3d3a9d9e1e92aa14de59204bc">More...</a><br/></td></tr> <tr class="separator:ad6d0ffc3d3a9d9e1e92aa14de59204bc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a35e72a4a587961080395835044d893eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__HTTPRequestHandler.html#a35e72a4a587961080395835044d893eb">throw_if_null</a> () const </td></tr> <tr class="memdesc:a35e72a4a587961080395835044d893eb"><td class="mdescLeft"> </td><td class="mdescRight">Throw an exception if this object is invalid. <a href="#a35e72a4a587961080395835044d893eb">More...</a><br/></td></tr> <tr class="separator:a35e72a4a587961080395835044d893eb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7eb2184e4911c1a097f193c57158740c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCL__HTTPRequestHandlerProvider.html">CL_HTTPRequestHandlerProvider</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__HTTPRequestHandler.html#a7eb2184e4911c1a097f193c57158740c">get_provider</a> () const </td></tr> <tr class="memdesc:a7eb2184e4911c1a097f193c57158740c"><td class="mdescLeft"> </td><td class="mdescRight">Get Provider. <a href="#a7eb2184e4911c1a097f193c57158740c">More...</a><br/></td></tr> <tr class="separator:a7eb2184e4911c1a097f193c57158740c"><td class="memSeparator" colspan="2"> </td></tr> <tr><td colspan="2"><div class="groupHeader">Operations</div></td></tr> <tr class="memitem:a6b4476bfb7093a5c234535f0dee95bb6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__HTTPRequestHandler.html#a6b4476bfb7093a5c234535f0dee95bb6">is_handling_request</a> (const <a class="el" href="classCL__StringRef8.html">CL_StringRef8</a> &type, const <a class="el" href="classCL__StringRef8.html">CL_StringRef8</a> &url, const <a class="el" href="classCL__StringRef8.html">CL_StringRef8</a> &headers)</td></tr> <tr class="separator:a6b4476bfb7093a5c234535f0dee95bb6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2db8c523be2da16c477b15b0ada2c2f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__HTTPRequestHandler.html#a2db8c523be2da16c477b15b0ada2c2f3">handle_request</a> (<a class="el" href="classCL__HTTPServerConnection.html">CL_HTTPServerConnection</a> &connection)</td></tr> <tr class="memdesc:a2db8c523be2da16c477b15b0ada2c2f3"><td class="mdescLeft"> </td><td class="mdescRight">Handle request. <a href="#a2db8c523be2da16c477b15b0ada2c2f3">More...</a><br/></td></tr> <tr class="separator:a2db8c523be2da16c477b15b0ada2c2f3"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>HTTP request handler class. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a5447161901a01d3fb2a85c74dca7ef2b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CL_HTTPRequestHandler::CL_HTTPRequestHandler </td> <td>(</td> <td class="paramname">)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a null instance. </p> </div> </div> <a class="anchor" id="af1bf6bd12074efe5ca10031a363b2a48"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CL_HTTPRequestHandler::CL_HTTPRequestHandler </td> <td>(</td> <td class="paramtype"><a class="el" href="classCL__HTTPRequestHandlerProvider.html">CL_HTTPRequestHandlerProvider</a> * </td> <td class="paramname"><em>provider</em>)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a HTTPRequestHandler. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">provider</td><td>= HTTPRequest Handler Provider </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="abdd656dbf2e532ae89b7377198f0c16c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CL_HTTPRequestHandler::~CL_HTTPRequestHandler </td> <td>(</td> <td class="paramname">)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a7eb2184e4911c1a097f193c57158740c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classCL__HTTPRequestHandlerProvider.html">CL_HTTPRequestHandlerProvider</a>* CL_HTTPRequestHandler::get_provider </td> <td>(</td> <td class="paramname">)</td><td></td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Get Provider. </p> <dl class="section return"><dt>Returns</dt><dd>provider </dd></dl> </div> </div> <a class="anchor" id="a2db8c523be2da16c477b15b0ada2c2f3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void CL_HTTPRequestHandler::handle_request </td> <td>(</td> <td class="paramtype"><a class="el" href="classCL__HTTPServerConnection.html">CL_HTTPServerConnection</a> & </td> <td class="paramname"><em>connection</em>)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Handle request. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">connection</td><td>= HTTPServer Connection </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a6b4476bfb7093a5c234535f0dee95bb6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CL_HTTPRequestHandler::is_handling_request </td> <td>(</td> <td class="paramtype">const <a class="el" href="classCL__StringRef8.html">CL_StringRef8</a> & </td> <td class="paramname"><em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classCL__StringRef8.html">CL_StringRef8</a> & </td> <td class="paramname"><em>url</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classCL__StringRef8.html">CL_StringRef8</a> & </td> <td class="paramname"><em>headers</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ad6d0ffc3d3a9d9e1e92aa14de59204bc"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool CL_HTTPRequestHandler::is_null </td> <td>(</td> <td class="paramname">)</td><td></td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns true if this object is invalid. </p> </div> </div> <a class="anchor" id="a35e72a4a587961080395835044d893eb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void CL_HTTPRequestHandler::throw_if_null </td> <td>(</td> <td class="paramname">)</td><td></td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Throw an exception if this object is invalid. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="http__request__handler_8h_source.html">http_request_handler.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Jun 14 2013 13:05:57 for ClanLib by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.4 </small></address> </body> </html>