tufao  1.3.0
An asynchronous web framework for C++ built on top of Qt
httpupgraderouter.h
1 /*
2  Copyright (c) 2013 Vinícius dos Santos Oliveira
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 deal
6  in the Software without restriction, including without limitation the rights
7  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  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 all
12  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 FROM,
19  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  SOFTWARE.
21  */
22 
23 #ifndef TUFAO_HTTPUPGRADEROUTER_H
24 #define TUFAO_HTTPUPGRADEROUTER_H
25 
26 #include <functional>
27 #include <initializer_list>
28 
29 #include <QtCore/QObject>
30 #include <QtCore/QRegularExpression>
31 
32 #include "abstracthttpupgradehandler.h"
33 
34 namespace Tufao {
35 
62 class TUFAO_EXPORT HttpUpgradeRouter: public QObject,
64 {
65  Q_OBJECT
66 public:
74  typedef std::function<bool(HttpServerRequest&, const QByteArray &head)>
76 
87  struct Mapping
88  {
93  Mapping(QRegularExpression path, Handler handler) :
94  path(path), handler(handler)
95  {}
96 
100  Mapping() = default;
101 
106  QRegularExpression path;
107  Handler handler;
108  };
109 
113  explicit HttpUpgradeRouter(QObject *parent = 0);
114 
118  explicit HttpUpgradeRouter(std::initializer_list<Mapping> mappings,
119  QObject *parent = 0);
120 
125 
132  int map(Mapping map);
133 
140  int map(std::initializer_list<Mapping> map);
141 
145  void unmap(int index);
146 
150  void clear();
151 
152 public slots:
186  bool handleUpgrade(Tufao::HttpServerRequest &request,
187  const QByteArray &head) override;
188 
189 private:
190  struct Priv;
191  Priv *priv;
192 };
193 
194 } // namespace Tufao
195 
196 #endif // TUFAO_HTTPUPGRADEROUTER_H
The Tufao::HttpServer represents a HTTP request received by Tufao::HttpServer.
Definition: httpserverrequest.h:54
This is the namespace where all Tufão facilities are grouped.
Definition: abstracthttpserverrequesthandler.h:30
This class describes a request handler and a filter.
Definition: httpupgraderouter.h:87
This class provides an interface for HTTP Upgrade handlers.
Definition: abstracthttpupgradehandler.h:47
This class provides a robust and high performance HTTP request router.
Definition: httpupgraderouter.h:62
Mapping(QRegularExpression path, Handler handler)
Constructs a Mapping object using path as filter and handler as handler.
Definition: httpupgraderouter.h:93
std::function< bool(HttpServerRequest &, const QByteArray &head)> Handler
It's a simple typedef for the type of handler accepted by the HttpUpgradeRouter.
Definition: httpupgraderouter.h:75
QRegularExpression path
This attribute is used to filter requests based on the url's path component.
Definition: httpupgraderouter.h:106