UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FHttpRequestHandlerRegistrar Class Reference

#include <HttpRequestHandlerRegistrar.h>

Public Member Functions

void AddRoute (const FHttpRouteHandle &Handle)
 
void RemoveRoute (const FHttpRouteHandle &Handle)
 
bool ContainsRoute (const FHttpPath &RoutePath, EHttpServerRequestVerbs Verb)
 
FRouteQueryResult QueryRoute (const FString &Query, EHttpServerRequestVerbs Verb, const TArray< FString > *Parsedtokens=nullptr) const
 

Detailed Description

FHttpRequestHandlerRegistrar Represents the associative relationship between Http request paths and respective route handles

Member Function Documentation

◆ AddRoute()

void FHttpRequestHandlerRegistrar::AddRoute ( const FHttpRouteHandle Handle)

Add a route to the registrar.

Parameters
HandleThe new route's handle.

◆ ContainsRoute()

bool FHttpRequestHandlerRegistrar::ContainsRoute ( const FHttpPath RoutePath,
EHttpServerRequestVerbs  Verb 
)

Check if the registrar contains a route.

Parameters
RoutePaththe HttpPath of the target route.
Verbthe verb associated with the target route.
Returns
Whether the route was found.

◆ QueryRoute()

FRouteQueryResult FHttpRequestHandlerRegistrar::QueryRoute ( const FString &  Query,
EHttpServerRequestVerbs  Verb,
const TArray< FString > *  Parsedtokens = nullptr 
) const

Query the registrar for a route, parsing the path parameters if any.

Parameters
Querythe path to search for in the registry.
Verbthe handler's verb to look for. (A route might have multiple handlers each with a different verb.)
ParsedTokensAn optional list of tokens that were removed from the end of the path.
Returns
The query's result, indicating if a match was found and parsed path parameters.

◆ RemoveRoute()

void FHttpRequestHandlerRegistrar::RemoveRoute ( const FHttpRouteHandle Handle)

Remove a route from the registrar.

Parameters
HandleThe handle of the route to delete.

The documentation for this class was generated from the following files: