<?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/qxtwebcgiservice.cpp -->
<head>
<title>QxtWebCgiService 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">QxtWebCgiService Class Reference<br /><span class="small-subtitle">[<a href="qxtweb.html">QxtWeb</a> module]</span>
</h1>
<p>The QxtWebCgiService class provides a CGI/1.1 gateway for <a href="qxtweb.html">QxtWeb</a> <a href="#details">More...</a></p>
<pre> #include <QxtWebCgiService></pre><p>Inherits <a href="qxtabstractwebservice.html">QxtAbstractWebService</a>.</p>
<ul>
<li><a href="qxtwebcgiservice-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="qxtwebcgiservice.html#QxtWebCgiService">QxtWebCgiService</a></b> ( const QString & <i>binary</i>, QxtAbstractWebSessionManager * <i>manager</i>, QObject * <i>parent</i> = 0 )</li>
<li><div class="fn"></div>QString <b><a href="qxtwebcgiservice.html#binary">binary</a></b> () const</li>
<li><div class="fn"></div>void <b><a href="qxtwebcgiservice.html#setBinary">setBinary</a></b> ( const QString & <i>bin</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtwebcgiservice.html#setTimeout">setTimeout</a></b> ( int <i>time</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtwebcgiservice.html#setTimeoutOverride">setTimeoutOverride</a></b> ( bool <i>enable</i> )</li>
<li><div class="fn"></div>int <b><a href="qxtwebcgiservice.html#timeout">timeout</a></b> () const</li>
<li><div class="fn"></div>bool <b><a href="qxtwebcgiservice.html#timeoutOverride">timeoutOverride</a></b> () const</li>
</ul>
<ul>
<li><div class="fn"></div>3 public functions inherited from <a href="qxtabstractwebservice.html#public-functions">QxtAbstractWebService</a></li>
<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>
<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>7 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-functions">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 QxtWebCgiService class provides a CGI/1.1 gateway for <a href="qxtweb.html">QxtWeb</a></p>
<p>TODO: write docs TODO: implement timeout</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QxtWebCgiService"></a>QxtWebCgiService::QxtWebCgiService ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>binary</i>, <a href="qxtabstractwebsessionmanager.html">QxtAbstractWebSessionManager</a> * <i>manager</i>, <a href="http://doc.qtsoftware.com/4.5/qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
<p>Constructs a <a href="qxtwebcgiservice.html">QxtWebCgiService</a> object with the specified session <i>manager</i> and <i>parent</i>. This service will invoke the specified <i>binary</i> to handle incoming requests.</p>
<p>Often, the session manager will also be the parent, but this is not a requirement.</p>
<h3 class="fn"><a name="binary"></a><a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> QxtWebCgiService::binary () const</h3>
<p>Returns the path to the CGI script that will be executed to handle requests.</p>
<p>See also <a href="qxtwebcgiservice.html#setBinary">setBinary</a>().</p>
<h3 class="fn"><a name="setBinary"></a>void QxtWebCgiService::setBinary ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>bin</i> )</h3>
<p>Sets the path to the CGI script <i>bin</i> that will be executed to handle requests.</p>
<p>See also <a href="qxtwebcgiservice.html#binary">binary</a>().</p>
<h3 class="fn"><a name="setTimeout"></a>void QxtWebCgiService::setTimeout ( int <i>time</i> )</h3>
<p>Sets the maximum <i>time</i> a CGI script may execute, in milliseconds.</p>
<p>The timer is started when the script is launched. After the timeout elapses once, the script will be asked to stop, as <a href="http://doc.qtsoftware.com/4.5/qprocess.html#terminate">QProcess::terminate</a>(). (That is, the script will receive WM_CLOSE on Windows or SIGTERM on UNIX.) If the process has still failed to terminate after another timeout, it will be forcibly terminated, as <a href="http://doc.qtsoftware.com/4.5/qprocess.html#kill">QProcess::kill</a>(). (That is, the script will receive TerminateProcess on Windows or SIGKILL on UNIX.)</p>
<p>Set the timeout to 0 to disable this behavior; scripts will not be terminated due to excessive run time. This is the default behavior.</p>
<p>CAUTION: Keep in mind that the timeout applies to the real running time of the script, not processor time used. A script that initiates a lengthy download may be interrupted while transferring data to the web browser. To avoid this behavior, see the timeoutOverride property to allow the script to request an extended timeout, or use a different <a href="qxtabstractwebservice.html">QxtAbstractWebService</a> object for serving streaming content or large files.</p>
<p>See also <a href="qxtwebcgiservice.html#timeout">timeout</a>(), <a href="qxtwebcgiservice.html#timeoutOverride">timeoutOverride</a>(), <a href="qxtwebcgiservice.html#setTimeoutOverride">setTimeoutOverride</a>(), <a href="http://doc.qtsoftware.com/4.5/qprocess.html#terminate">QProcess::terminate</a>(), and <a href="http://doc.qtsoftware.com/4.5/qprocess.html#kill">QProcess::kill</a>().</p>
<h3 class="fn"><a name="setTimeoutOverride"></a>void QxtWebCgiService::setTimeoutOverride ( bool <i>enable</i> )</h3>
<p>Sets whether or not to allow scripts to override the timeout. Scripts are allowed to override if <i>enable</i> is <tt>true</tt>.</p>
<p>As an extension to the CGI/1.1 gateway specification, a CGI script may output a "X-<a href="qxtweb.html">QxtWeb</a>-Timeout" header to change the termination timeout on a per-script basis. Only enable this option if you trust the scripts being executed.</p>
<p>See also <a href="qxtwebcgiservice.html#timeoutOverride">timeoutOverride</a>() and <a href="qxtwebcgiservice.html#setTimeout">setTimeout</a>().</p>
<h3 class="fn"><a name="timeout"></a>int QxtWebCgiService::timeout () const</h3>
<p>Returns the maximum time a CGI script may execute, in milliseconds.</p>
<p>The default value is 0, which indicates that CGI scripts will not be terminated due to long running times.</p>
<p>See also <a href="qxtwebcgiservice.html#setTimeout">setTimeout</a>().</p>
<h3 class="fn"><a name="timeoutOverride"></a>bool QxtWebCgiService::timeoutOverride () const</h3>
<p>Returns whether or not to allow scripts to override the timeout.</p>
<p>See also <a href="qxtwebcgiservice.html#setTimeoutOverride">setTimeoutOverride</a>() and <a href="qxtwebcgiservice.html#setTimeout">setTimeout</a>().</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>
