UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FHttpListener Class Referencefinal

#include <HttpListener.h>

Public Member Functions

 FHttpListener (uint32 InListenPort)
 
 ~FHttpListener ()
 
bool StartListening ()
 
void StopListening ()
 
void Tick (float DeltaTime)
 
bool HasPendingConnections () const
 
FORCEINLINE bool IsListening () const
 
FORCEINLINE TSharedPtr< IHttpRouterGetRouter () const
 

Constructor & Destructor Documentation

◆ FHttpListener()

FHttpListener::FHttpListener ( uint32  InListenPort)

Constructor

Parameters
InListenPortThe port on which to listen for incoming connections

◆ ~FHttpListener()

FHttpListener::~FHttpListener ( )

Destructor

Member Function Documentation

◆ GetRouter()

FORCEINLINE TSharedPtr< IHttpRouter > FHttpListener::GetRouter ( ) const
inline

Gets the respective router

Returns
The respective router

◆ HasPendingConnections()

bool FHttpListener::HasPendingConnections ( ) const

Determines whether this listener has pending connections in-flight

Returns
true if there are pending connections, false otherwise

◆ IsListening()

FORCEINLINE bool FHttpListener::IsListening ( ) const
inline

Determines whether the listener has been initialized

Returns
true if this listener is bound and listening, false otherwise

◆ StartListening()

bool FHttpListener::StartListening ( )

Starts listening for and accepting incoming connections

Returns
true if the listener was able to start listening, false otherwise

◆ StopListening()

void FHttpListener::StopListening ( )

Stops listening for and accepting incoming connections

◆ Tick()

void FHttpListener::Tick ( float  DeltaTime)

Tick the listener to otherwise commence connection flows

Parameters
DeltaTimeThe elapsed time since the last tick

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