<?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/src/web/qxtabstractwebsessionmanager.cpp -->
<head>
<title>QxtAbstractWebSessionManager Class Reference</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">QxtAbstractWebSessionManager Class Reference<br /><span class="small-subtitle">[<a href="qxtweb.html">QxtWeb</a> module]</span>
</h1>
<p>The QxtAbstractWebSessionManager class is a base class for <a href="qxtweb.html">QxtWeb</a> session managers <a href="#details">More...</a></p>
<pre> #include <QxtAbstractWebSessionManager></pre><p>Inherits <a href="http://doc.qtsoftware.com/4.5/qobject.html">QObject</a>.</p>
<p>Inherited by <a href="qxthttpsessionmanager.html">QxtHttpSessionManager</a>.</p>
<ul>
<li><a href="qxtabstractwebsessionmanager-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"></div><b><a href="qxtabstractwebsessionmanager.html#QxtAbstractWebSessionManager">QxtAbstractWebSessionManager</a></b> ( QObject * <i>parent</i> = 0 )</li>
<li><div class="fn"></div>virtual void <b><a href="qxtabstractwebsessionmanager.html#postEvent">postEvent</a></b> ( QxtWebEvent * <i>event</i> ) = 0</li>
<li><div class="fn"></div>ServiceFactory * <b><a href="qxtabstractwebsessionmanager.html#serviceFactory">serviceFactory</a></b> () const</li>
<li><div class="fn"></div>QxtAbstractWebService * <b><a href="qxtabstractwebsessionmanager.html#session">session</a></b> ( int <i>sessionID</i> ) const</li>
<li><div class="fn"></div>void <b><a href="qxtabstractwebsessionmanager.html#setServiceFactory">setServiceFactory</a></b> ( ServiceFactory * <i>factory</i> )</li>
<li><div class="fn"></div>virtual bool <b><a href="qxtabstractwebsessionmanager.html#start">start</a></b> () = 0</li>
</ul>
<ul>
<li><div class="fn"></div>29 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h3>Protected Functions</h3>
<ul>
<li><div class="fn"></div>int <b><a href="qxtabstractwebsessionmanager.html#createService">createService</a></b> ()</li>
</ul>
<ul>
<li><div class="fn"></div>7 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="protected-slots"></a>
<h3>Protected Slots</h3>
<ul>
<li><div class="fn"></div>virtual void <b><a href="qxtabstractwebsessionmanager.html#processEvents">processEvents</a></b> () = 0</li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>1 property inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 public slot inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-slots">QObject</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#signals">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtAbstractWebSessionManager class is a base class for <a href="qxtweb.html">QxtWeb</a> session managers</p>
<p>QxtAbstractWebSessionManager is the base class for all <a href="qxtweb.html">QxtWeb</a> session managers.</p>
<p>Session managers are responsible for managing connections between web browsers and web services, for creating sessions and their corresponding service objects, and for managing and dispatching events between browsers and services.</p>
<p>Note that the session manager is not responsible for destroying service objects. A service object that wishes to end its corresponding session may destroy itself (see <a href="http://doc.qtsoftware.com/4.5/qobject.html#deleteLater">QObject::deleteLater</a>()) and QxtAbstractWebSessionManager will automatically clean up its internal session tracking data.</p>
<p>See also <a href="qxtabstractwebservice.html">QxtAbstractWebService</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QxtAbstractWebSessionManager"></a>QxtAbstractWebSessionManager::QxtAbstractWebSessionManager ( <a href="http://doc.qtsoftware.com/4.5/qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
<p>Creates a <a href="qxtabstractwebsessionmanager.html">QxtAbstractWebSessionManager</a> with the specified <i>parent</i>.</p>
<p>Note that this is an abstract class and cannot be instantiated directly.</p>
<h3 class="fn"><a name="createService"></a>int QxtAbstractWebSessionManager::createService () <tt> [protected]</tt></h3>
<p>Creates a new session and returns its session ID.</p>
<p>This function uses the <a href="qxtabstractwebsessionmanager.html#serviceFactory">serviceFactory</a>() to request an instance of the web service.</p>
<p>See also <a href="qxtabstractwebsessionmanager.html#serviceFactory">serviceFactory</a>().</p>
<h3 class="fn"><a name="postEvent"></a>void QxtAbstractWebSessionManager::postEvent ( <a href="qxtwebevent.html">QxtWebEvent</a> * <i>event</i> ) <tt> [pure virtual]</tt></h3>
<p>Adds the event to the event queue for its associated session.</p>
<p>Since different protocols may require different event processing behavior, there is no default implementation in <a href="qxtabstractwebsessionmanager.html">QxtAbstractWebSessionManager</a>. Subclasses are responsible for maintaining event queues and deciding when and where to dispatch events.</p>
<p>Depending on the subclass's implementation posted events may not be dispatched for some time, and is is possible that an event may never be dispatched if the session is terminated before the event is handled.</p>
<p>See also <a href="qxtwebevent.html">QxtWebEvent</a>.</p>
<h3 class="fn"><a name="processEvents"></a>void QxtAbstractWebSessionManager::processEvents () <tt> [pure virtual protected slot]</tt></h3>
<p>Processes pending events for all sessions.</p>
<p>Since different protocols may require different event processing behavior, there is no default implementation in <a href="qxtabstractwebsessionmanager.html">QxtAbstractWebSessionManager</a>. Subclasses are responsible for maintaining event queues and deciding when and where to dispatch events.</p>
<p>processEvents() is not required to dispatch all events immediately. In particular, some events may require certain conditions to be met before they may be fully processed. (For example, because HTTP cookies are sent as response headers, <a href="qxthttpserverconnector.html">QxtHttpServerConnector</a> may not dispatch a <a href="qxtwebstorecookieevent.html">QxtWebStoreCookieEvent</a> until a <a href="qxtwebpageevent.html">QxtWebPageEvent</a> for the same session is available.) Unprocessed events may remain in the event queue.</p>
<p>See also <a href="qxtwebevent.html">QxtWebEvent</a>.</p>
<h3 class="fn"><a name="serviceFactory"></a>ServiceFactory * QxtAbstractWebSessionManager::serviceFactory () const</h3>
<p>Returns the service factory in use by the session manager.</p>
<p>See also setServiceFactory(ServiceFactory*).</p>
<h3 class="fn"><a name="session"></a><a href="qxtabstractwebservice.html">QxtAbstractWebService</a> * QxtAbstractWebSessionManager::session ( int <i>sessionID</i> ) const</h3>
<p>Returns the service object corresponding to the provided <i>sessionID</i>.</p>
<h3 class="fn"><a name="setServiceFactory"></a>void QxtAbstractWebSessionManager::setServiceFactory ( ServiceFactory * <i>factory</i> )</h3>
<p>Sets the service <i>factory</i> for the session manager.</p>
<p>The service factory is invoked every time the session manager creates a new session. Usually, an application providing web services will instantiate one <a href="qxtabstractwebservice.html">QxtAbstractWebService</a> object for each session. For services that do not require separate sessions, such as those that serve only static pages, the factory may return a pointer to the same object for multiple requests.</p>
<p>See also <a href="qxtabstractwebsessionmanager.html#serviceFactory">serviceFactory</a>() and QxtAbstractWebSessionManager::ServiceFactory.</p>
<h3 class="fn"><a name="start"></a>bool QxtAbstractWebSessionManager::start () <tt> [pure virtual]</tt></h3>
<p>Starts the session manager.</p>
<p>Session managers should not create sessions before start() is invoked. Subclasses are encouraged to refrain from accepting connections until the session manager is started.</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>
