mirror of https://github.com/f4exb/sdrangel.git
134 lines
4.0 KiB
C++
134 lines
4.0 KiB
C++
/**
|
|
@file
|
|
@author Stefan Frings
|
|
*/
|
|
|
|
#ifndef HTTPLISTENER_H
|
|
#define HTTPLISTENER_H
|
|
|
|
#include <QTcpServer>
|
|
#include <QSettings>
|
|
#include <QBasicTimer>
|
|
#include "httpglobal.h"
|
|
#include "httpconnectionhandler.h"
|
|
#include "httpconnectionhandlerpool.h"
|
|
#include "httprequesthandler.h"
|
|
#include "httplistenersettings.h"
|
|
|
|
#include "export.h"
|
|
|
|
namespace qtwebapp {
|
|
|
|
/**
|
|
Listens for incoming TCP connections and and passes all incoming HTTP requests to your implementation of HttpRequestHandler,
|
|
which processes the request and generates the response (usually a HTML document).
|
|
<p>
|
|
Example for the required settings in the config file:
|
|
<code><pre>
|
|
;host=192.168.0.100
|
|
port=8080
|
|
minThreads=1
|
|
maxThreads=10
|
|
cleanupInterval=1000
|
|
readTimeout=60000
|
|
;sslKeyFile=ssl/my.key
|
|
;sslCertFile=ssl/my.cert
|
|
maxRequestSize=16000
|
|
maxMultiPartSize=1000000
|
|
</pre></code>
|
|
The optional host parameter binds the listener to one network interface.
|
|
The listener handles all network interfaces if no host is configured.
|
|
The port number specifies the incoming TCP port that this listener listens to.
|
|
@see HttpConnectionHandlerPool for description of config settings minThreads, maxThreads, cleanupInterval and ssl settings
|
|
@see HttpConnectionHandler for description of the readTimeout
|
|
@see HttpRequest for description of config settings maxRequestSize and maxMultiPartSize
|
|
*/
|
|
|
|
class HTTPSERVER_API HttpListener : public QTcpServer {
|
|
Q_OBJECT
|
|
Q_DISABLE_COPY(HttpListener)
|
|
public:
|
|
|
|
/**
|
|
Constructor.
|
|
Creates a connection pool and starts listening on the configured host and port.
|
|
@param settings Configuration settings for the HTTP server. Must not be 0.
|
|
@param requestHandler Processes each received HTTP request, usually by dispatching to controller classes.
|
|
@param parent Parent object.
|
|
@warning Ensure to close or delete the listener before deleting the request handler.
|
|
*/
|
|
HttpListener(QSettings* settings, HttpRequestHandler* requestHandler, QObject* parent = NULL);
|
|
|
|
/**
|
|
Constructor.
|
|
Creates a connection pool and starts listening on the configured host and port.
|
|
@param settings Configuration settings for the HTTP server as a structure.
|
|
@param requestHandler Processes each received HTTP request, usually by dispatching to controller classes.
|
|
@param parent Parent object.
|
|
@warning Ensure to close or delete the listener before deleting the request handler.
|
|
*/
|
|
HttpListener(const HttpListenerSettings& settings, HttpRequestHandler* requestHandler, QObject* parent = NULL);
|
|
|
|
/** Destructor */
|
|
virtual ~HttpListener();
|
|
|
|
/**
|
|
Restart listeing after close().
|
|
*/
|
|
void listen();
|
|
|
|
/**
|
|
Closes the listener, waits until all pending requests are processed,
|
|
then closes the connection pool.
|
|
*/
|
|
void close();
|
|
|
|
/**
|
|
* Get a listener settings copy
|
|
* @return The current listener settings
|
|
*/
|
|
HttpListenerSettings getListenerSettings() const { return listenerSettings; }
|
|
|
|
/**
|
|
* Set new listener settings data
|
|
* @param Listener settings to replace current data
|
|
*/
|
|
void setListenerSettings(const HttpListenerSettings& settings) { listenerSettings = settings; }
|
|
|
|
protected:
|
|
|
|
/** Serves new incoming connection requests */
|
|
void incomingConnection(tSocketDescriptor socketDescriptor);
|
|
|
|
private:
|
|
|
|
/** Configuration settings for the HTTP server */
|
|
QSettings* settings;
|
|
|
|
/** Configuration settings for the HTTP server as a structure */
|
|
HttpListenerSettings listenerSettings;
|
|
|
|
/** Point to the reuqest handler which processes all HTTP requests */
|
|
HttpRequestHandler* requestHandler;
|
|
|
|
/** Pool of connection handlers */
|
|
HttpConnectionHandlerPool* pool;
|
|
|
|
/** Settings flag */
|
|
bool useQtSettings;
|
|
|
|
signals:
|
|
|
|
/**
|
|
Sent to the connection handler to process a new incoming connection.
|
|
@param socketDescriptor references the accepted connection.
|
|
*/
|
|
|
|
void handleConnection(tSocketDescriptor socketDescriptor);
|
|
|
|
};
|
|
|
|
} // end of namespace
|
|
|
|
#endif // HTTPLISTENER_H
|