QHttpServerWebSocketUpgradeResponse Class
HTTPサーバーでWebSocketのアップグレードを検証するときに返すレスポンス。詳細...
| Header: | #include <QHttpServerWebSocketUpgradeResponse> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS HttpServer)target_link_libraries(mytarget PRIVATE Qt6::HttpServer) |
| qmake: | QT += httpserver |
| Since: | Qt 6.8 |
| Status: | Technical Preview |
パブリック型
| enum class | ResponseType { Accept, Deny, PassToNext } |
パブリック関数
| QHttpServerWebSocketUpgradeResponse(const QHttpServerWebSocketUpgradeResponse &other) | |
| ~QHttpServerWebSocketUpgradeResponse() | |
| QByteArray | denyMessage() && |
| const QByteArray & | denyMessage() const & |
| int | denyStatus() const |
| void | swap(QHttpServerWebSocketUpgradeResponse &other) |
| QHttpServerWebSocketUpgradeResponse::ResponseType | type() const |
| QHttpServerWebSocketUpgradeResponse & | operator=(QHttpServerWebSocketUpgradeResponse &&other) |
| QHttpServerWebSocketUpgradeResponse & | operator=(const QHttpServerWebSocketUpgradeResponse &other) |
静的パブリックメンバ
| QHttpServerWebSocketUpgradeResponse | accept() |
| QHttpServerWebSocketUpgradeResponse | deny() |
| QHttpServerWebSocketUpgradeResponse | deny(int status, QByteArray message) |
| QHttpServerWebSocketUpgradeResponse | passToNext() |
詳細説明
このクラスは、ソケットのアップグレードが成功するかどうかを判断する際に使用する。type() がAccept の場合はソケットをアップグレードし、type() がDeny の場合は与えられたdenyStatus() とdenyMessage() でエラーを送信し、type() がPassToNext の場合は次の登録ハンドラに進む。すべてのハンドラがPassToNext を返すか、1つも存在しない場合、QAbstractHttpServer::missingHandler() が実行される。
QAbstractHttpServer::addWebSocketUpgradeVerifier() およびQAbstractHttpServer::missingHandler()も参照のこと 。
メンバ型ドキュメント
enum class QHttpServerWebSocketUpgradeResponse::ResponseType
レスポンスの型
| 定数 | 値 | 説明 |
|---|---|---|
QHttpServerWebSocketUpgradeResponse::ResponseType::Accept | 0 | WebSocket アップグレード要求を受け入れる |
QHttpServerWebSocketUpgradeResponse::ResponseType::Deny | 1 | WebSocket アップグレード要求を拒否する。 |
QHttpServerWebSocketUpgradeResponse::ResponseType::PassToNext | 2 | もしあれば、WebSocket アップグレードの決定を次の検証者に渡します。 |
QAbstractHttpServer::addWebSocketUpgradeVerifier() およびtype()も参照 。
メンバー関数ドキュメント
QHttpServerWebSocketUpgradeResponse::QHttpServerWebSocketUpgradeResponse(const QHttpServerWebSocketUpgradeResponse &other)
other から QHttpServerWebSocketUpgradeResponse オブジェクトのインスタンスをコピー構築します。
[noexcept] QHttpServerWebSocketUpgradeResponse::~QHttpServerWebSocketUpgradeResponse()
QHttpServerWebSocketUpgradeResponse オブジェクトを破棄します。
[static] QHttpServerWebSocketUpgradeResponse QHttpServerWebSocketUpgradeResponse::accept()
type()Accept を使用してQHttpServerWebSocketUpgradeResponse のインスタンスを作成します。
ResponseType およびtype()も参照してください 。
[static] QHttpServerWebSocketUpgradeResponse QHttpServerWebSocketUpgradeResponse::deny()
type()Deny,denyStatus() 403 およびdenyMessage() "Forbidden" でQHttpServerWebSocketUpgradeResponse のインスタンスを生成する。
ResponseType 、type()、denyStatus()、denyMessage()も参照 。
[static] QHttpServerWebSocketUpgradeResponse QHttpServerWebSocketUpgradeResponse::deny(int status, QByteArray message)
type()Deny 、denyStatus()status 、denyMessage()message 、QHttpServerWebSocketUpgradeResponse のインスタンスを生成する。
ResponseType 、type()、denyStatus()、denyMessage()も参照のこと 。
QByteArray QHttpServerWebSocketUpgradeResponse::denyMessage() &&
type() がDeny の場合に返すエラー・メッセージを返します。
const QByteArray &QHttpServerWebSocketUpgradeResponse::denyMessage() const &
type() がDeny の場合に返すエラー・メッセージを返します。
int QHttpServerWebSocketUpgradeResponse::denyStatus() const
type() がDeny の場合に返す HTTP ステータス・コードを返します。
[static] QHttpServerWebSocketUpgradeResponse QHttpServerWebSocketUpgradeResponse::passToNext()
type()PassToNext でQHttpServerWebSocketUpgradeResponse のインスタンスを作成します。
ResponseType およびtype()も参照 。
[noexcept] void QHttpServerWebSocketUpgradeResponse::swap(QHttpServerWebSocketUpgradeResponse &other)
と入れ替えます。other
QHttpServerWebSocketUpgradeResponse::ResponseType QHttpServerWebSocketUpgradeResponse::type() const
レスポンスの型を返します。
ResponseTypeも参照して ください。
[noexcept] QHttpServerWebSocketUpgradeResponse &QHttpServerWebSocketUpgradeResponse::operator=(QHttpServerWebSocketUpgradeResponse &&other)
Move-other の値をこのオブジェクトに割り当てます。
QHttpServerWebSocketUpgradeResponse &QHttpServerWebSocketUpgradeResponse::operator=(const QHttpServerWebSocketUpgradeResponse &other)
Copy-このオブジェクトにother の値を割り当てます。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
