QHttpServerRouter Class

Dokumentation zur Mitgliedsfunktion

QHttpServerRouter::QHttpServerRouter(QAbstractHttpServer *server)

Erstellt ein QHttpServerRouter-Objekt mit Standardkonvertern.

Siehe auch „ converters “.

[noexcept] QHttpServerRouter::~QHttpServerRouter()

Löscht ein ` QHttpServerRouter`.

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

Fügt einen neuen Konverter für den Typ „Type“ hinzu, der mit „ regexp “ geparst werden kann, und gibt bei Erfolg „ true “ zurück, andernfalls „ false “. Bei Erfolg kann der registrierte Typ als Argument in Handlern für „ QHttpServerRouterRule “ verwendet werden. Der reguläre Ausdruck wird zum Parsen des Pfadmusters der Regel verwendet.

Falls bereits ein Konverter vom Typ `Type` vorhanden ist, wird dessen regulärer Ausdruck durch ` regexp` ersetzt.

Benutzerdefinierte Konverter können die verfügbaren Typkonvertierungen über das „ QMetaType “-System erweitern.

Definieren Sie eine Klasse mit einem „ QString “-Konstruktor:

struct CustomArg {
    int data = 10;

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

Um einen benutzerdefinierten Typ mit dem „ HTTP server “ zu verwenden, registrieren Sie ihn mithilfe dieser Funktion und definieren Sie einen „ route “-Handler unter Verwendung des neuen Typs:

server.router()->addConverter<CustomArg>(u"[+-]?\\d+");
server.route("/customTest/<arg>", [] (const CustomArg custom) { return QString::number(custom.data); });

Siehe auch „ converters “ und „ clearConverters “.

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

Fügt einen neuen Konverter für metaType hinzu, der mit regexp geparst werden kann. Ein Konverter für metaType ermöglicht die Verwendung dieses Typs in einem Pfadmuster eines QHttpServerRouterRule. Der reguläre Ausdruck wird verwendet, um Parameter vom Typ metaType aus dem Pfadmuster zu parsen.

Falls bereits ein Konverter vom Typ metaType vorhanden ist, wird dessen regulärer Ausdruck durch regexp ersetzt.

Siehe auch „ converters “ und „ clearConverters “.

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

Fügt dem Router eine neue „ rule “ hinzu.

Gibt bei Erfolg einen Zeiger auf die neue Regel zurück; andernfalls wird ` nullptr` zurückgegeben.

Innerhalb von `addRule` ermitteln wir die `ViewHandler`-Argumente und generieren eine Liste ihrer ` QMetaType::Type `-IDs. Anschließend analysieren wir den Pfad und ersetzen jedes ` "<arg>" ` durch einen regulären Ausdruck für den entsprechenden Typ aus der Liste.

Der übergebene ` rule ` darf die ` QHttpServerRouter `-Instanz nicht verändern.

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()

Entfernt alle Konverter.

Siehe auch converters und addConverter.

Gibt ein Map mit Konvertertypen und regulären Ausdrücken zurück, die bei diesem „ QHttpServerRouter “ registriert sind. Dies sind die Typen, die in Pfadmustern von „ QHttpServerRouterRules “ verwendet werden können.

Die folgenden Konverter sind standardmäßig verfügbar:

Siehe auch addConverter und clearConverters.

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

Behandelt jede neue „ request “ für den HTTP-Server mithilfe von „ responder “.

Durchläuft die Liste der Regeln, um die erste passende Regel zu finden, führt diese Regel aus und gibt „ true “ zurück. Gibt „ false “ zurück, wenn keine Regel mit der Anfrage übereinstimmt.

void QHttpServerRouter::removeConverter(QMetaType metaType)

Entfernt den Konverter für den Typ „ metaType “.

Siehe auch „ addConverter “.