QHttpEngine  1.0.0
Simple and secure HTTP server for Qt applications
handler.h
1 /*
2  * Copyright (c) 2017 Nathan Osman
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to
6  * deal in the Software without restriction, including without limitation the
7  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8  * sell copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20  * IN THE SOFTWARE.
21  */
22 
23 #ifndef QHTTPENGINE_HANDLER_H
24 #define QHTTPENGINE_HANDLER_H
25 
26 #include <QObject>
27 
28 #include "qhttpengine_export.h"
29 
30 class QRegExp;
31 
32 namespace QHttpEngine
33 {
34 
35 class Middleware;
36 class Socket;
37 
38 class QHTTPENGINE_EXPORT HandlerPrivate;
39 
77 class QHTTPENGINE_EXPORT Handler : public QObject
78 {
79  Q_OBJECT
80 
81 public:
82 
86  explicit Handler(QObject *parent = 0);
87 
91  void addMiddleware(Middleware *middleware);
92 
103  void addRedirect(const QRegExp &pattern, const QString &path);
104 
112  void addSubHandler(const QRegExp &pattern, Handler *handler);
113 
117  void route(Socket *socket, const QString &path);
118 
119 protected:
120 
130  virtual void process(Socket *socket, const QString &path);
131 
132 private:
133 
134  HandlerPrivate *const d;
135  friend class HandlerPrivate;
136 };
137 
138 }
139 
140 #endif // QHTTPENGINE_HANDLER_H
Base class for HTTP handlers.
Definition: handler.h:77
Definition: basicauthmiddleware.h:30
Pre-handler request processor.
Definition: middleware.h:41
Implementation of the HTTP protocol.
Definition: socket.h:96