QHttpServerRouterRule Class

メンバ関数ドキュメント

template <typename Functor> QHttpServerRouterRule::QHttpServerRouterRule(const QString &pathPattern, const QHttpServerRequest::Methods methods, const QObject *receiver, Functor &&slot)

pathPattern,methods のルールを構築し、それをreceiver とslot に接続する。slot は、関数ポインタ、ミュータブルでないラムダ、または const call 演算子を持つその他のコピー可能な呼び出し可能関数にすることもできます。その場合、receiver はコンテキストオブジェクトとなる。ハンドラは、受信オブジェクトが破棄されるまで有効である。

このルールは、利用可能な HTTP メソッドの任意の組み合わせを受け入れます。

QHttpServerRequest::Methodsも参照 。

template <typename Functor> QHttpServerRouterRule::QHttpServerRouterRule(const QString &pathPattern, const QObject *receiver, Functor &&slot)

これはオーバーロードされた関数です。

pathPattern 、QHttpServerRequest::Method::AnyKnown のルールを構築し、receiver 、slot に接続します。slot は、関数ポインタ、ミュータブルでないラムダ、または const call 演算子を持つその他のコピー可能な呼び出し可能関数にすることもできます。その場合、receiver はコンテキストオブジェクトとなる。ハンドラは、レシーバーオブジェクトが破棄されるまで有効です。

[virtual noexcept] QHttpServerRouterRule::~QHttpServerRouterRule()

QHttpServerRouterRule を破棄する。

[static] template <typename Functor, typename ViewTraits = QHttpServerRouterViewTraits<Functor>> typename ViewTraits::BindableType QHttpServerRouterRule::bindCaptured(QObject *receiver, Functor &&slot, const QRegularExpressionMatch &match)

receiver 、slot に URL から派生した引数を与えます。ハンドラが取る可能性のある残りの引数をすべて受け入れ、URL由来の値の後のスロットにそれらを供給するバウンド関数を返します。URLに(文字列として)適用された正規表現の各マッチは、match として渡せるように、その位置でハンドラのパラメータのタイプに変換される。

QHttpServerRouter router;

auto pageView = [] (const QString &page, const quint32 num) {
    qDebug("page: %s, num: %d", qPrintable(page), num);
};
using ViewHandler = decltype(pageView);

auto rule = std::make_unique<QHttpServerRouterRule>(
    "/<arg>/<arg>/log",
    [&router, &pageView] (QRegularExpressionMatch &match,
                          const QHttpServerRequest &request,
                          QHttpServerResponder &&responder) {
    // Bind and call viewHandler with match's captured string and quint32:
    QHttpServerRouterRule::bindCaptured(pageView, match)();
});

router.addRule<ViewHandler>(std::move(rule));

const QObject *QHttpServerRouterRule::contextObject() const

このルールのコンテキストオブジェクトを返します。これは、リクエストを処理するレシーバーである。

[protected] bool QHttpServerRouterRule::exec(const QHttpServerRequest &request, QHttpServerResponder &responder) const

与えられたrequest に対してこのルールを実行する。

この関数は、QHttpServerRouter が新しいリクエストを受信したときに呼び出される。与えられたrequest がこのルールにマッチする場合、この関数は与えられたresponder に応答を配送することでリクエストを処理し、その後true を返す。そうでない場合、false を返す。

[protected] bool QHttpServerRouterRule::hasValidMethods() const

メソッドが有効な場合はtrue を返す

[virtual protected] bool QHttpServerRouterRule::matches(const QHttpServerRequest &request, QRegularExpressionMatch *match) const

与えられたrequest がこのルールにマッチするかどうかを判定する。

この仮想関数はexec() から呼び出され、request がこのルールにマッチするかどうかを調べる。マッチした場合、match が指すオブジェクト（nullptr であってはならない）に格納され、この関数はtrue を返す。それ以外の場合は、false を返します。