diff options
author | Øystein Heskestad <oystein.heskestad@qt.io> | 2022-03-30 12:22:22 +0200 |
---|---|---|
committer | Øystein Heskestad <oystein.heskestad@qt.io> | 2022-04-23 01:19:09 +0200 |
commit | 6c144d5023c26fa1a7a30ddafa27972266b0bc44 (patch) | |
tree | 04f4dd05a71129582ff0834dc9ca40d31ee65caf /src/sslserver/qsslserver.cpp | |
parent | bfe4011e7077ecf940f8c89dee44c8cea88124b3 (diff) |
Add to module documentation
Task-number: QTBUG-100481
Change-Id: I7f80feb2180c616586138f721fab1cf50ee44cbb
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Diffstat (limited to 'src/sslserver/qsslserver.cpp')
-rw-r--r-- | src/sslserver/qsslserver.cpp | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/src/sslserver/qsslserver.cpp b/src/sslserver/qsslserver.cpp index 45c4826..12f0c68 100644 --- a/src/sslserver/qsslserver.cpp +++ b/src/sslserver/qsslserver.cpp @@ -35,11 +35,30 @@ QT_BEGIN_NAMESPACE Q_LOGGING_CATEGORY(lcSS, "qt.sslserver"); +/*! + \class QSslServer + \inmodule QtHttpServer + \brief Subclass of QTcpServer to accept secure connections. + + API for running a server with Transport Layer Security. Calling \c bind + on a QAbstractHttpServer with an instance of QSslServer turns it into an + HTTPS server. +*/ + +/*! + Creates a QSslServer object with \a parent as the parent object. +*/ QSslServer::QSslServer(QObject *parent): QTcpServer (parent), d(new QSslServerPrivate) { } +/*! + Creates a QSslServer object. + + Its parent object shall be \a parent and it shall use \a sslConfiguration as its + TLS configuration. +*/ QSslServer::QSslServer(const QSslConfiguration &sslConfiguration, QObject *parent): QTcpServer (parent), d(new QSslServerPrivate) @@ -47,8 +66,14 @@ QSslServer::QSslServer(const QSslConfiguration &sslConfiguration, d->sslConfiguration = sslConfiguration; } +/*! + Destroys a QsslServer object. +*/ QSslServer::~QSslServer() = default; +/*! + Handle incoming connection with socket handle \a handle. +*/ void QSslServer::incomingConnection(qintptr handle) { QSslSocket *socket = new QSslSocket(this); @@ -70,6 +95,9 @@ void QSslServer::incomingConnection(qintptr handle) addPendingConnection(socket); } +/*! + Sets the SSL configuration to \a sslConfiguration. +*/ void QSslServer::setSslConfiguration(const QSslConfiguration &sslConfiguration) { d->sslConfiguration = sslConfiguration; |