/* * Copyright 2011-2014 Nikhil Marathe * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to * deal in the Software without restriction, including without limitation the * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or * sell copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS * IN THE SOFTWARE. */ #ifndef Q_HTTP_SERVER #define Q_HTTP_SERVER #define QHTTPSERVER_VERSION_MAJOR 0 #define QHTTPSERVER_VERSION_MINOR 1 #define QHTTPSERVER_VERSION_PATCH 0 #include "qhttpserverapi.h" #include "qhttpserverfwd.h" #include #include /// Maps status codes to string reason phrases extern QHash STATUS_CODES; /// The QHttpServer class forms the basis of the %QHttpServer /// project. It is a fast, non-blocking HTTP server. /** These are the steps to create a server, handle and respond to requests:

Create an instance of QHttpServer.
Connect a slot to the newRequest() signal.
Create a QCoreApplication to drive the server event loop.
Respond to clients by writing out to the QHttpResponse object.

Here is a simple sample application on how to use this library helloworld.cpp @include helloworld/helloworld.cpp helloworld.h @include helloworld/helloworld.h */ class QHTTPSERVER_API QHttpServer : public QObject { Q_OBJECT public: /// Construct a new HTTP Server. /** @param parent Parent QObject for the server. */ QHttpServer(QObject *parent = 0); virtual ~QHttpServer(); /// Start the server by bounding to the given @c address and @c port. /** @note This function returns immediately, it does not block. @param address Address on which to listen to. Default is to listen on all interfaces which means the server can be accessed from anywhere. @param port Port number on which the server should run. @return True if the server was started successfully, false otherwise. @sa listen(quint16) */ bool listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 80); /// Starts the server on @c port listening on all interfaces. /** @param port Port number on which the server should run. @return True if the server was started successfully, false otherwise. @sa listen(const QHostAddress&, quint16) */ bool listen(quint16 port); /// Stop the server and listening for new connections. void close(); Q_SIGNALS: /// Emitted when a client makes a new request to the server. /** The slot should use the given @c request and @c response objects to communicate with the client. @param request New incoming request. @param response Response object to the request. */ void newRequest(QHttpRequest *request, QHttpResponse *response); private Q_SLOTS: void newConnection(); private: QTcpServer *m_tcpServer; }; #endif