QHttpServerRouter Class

メンバ関数ドキュメント

このQHttpServerRouter に登録されているコンバータ型と正規表現のマップを返します。これらはQHttpServerRouterRules のパスパターンで使用できる型です。

デフォルトでは以下のコンバータが使用可能です：

addConverter およびclearConvertersも参照して ください。

QHttpServerRouter::QHttpServerRouter(QAbstractHttpServer *server)

デフォルトのコンバータを持つ QHttpServerRouter オブジェクトを作成します。

converters も参照して ください。

[noexcept] QHttpServerRouter::~QHttpServerRouter()

QHttpServerRouter を破棄します。

template <typename Type> bool QHttpServerRouter::addConverter(QAnyStringView regexp)

regexp で解析できるTypeの新しいコンバータを追加し、成功した場合はtrue を返し、失敗した場合はfalse を返します。成功した場合、登録された型はQHttpServerRouterRule のハンドラの引数として使用できる。正規表現は、ルールのパスパターンを解析するために使用される。

Type型のコンバーターがすでに存在する場合、そのコンバーターの正規表現はregexp に置き換えられる。

最小の例：

struct CustomArg {
    int data = 10;

    CustomArg() {} ;
    CustomArg(const QString &urlArg) : data(urlArg.toInt()) {}
};
Q_DECLARE_METATYPE(CustomArg);

QHttpServerRouter router;
router.addConverter<CustomArg>(u"[+-]?\\d+"));

auto pageView = [] (const CustomArg &customArg) {
    qDebug("data: %d", customArg.data);
};
using ViewHandler = decltype(pageView);

auto rule = std::make_unique<QHttpServerRouterRule>(
    "/<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));

void QHttpServerRouter::addConverter(QMetaType metaType, QAnyStringView regexp)

regexp でパースできるmetaType の新しいコンバータを追加します。metaType のコンバータを持つことで、この型をQHttpServerRouterRule のパスパターンで使用できるようになります。 正規表現は、パスパターンからmetaType 型のパラメータをパースするために使用されます。

すでにmetaType 型のコンバーターがある場合、そのコンバーターの正規表現はregexp に置き換えられます。

converters およびclearConvertersも参照してください 。

template <typename ViewHandler, typename ViewTraits = QHttpServerRouterViewTraits<ViewHandler>> QHttpServerRouterRule *QHttpServerRouter::addRule(std::unique_ptr<QHttpServerRouterRule> rule)

新しいrule をルータに追加します。

成功した場合は新しいルールへのポインタを返し、失敗した場合はnullptr を返す。

addRuleの内部で、ViewHandlerの引数を決定し、それらのQMetaType::Type IDのリストを生成します。次に、URLを解析し、<arg> を、リストからそのタイプに対応する正規表現で置き換えます。rule はQHttpServerRouter インスタンスを変更してはならない。

QHttpServerRouter router;

using ViewHandler = decltype([] (const QString &page, const quint32 num) { });

auto rule = std::make_unique<QHttpServerRouterRule>(
    "/<arg>/<arg>/log",
    [] (QRegularExpressionMatch &match,
        const QHttpServerRequest &request,
        QHttpServerResponder &&responder) {
});

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

void QHttpServerRouter::clearConverters()

すべてのコンバーターを削除する。

converters およびaddConverterも参照してください 。

bool QHttpServerRouter::handleRequest(const QHttpServerRequest &request, QHttpServerResponder &responder) const

responder を使用して、HTTP サーバの新しいrequest をそれぞれ処理します。

ルールのリストを繰り返し、最初にマッチするルールを見つけ、そのルールを実行してtrue を返す。リクエストにマッチするルールがない場合はfalse を返す。

void QHttpServerRouter::removeConverter(QMetaType metaType)

metaType 型のコンバータを削除します。

addConverterも参照してください 。