UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | List of all members
IHttpRouter Class Referenceabstract

#include <IHttpRouter.h>

+ Inheritance diagram for IHttpRouter:

Public Member Functions

virtual bool Query (const TSharedPtr< FHttpServerRequest > &Request, const FHttpResultCallback &OnProcessingComplete)=0
 
virtual FHttpRouteHandle BindRoute (const FHttpPath &HttpPath, const EHttpServerRequestVerbs &HttpVerbs, const FHttpRequestHandler &Handler)=0
 
virtual void UnbindRoute (const FHttpRouteHandle &RouteHandle)=0
 
virtual FDelegateHandle RegisterRequestPreprocessor (FHttpRequestHandler RequestPreprocessor)=0
 
virtual void UnregisterRequestPreprocessor (const FDelegateHandle &RequestPreprocessorHandle)=0
 
- Public Member Functions inherited from TSharedFromThis< IHttpRouter >
TSharedRef< IHttpRouter, Mode > AsShared ()
 
TSharedRef< IHttpRouter const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< IHttpRouter, Mode > AsWeak ()
 
TWeakPtr< IHttpRouter const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Member Functions

virtual ~IHttpRouter ()
 
- Protected Member Functions inherited from TSharedFromThis< IHttpRouter >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Additional Inherited Members

- Static Protected Member Functions inherited from TSharedFromThis< IHttpRouter >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Constructor & Destructor Documentation

◆ ~IHttpRouter()

IHttpRouter::~IHttpRouter ( )
protectedvirtual

Destructor

Member Function Documentation

◆ BindRoute()

virtual FHttpRouteHandle IHttpRouter::BindRoute ( const FHttpPath &  HttpPath,
const EHttpServerRequestVerbs &  HttpVerbs,
const FHttpRequestHandler &  Handler 
)
pure virtual

Binds the caller-supplied Uri to the caller-supplied handler

Parameters
HttpPathThe respective http path to bind
HttpVerbsThe respective HTTP verbs to bind
HandlerThe caller-defined closure to execute when the binding is invoked
Returns
An FHttpRouteHandle on success, nullptr otherwise.

Implemented in FHttpRouter.

◆ Query()

virtual bool IHttpRouter::Query ( const TSharedPtr< FHttpServerRequest > &  Request,
const FHttpResultCallback &  OnProcessingComplete 
)
pure virtual

Query the router with a request.

Parameters
Requestthe request to route.
OnCompletethe callback called when
Returns
An FHttpRouteHandle on success, nullptr otherwise.

Implemented in FHttpRouter.

◆ RegisterRequestPreprocessor()

virtual FDelegateHandle IHttpRouter::RegisterRequestPreprocessor ( FHttpRequestHandler  RequestPreprocessor)
pure virtual

Register a request preprocessor. Useful for cases where you want to drop or handle incoming requests before they are dispatched to their respective handler.

Parameters
RequestPreprocessorThe function called to process the incoming request.
Returns
FDelegateHandle The handle to the delegate, used for unregistering preprocessors.

Implemented in FHttpRouter.

◆ UnbindRoute()

virtual void IHttpRouter::UnbindRoute ( const FHttpRouteHandle &  RouteHandle)
pure virtual

Unbinds the caller-supplied Route

Parameters
RouteHandleThe handle to the route to unbind (callers must retain from BindRoute)

Implemented in FHttpRouter.

◆ UnregisterRequestPreprocessor()

virtual void IHttpRouter::UnregisterRequestPreprocessor ( const FDelegateHandle &  RequestPreprocessorHandle)
pure virtual

Unregister a request preprocessor.

Parameters
RequestPreprocessorHandleThe handle to the preprocessor delegate to unregister.

Implemented in FHttpRouter.

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