<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /builddir/build/BUILD/libqxt/doc/src/modules.qdoc -->
<head>
<title>QxtWeb Module</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://libqxt.org"><img src="images/qxt-logo.png" width="50" height="40" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="classes.html"><font color="#004faf">Classes</font></a> · <a href="namespaces.html"><font color="#004faf">Namespaces</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QxtWeb Module<br /><span class="subtitle"></span>
</h1>
<p>The QxtWeb module provides tools for creating web services using Qt. <a href="#details">More...</a></p>
<h2>Classes</h2>
<p><table width="100%" class="annotated" cellpadding="2" cellspacing="1" border="0">
<tr valign="top" class="odd"><th><a href="qxtabstracthttpconnector.html">QxtAbstractHttpConnector</a></th><td>Base class for defining HTTP-based protocols for use with QxtHttpSessionManager</td></tr>
<tr valign="top" class="even"><th><a href="qxtabstractwebservice.html">QxtAbstractWebService</a></th><td>Base interface for web services</td></tr>
<tr valign="top" class="odd"><th><a href="qxtabstractwebsessionmanager.html">QxtAbstractWebSessionManager</a></th><td>Base class for QxtWeb session managers</td></tr>
<tr valign="top" class="even"><th><a href="qxthtmltemplate.html">QxtHtmlTemplate</a></th><td>Basic HTML template engine</td></tr>
<tr valign="top" class="odd"><th><a href="qxthttpserverconnector.html">QxtHttpServerConnector</a></th><td>Built-in HTTP server for QxtHttpSessionManager</td></tr>
<tr valign="top" class="even"><th><a href="qxthttpsessionmanager.html">QxtHttpSessionManager</a></th><td>Session manager for HTTP-based protocols</td></tr>
<tr valign="top" class="odd"><th><a href="qxtscgiserverconnector.html">QxtScgiServerConnector</a></th><td>SCGI connector for QxtHttpSessionManager</td></tr>
<tr valign="top" class="even"><th><a href="qxtwebcgiservice.html">QxtWebCgiService</a></th><td>CGI/1.1 gateway for QxtWeb</td></tr>
<tr valign="top" class="odd"><th><a href="qxtwebcontent.html">QxtWebContent</a></th><td>And I/O device for data sent by the web browser</td></tr>
<tr valign="top" class="even"><th><a href="qxtweberrorevent.html">QxtWebErrorEvent</a></th><td>Describes an error condition to be sent to a web browser</td></tr>
<tr valign="top" class="odd"><th><a href="qxtwebevent.html">QxtWebEvent</a></th><td>Base class of all QxtWeb event types</td></tr>
<tr valign="top" class="even"><th><a href="qxtwebpageevent.html">QxtWebPageEvent</a></th><td>Describes a web page or other content to be sent to a web browser</td></tr>
<tr valign="top" class="odd"><th><a href="qxtwebredirectevent.html">QxtWebRedirectEvent</a></th><td>Describes a redirect event to be sent to a web browser</td></tr>
<tr valign="top" class="even"><th><a href="qxtwebremovecookieevent.html">QxtWebRemoveCookieEvent</a></th><td>Describes a cookie to be deleted from a web browser</td></tr>
<tr valign="top" class="odd"><th><a href="qxtwebrequestevent.html">QxtWebRequestEvent</a></th><td>Describes a request from a web browser</td></tr>
<tr valign="top" class="even"><th><a href="qxtwebservicedirectory.html">QxtWebServiceDirectory</a></th><td>Path-based web service dispatcher</td></tr>
<tr valign="top" class="odd"><th><a href="qxtwebslotservice.html">QxtWebSlotService</a></th><td>Slot based webservice</td></tr>
<tr valign="top" class="even"><th><a href="qxtwebstorecookieevent.html">QxtWebStoreCookieEvent</a></th><td>Describes a cookie to be sent to a web browser</td></tr>
</table></p>
<a name="details"></a>
<h2>Detailed Description</h2>
<a name="qxtweb"></a><p>QxtWeb provides tools for creating event-driven web services using Qt.</p>
<p>The general usage pattern is as follows:</p>
<ul>
<li>Create a <a href="qxtabstractwebsessionmanager.html">QxtAbstractWebSessionManager</a> object, such as <a href="qxthttpsessionmanager.html">QxtHttpSessionManager</a>, for each protocol that can interface to the service.</li>
<li>If using <a href="qxthttpsessionmanager.html">QxtHttpSessionManager</a>, select a connector plugin, such as <a href="qxthttpserverconnector.html">QxtHttpServerConnector</a>.</li>
<li>Register a <a href="qxtabstractwebservice.html">QxtAbstractWebService</a> factory. The factory is invoked each time a new session is created and returns a service object for that session. <a href="qxtwebservicedirectory.html">QxtWebServiceDirectory</a> allows you to register multiple services and selects between them based on the path.</li>
<li>Invoke <a href="qxtabstractwebsessionmanager.html#start">QxtAbstractWebSessionManager::start</a>() to begin accepting connections.</li>
</ul>
<p>When a new visitor connects who does not belong to a session, a new service instance is created. When a request is received, a <a href="qxtabstractwebservice.html#pageRequestedEvent">QxtAbstractWebService::pageRequestedEvent</a>() is dispatched to the service. When the service is ready to respond to the request, it posts a <a href="qxtwebpageevent.html">QxtWebPageEvent</a> to the session manager. This is done asynchronously; there is no requirement that the pageRequestedEvent handler must respond to the request before the function ends, but such a response must eventually be posted or the web browser will eventually time out.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2007-2010
<a href="mailto:foundation@libqxt.org">Qxt Foundation</a></td>
<td align="right"><div align="right">
<a href="http://libqxt.org">Qxt</a> 0.6.1</div></td>
</tr></table></div></address></body>
</html>
