fixed docs

This commit is contained in:
Günter Obiltschnig
2020-01-23 19:18:41 +01:00
parent 839009d9b5
commit 58b257c0a8

View File

@@ -34,7 +34,7 @@ class Net_API HTTPServerParams: public TCPServerParams
{ {
public: public:
using Ptr = Poco::AutoPtr<HTTPServerParams>; using Ptr = Poco::AutoPtr<HTTPServerParams>;
HTTPServerParams(); HTTPServerParams();
/// Creates the HTTPServerParams. /// Creates the HTTPServerParams.
/// ///
@@ -43,13 +43,13 @@ public:
/// - keepAlive: true /// - keepAlive: true
/// - maxKeepAliveRequests: 0 /// - maxKeepAliveRequests: 0
/// - keepAliveTimeout: 10 seconds /// - keepAliveTimeout: 10 seconds
void setServerName(const std::string& serverName); void setServerName(const std::string& serverName);
/// Sets the name and port (name:port) that the server uses to identify itself. /// Sets the name and port (name:port) that the server uses to identify itself.
/// ///
/// If this is not set to valid DNS name for your host, server-generated /// If this is not set to valid DNS name for your host, server-generated
/// redirections will not work. /// redirections will not work.
const std::string& getServerName() const; const std::string& getServerName() const;
/// Returns the name and port (name:port) that the server uses to identify itself. /// Returns the name and port (name:port) that the server uses to identify itself.
@@ -68,28 +68,28 @@ public:
void setTimeout(const Poco::Timespan& timeout); void setTimeout(const Poco::Timespan& timeout);
/// Sets the connection timeout for HTTP connections. /// Sets the connection timeout for HTTP connections.
const Poco::Timespan& getTimeout() const; const Poco::Timespan& getTimeout() const;
/// Returns the connection timeout for HTTP connections. /// Returns the connection timeout for HTTP connections.
void setKeepAlive(bool keepAlive); void setKeepAlive(bool keepAlive);
/// Enables (keepAlive == true) or disables (keepAlive == false) /// Enables (keepAlive == true) or disables (keepAlive == false)
/// persistent connections. /// persistent connections.
bool getKeepAlive() const; bool getKeepAlive() const;
/// Returns true iff persistent connections are enabled. /// Returns true iff persistent connections are enabled.
void setKeepAliveTimeout(const Poco::Timespan& timeout); void setKeepAliveTimeout(const Poco::Timespan& timeout);
/// Sets the connection timeout for HTTP connections. /// Sets the keep-alive timeout for persistent HTTP connections.
const Poco::Timespan& getKeepAliveTimeout() const; const Poco::Timespan& getKeepAliveTimeout() const;
/// Returns the connection timeout for HTTP connections. /// Returns the keep-alive timeout for persistent HTTP connections.
void setMaxKeepAliveRequests(int maxKeepAliveRequests); void setMaxKeepAliveRequests(int maxKeepAliveRequests);
/// Specifies the maximum number of requests allowed /// Specifies the maximum number of requests allowed
/// during a persistent connection. 0 means unlimited /// during a persistent connection. 0 means unlimited
/// connections. /// connections.
int getMaxKeepAliveRequests() const; int getMaxKeepAliveRequests() const;
/// Returns the maximum number of requests allowed /// Returns the maximum number of requests allowed
/// during a persistent connection, or 0 if /// during a persistent connection, or 0 if