cutelyst  4.3.0
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
server.h
1 /*
2  * SPDX-FileCopyrightText: (C) 2016-2023 Daniel Nicoletti <dantti12@gmail.com>
3  * SPDX-License-Identifier: BSD-3-Clause
4  */
5 #pragma once
6 
7 #include <Cutelyst/cutelyst_global.h>
8 
9 #include <QObject>
10 
11 class QCoreApplication;
12 
13 namespace Cutelyst {
14 
15 class Application;
16 class ServerPrivate;
59 class CUTELYST_SERVER_EXPORT Server : public QObject
60 {
61  Q_OBJECT
62  Q_DECLARE_PRIVATE(Server)
63 public:
71  explicit Server(QObject *parent = nullptr);
72 
76  virtual ~Server();
77 
82  void parseCommandLine(const QStringList &args);
83 
104  int exec(Cutelyst::Application *app = nullptr);
105 
121  bool start(Cutelyst::Application *app = nullptr);
122 
127  void stop();
128 
134  Q_PROPERTY(QString application READ application WRITE setApplication NOTIFY changed)
135  void setApplication(const QString &application);
136  [[nodiscard]] QString application() const;
137 
150  Q_PROPERTY(QString threads READ threads WRITE setThreads NOTIFY changed)
151  void setThreads(const QString &threads);
152  [[nodiscard]] QString threads() const;
153 
159  Q_PROPERTY(QString processes READ processes WRITE setProcesses NOTIFY changed)
160  void setProcesses(const QString &process);
161  [[nodiscard]] QString processes() const;
167  Q_PROPERTY(QString chdir READ chdir WRITE setChdir NOTIFY changed)
168  void setChdir(const QString &chdir);
169  [[nodiscard]] QString chdir() const;
170 
175  Q_PROPERTY(QStringList http_socket READ httpSocket WRITE setHttpSocket NOTIFY changed)
176  void setHttpSocket(const QStringList &httpSocket);
177  [[nodiscard]] QStringList httpSocket() const;
178 
183  Q_PROPERTY(QStringList http2_socket READ http2Socket WRITE setHttp2Socket NOTIFY changed)
184  void setHttp2Socket(const QStringList &http2Socket);
185  [[nodiscard]] QStringList http2Socket() const;
186 
191  Q_PROPERTY(quint32 http2_header_table_size READ http2HeaderTableSize WRITE
192  setHttp2HeaderTableSize NOTIFY changed)
193  void setHttp2HeaderTableSize(quint32 headerTableSize);
194  [[nodiscard]] quint32 http2HeaderTableSize() const;
195 
201  Q_PROPERTY(bool upgrade_h2c READ upgradeH2c WRITE setUpgradeH2c NOTIFY changed)
202  void setUpgradeH2c(bool enable);
203  [[nodiscard]] bool upgradeH2c() const;
204 
210  Q_PROPERTY(bool https_h2 READ httpsH2 WRITE setHttpsH2 NOTIFY changed)
211  void setHttpsH2(bool enable);
212  [[nodiscard]] bool httpsH2() const;
213 
218  Q_PROPERTY(QStringList https_socket READ httpsSocket WRITE setHttpsSocket NOTIFY changed)
219  void setHttpsSocket(const QStringList &httpsSocket);
220  [[nodiscard]] QStringList httpsSocket() const;
221 
226  Q_PROPERTY(QStringList fastcgi_socket READ fastcgiSocket WRITE setFastcgiSocket NOTIFY changed)
227  void setFastcgiSocket(const QStringList &fastcgiSocket);
228  [[nodiscard]] QStringList fastcgiSocket() const;
229 
234  Q_PROPERTY(QString socket_access READ socketAccess WRITE setSocketAccess NOTIFY changed)
235  void setSocketAccess(const QString &socketAccess);
236  [[nodiscard]] QString socketAccess() const;
242  Q_PROPERTY(int socket_timeout READ socketTimeout WRITE setSocketTimeout NOTIFY changed)
243  void setSocketTimeout(int timeout);
244  [[nodiscard]] int socketTimeout() const;
245 
250  Q_PROPERTY(QString chdir2 READ chdir2 WRITE setChdir2 NOTIFY changed)
251  void setChdir2(const QString &chdir2);
252  [[nodiscard]] QString chdir2() const;
253 
271  Q_PROPERTY(QStringList ini READ ini WRITE setIni NOTIFY changed)
272  void setIni(const QStringList &files);
273  [[nodiscard]] QStringList ini() const;
274 
298  Q_PROPERTY(QStringList json READ json WRITE setJson NOTIFY changed)
299  void setJson(const QStringList &files);
300  [[nodiscard]] QStringList json() const;
301 
315  Q_PROPERTY(QStringList static_map READ staticMap WRITE setStaticMap NOTIFY changed)
316  void setStaticMap(const QStringList &staticMap);
317  [[nodiscard]] QStringList staticMap() const;
318 
332  Q_PROPERTY(QStringList static_map2 READ staticMap2 WRITE setStaticMap2 NOTIFY changed)
333  void setStaticMap2(const QStringList &staticMap);
334  [[nodiscard]] QStringList staticMap2() const;
335 
341  Q_PROPERTY(bool master READ master WRITE setMaster NOTIFY changed)
342  void setMaster(bool enable);
343  [[nodiscard]] bool master() const;
344 
349  Q_PROPERTY(bool auto_reload READ autoReload WRITE setAutoReload NOTIFY changed)
350  void setAutoReload(bool enable);
351  [[nodiscard]] bool autoReload() const;
352 
357  Q_PROPERTY(QStringList touch_reload READ touchReload WRITE setTouchReload NOTIFY changed)
358  void setTouchReload(const QStringList &files);
359  [[nodiscard]] QStringList touchReload() const;
367  Q_PROPERTY(int listen READ listenQueue WRITE setListenQueue NOTIFY changed)
368  void setListenQueue(int size);
369  [[nodiscard]] int listenQueue() const;
370 
375  Q_PROPERTY(int buffer_size READ bufferSize WRITE setBufferSize NOTIFY changed)
376  void setBufferSize(int size);
377  [[nodiscard]] int bufferSize() const;
384  Q_PROPERTY(qint64 post_buffering READ postBuffering WRITE setPostBuffering NOTIFY changed)
385  void setPostBuffering(qint64 size);
386  [[nodiscard]] qint64 postBuffering() const;
387 
392  Q_PROPERTY(qint64 post_buffering_bufsize READ postBufferingBufsize WRITE setPostBufferingBufsize
393  NOTIFY changed)
394  void setPostBufferingBufsize(qint64 size);
395  [[nodiscard]] qint64 postBufferingBufsize() const;
396 
401  Q_PROPERTY(bool tcp_nodelay READ tcpNodelay WRITE setTcpNodelay NOTIFY changed)
402  void setTcpNodelay(bool enable);
403  [[nodiscard]] bool tcpNodelay() const;
404 
409  Q_PROPERTY(bool so_keepalive READ soKeepalive WRITE setSoKeepalive NOTIFY changed)
410  void setSoKeepalive(bool enable);
411  [[nodiscard]] bool soKeepalive() const;
412 
418  Q_PROPERTY(int socket_sndbuf READ socketSndbuf WRITE setSocketSndbuf NOTIFY changed)
419  void setSocketSndbuf(int value);
420  [[nodiscard]] int socketSndbuf() const;
421 
427  Q_PROPERTY(int socket_rcvbuf READ socketRcvbuf WRITE setSocketRcvbuf NOTIFY changed)
428  void setSocketRcvbuf(int value);
429  [[nodiscard]] int socketRcvbuf() const;
430 
435  Q_PROPERTY(
436  int websocket_max_size READ websocketMaxSize WRITE setWebsocketMaxSize NOTIFY changed)
437  void setWebsocketMaxSize(int value);
438  [[nodiscard]] int websocketMaxSize() const;
439 
444  Q_PROPERTY(QString pidfile READ pidfile WRITE setPidfile NOTIFY changed)
445  void setPidfile(const QString &file);
446  [[nodiscard]] QString pidfile() const;
447 
452  Q_PROPERTY(QString pidfile2 READ pidfile2 WRITE setPidfile2 NOTIFY changed)
453  void setPidfile2(const QString &file);
454  [[nodiscard]] QString pidfile2() const;
455 
461  Q_PROPERTY(QString uid READ uid WRITE setUid NOTIFY changed)
462  void setUid(const QString &uid);
463  [[nodiscard]] QString uid() const;
464 
470  Q_PROPERTY(QString gid READ gid WRITE setGid NOTIFY changed)
471  void setGid(const QString &gid);
472  [[nodiscard]] QString gid() const;
473 
479  Q_PROPERTY(bool no_initgroups READ noInitgroups WRITE setNoInitgroups NOTIFY changed)
480  void setNoInitgroups(bool enable);
481  [[nodiscard]] bool noInitgroups() const;
482 
488  Q_PROPERTY(QString chown_socket READ chownSocket WRITE setChownSocket NOTIFY changed)
489  void setChownSocket(const QString &chownSocket);
490  [[nodiscard]] QString chownSocket() const;
491 
497  Q_PROPERTY(QString umask READ umask WRITE setUmask NOTIFY changed)
498  void setUmask(const QString &value);
499  [[nodiscard]] QString umask() const;
500 
506  Q_PROPERTY(int cpu_affinity READ cpuAffinity WRITE setCpuAffinity NOTIFY changed)
507  void setCpuAffinity(int value);
508  [[nodiscard]] int cpuAffinity() const;
509 
515  Q_PROPERTY(bool reuse_port READ reusePort WRITE setReusePort NOTIFY changed)
516  void setReusePort(bool enable);
517  [[nodiscard]] bool reusePort() const;
518 
523  Q_PROPERTY(bool lazy READ lazy WRITE setLazy NOTIFY changed)
524  void setLazy(bool enable);
525  [[nodiscard]] bool lazy() const;
526 
533  Q_PROPERTY(bool using_frontend_proxy READ usingFrontendProxy WRITE setUsingFrontendProxy NOTIFY
534  changed)
535  void setUsingFrontendProxy(bool enable);
536  [[nodiscard]] bool usingFrontendProxy() const;
537 
542  [[nodiscard]] QVariantMap config() const noexcept;
543 
544 Q_SIGNALS:
548  void ready();
549 
553  void stopped();
558  void changed();
559 
563  void errorOccured(const QString &error);
564 
565 protected:
566  ServerPrivate *d_ptr;
567 };
568 
569 } // namespace Cutelyst
Implements a web server.
Definition: server.h:59
The Cutelyst namespace holds all public Cutelyst API.
The Cutelyst application.
Definition: application.h:72