File: Poco.Net.HTTPServerParams.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (128 lines) | stat: -rw-r--r-- 10,871 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<!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>
<title>Class Poco::Net::HTTPServerParams</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.Net.html" class="namespace">Poco::Net</a></h1>
<h1 class="symbol">class HTTPServerParams</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Net<br />
<b>Package:</b> HTTPServer<br />
<b>Header:</b> Poco/Net/HTTPServerParams.h</p>
<h2>Description</h2>
<div class="description">
<p>This class is used to specify parameters to both the <a href="Poco.Net.HTTPServer.html" title="class Poco::Net::HTTPServer">HTTPServer</a>, as well as to <a href="Poco.Net.HTTPRequestHandler.html" title="class Poco::Net::HTTPRequestHandler">HTTPRequestHandler</a> objects. </p>
<p>Subclasses may add new parameters to the class. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.Net.TCPServerParams.html" title="class Poco::Net::TCPServerParams">TCPServerParams</a></p>
<p><b>All Base Classes: </b><a href="Poco.Net.TCPServerParams.html" title="class Poco::Net::TCPServerParams">TCPServerParams</a>, <a href="Poco.RefCountedObject.html" title="class Poco::RefCountedObject">Poco::RefCountedObject</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Net.HTTPServerParams.html#13073" title="Poco::Net::HTTPServerParams::getKeepAlive()">getKeepAlive</a>, <a href="Poco.Net.HTTPServerParams.html#13076" title="Poco::Net::HTTPServerParams::getKeepAliveTimeout()">getKeepAliveTimeout</a>, <a href="Poco.Net.HTTPServerParams.html#13079" title="Poco::Net::HTTPServerParams::getMaxKeepAliveRequests()">getMaxKeepAliveRequests</a>, <a href="Poco.Net.HTTPServerParams.html#13064" title="Poco::Net::HTTPServerParams::getServerName()">getServerName</a>, <a href="Poco.Net.HTTPServerParams.html#13067" title="Poco::Net::HTTPServerParams::getSoftwareVersion()">getSoftwareVersion</a>, <a href="Poco.Net.HTTPServerParams.html#13070" title="Poco::Net::HTTPServerParams::getTimeout()">getTimeout</a>, <a href="Poco.Net.HTTPServerParams.html#13071" title="Poco::Net::HTTPServerParams::setKeepAlive()">setKeepAlive</a>, <a href="Poco.Net.HTTPServerParams.html#13074" title="Poco::Net::HTTPServerParams::setKeepAliveTimeout()">setKeepAliveTimeout</a>, <a href="Poco.Net.HTTPServerParams.html#13077" title="Poco::Net::HTTPServerParams::setMaxKeepAliveRequests()">setMaxKeepAliveRequests</a>, <a href="Poco.Net.HTTPServerParams.html#13062" title="Poco::Net::HTTPServerParams::setServerName()">setServerName</a>, <a href="Poco.Net.HTTPServerParams.html#13065" title="Poco::Net::HTTPServerParams::setSoftwareVersion()">setSoftwareVersion</a>, <a href="Poco.Net.HTTPServerParams.html#13068" title="Poco::Net::HTTPServerParams::setTimeout()">setTimeout</a></p>
<p><b>Inherited Functions: </b><a href="Poco.RefCountedObject.html#9659" title="Poco::RefCountedObject::duplicate()">duplicate</a>, <a href="Poco.Net.TCPServerParams.html#15655" title="Poco::Net::TCPServerParams::getMaxQueued()">getMaxQueued</a>, <a href="Poco.Net.TCPServerParams.html#15658" title="Poco::Net::TCPServerParams::getMaxThreads()">getMaxThreads</a>, <a href="Poco.Net.TCPServerParams.html#15652" title="Poco::Net::TCPServerParams::getThreadIdleTime()">getThreadIdleTime</a>, <a href="Poco.Net.TCPServerParams.html#15661" title="Poco::Net::TCPServerParams::getThreadPriority()">getThreadPriority</a>, <a href="Poco.RefCountedObject.html#9661" title="Poco::RefCountedObject::referenceCount()">referenceCount</a>, <a href="Poco.RefCountedObject.html#9660" title="Poco::RefCountedObject::release()">release</a>, <a href="Poco.Net.TCPServerParams.html#15653" title="Poco::Net::TCPServerParams::setMaxQueued()">setMaxQueued</a>, <a href="Poco.Net.TCPServerParams.html#15656" title="Poco::Net::TCPServerParams::setMaxThreads()">setMaxThreads</a>, <a href="Poco.Net.TCPServerParams.html#15650" title="Poco::Net::TCPServerParams::setThreadIdleTime()">setThreadIdleTime</a>, <a href="Poco.Net.TCPServerParams.html#15659" title="Poco::Net::TCPServerParams::setThreadPriority()">setThreadPriority</a></p>
<h2>Types</h2>
<h3><a name="13060">Ptr</a></h3>
<p class="decl">typedef <a href="Poco.AutoPtr.html" title="class Poco::AutoPtr">Poco::AutoPtr</a> &lt; <a href="Poco.Net.HTTPServerParams.html" title="class Poco::Net::HTTPServerParams">HTTPServerParams</a> &gt; <a href="Poco.Net.HTTPServerParams.html#13060" title="Poco::Net::HTTPServerParams::Ptr">Ptr</a>;</p>
<div class="description">
<p></p>
</div>
<h2>Constructors</h2>
<h3><a name="13061">HTTPServerParams</a></h3>
<p class="decl"><a href="Poco.Net.HTTPServerParams.html" title="class Poco::Net::HTTPServerParams">HTTPServerParams</a>();</p>
<div class="description">
<p>Creates the <a href="Poco.Net.HTTPServerParams.html" title="class Poco::Net::HTTPServerParams">HTTPServerParams</a>. </p>
<p>Sets the following default values: </p>
<ul>
<li>timeout:              60 seconds </li>
<li>keepAlive:            true </li>
<li>maxKeepAliveRequests: 0 </li>
<li>keepAliveTimeout:     10 seconds </li>
</ul>
</div>
<h2>Destructor</h2>
<h3><a name="13080">~HTTPServerParams</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual ~<a href="Poco.Net.HTTPServerParams.html" title="class Poco::Net::HTTPServerParams">HTTPServerParams</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Net.HTTPServerParams.html" title="class Poco::Net::HTTPServerParams">HTTPServerParams</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="13073">getKeepAlive</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool getKeepAlive() const;</p>
<div class="description">
<p>Returns true if and only if persistent connections are enabled. </p>
</div>
<h3><a name="13076">getKeepAliveTimeout</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.Timespan.html" title="class Poco::Timespan">Poco::Timespan</a> &amp; getKeepAliveTimeout() const;</p>
<div class="description">
<p>Returns the connection timeout for HTTP connections. </p>
</div>
<h3><a name="13079">getMaxKeepAliveRequests</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int getMaxKeepAliveRequests() const;</p>
<div class="description">
<p>Returns the maximum number of requests allowed during a persistent connection, or 0 if unlimited connections are allowed. </p>
</div>
<h3><a name="13064">getServerName</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getServerName() const;</p>
<div class="description">
<p>Returns the name and port (name:port) that the server uses to identify itself. </p>
</div>
<h3><a name="13067">getSoftwareVersion</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getSoftwareVersion() const;</p>
<div class="description">
<p>Returns the server software name and version that the server uses to identify itself. </p>
</div>
<h3><a name="13070">getTimeout</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.Timespan.html" title="class Poco::Timespan">Poco::Timespan</a> &amp; getTimeout() const;</p>
<div class="description">
<p>Returns the connection timeout for HTTP connections. </p>
</div>
<h3><a name="13071">setKeepAlive</a></h3>
<p class="decl">void setKeepAlive(<br />&nbsp;&nbsp;&nbsp;&nbsp;bool keepAlive<br />);</p>
<div class="description">
<p>Enables (keepAlive == true) or disables (keepAlive == false) persistent connections. </p>
</div>
<h3><a name="13074">setKeepAliveTimeout</a></h3>
<p class="decl">void setKeepAliveTimeout(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Timespan.html" title="class Poco::Timespan">Poco::Timespan</a> &amp; timeout<br />);</p>
<div class="description">
<p>Sets the connection timeout for HTTP connections. </p>
</div>
<h3><a name="13077">setMaxKeepAliveRequests</a></h3>
<p class="decl">void setMaxKeepAliveRequests(<br />&nbsp;&nbsp;&nbsp;&nbsp;int maxKeepAliveRequests<br />);</p>
<div class="description">
<p>Specifies the maximun number of requests allowed during a persistent connection. 0 means unlimited connections. </p>
</div>
<h3><a name="13062">setServerName</a></h3>
<p class="decl">void setServerName(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; serverName<br />);</p>
<div class="description">
<p>Sets the name and port (name:port) that the server uses to identify itself. </p>
<p>If this is not set to valid <a href="Poco.Net.DNS.html" title="class Poco::Net::DNS">DNS</a> name for your host, server-generated redirections will not work. </p>
</div>
<h3><a name="13065">setSoftwareVersion</a></h3>
<p class="decl">void setSoftwareVersion(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; softwareVersion<br />);</p>
<div class="description">
<p>Sets the server software name and version that the server uses to identify itself. If this is set to a non-empty string, the server will automatically include a Server header field with the value given here in every response it sends. </p>
<p>The format of the softwareVersion string should be name/version (e.g. MyHTTPServer/1.0). </p>
</div>
<h3><a name="13068">setTimeout</a></h3>
<p class="decl">void setTimeout(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Timespan.html" title="class Poco::Timespan">Poco::Timespan</a> &amp; timeout<br />);</p>
<div class="description">
<p>Sets the connection timeout for HTTP connections. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>