QHttpServerRouterRule Class

Member Function Documentation

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

Creates a routing rule for pathPattern and methods, connecting it to the specified receiver and slot.

• The slot can be a function pointer, non-mutable lambda, or any other copyable callable with const call operator.
• If slot is callable, receiver acts as its context object.
• The handler remains valid until the receiver is destroyed.

The rule can handle any combination of available HTTP methods.

See also QHttpServerRequest::Methods.

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

This overload constructs a routing rule for pathPattern and associates it with receiver and slot.

• It defaults to QHttpServerRequest::Method::AnyKnown, meaning it will match any recognized HTTP method.
• The slot can be a function pointer, non-mutable lambda, or any other copyable callable with const call operator.
• If slot is callable, receiver acts as its context object.
• The handler remains valid until the receiver is destroyed.

[virtual noexcept] QHttpServerRouterRule::~QHttpServerRouterRule()

Destroys a QHttpServerRouterRule.

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

Binds the given receiver and slot with arguments extracted from the URL. The function returns a bound callable that takes any remaining arguments required by the handler, supplying them to slot after the URL-derived values.

Each captured value from the URL (as a string) is converted to the corresponding parameter type in the handler based on its position, ensuring it can be passed as 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

Retrieves the context object associated with this rule. This object serves as the receiver responsible for handling the request.

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

Executes the rule. Processes the given request by checking if it matches this rule.

• This function is called by QHttpServerRouter when a new request is received.
• If the request matches the rule, it handles the request by sending a response through the provided responder and returns true.
• If there is no match, it returns false.

[protected] bool QHttpServerRouterRule::hasValidMethods() const

Validates the Request Method. Returns true if the specified HTTP method is valid.

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

Determines whether the provided request meets the conditions of this rule.

• This virtual function is called by exec() to evaluate the request.
• If the request matches, the details are stored in match (which must not be nullptr), and the function returns true.
• Otherwise, it returns false.