FHttpServerModule Class Reference

#include <HttpServerModule.h>

Inheritance diagram for FHttpServerModule:

Public Member Functions
	FHttpServerModule ()
	~FHttpServerModule ()
HTTPSERVER_API TSharedPtr< IHttpRouter >	GetHttpRouter (uint32 Port, bool bFailOnBindFailure=false)
bool	Tick (float DeltaTime) override
HTTPSERVER_API void	StartAllListeners ()
HTTPSERVER_API void	StopAllListeners ()
HTTPSERVER_API bool	HasPendingListeners () const
virtual void	StartupModule () override
virtual void	ShutdownModule () override
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual bool	SupportsDynamicReloading ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const
Public Member Functions inherited from FTSTickerObjectBase
	UE_NONCOPYABLE (FTSTickerObjectBase)
CORE_API	FTSTickerObjectBase (float InDelay=0.0f, FTSTicker &Ticker=FTSTicker::GetCoreTicker())
virtual CORE_API	~FTSTickerObjectBase ()

Static Public Member Functions
static HTTPSERVER_API bool	IsAvailable ()
static HTTPSERVER_API FHttpServerModule &	Get ()

Detailed Description

Module for HtttpServer Implementation

Constructor & Destructor Documentation

FHttpServerModule()

FHttpServerModule::FHttpServerModule

(

)

~FHttpServerModule()

FHttpServerModule::~FHttpServerModule

(

)

Member Function Documentation

Get()

FHttpServerModule & FHttpServerModule::Get ( )

static

Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Returns

Returns singleton instance, loading the module on demand if needed

GetHttpRouter()

TSharedPtr< IHttpRouter > FHttpServerModule::GetHttpRouter	(	uint32	Port,
		bool	bFailOnBindFailure = false
	)

Per-port-binding access to an http router

Parameters

Port	The listener's bound port
bFailOnBindFailure	if true, return nullptr if we fail to bind/listen on the given port

Returns

An IHttpRouter instance that can be leveraged to respond to HTTP requests

HasPendingListeners()

bool FHttpServerModule::HasPendingListeners

(

)

const

Determines if any listeners are pending operations

Returns

true if there are pending listeners, false otherwise

IsAvailable()

bool FHttpServerModule::IsAvailable ( )

static

Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.

Returns

True if the module is loaded and ready to use

ShutdownModule()

void FHttpServerModule::ShutdownModule ( )

overridevirtual

Called when voice module is unloaded Shutdown platform specific parts of template handling

Reimplemented from IModuleInterface.

StartAllListeners()

void FHttpServerModule::StartAllListeners

(

)

Starts all listeners

StartupModule()

void FHttpServerModule::StartupModule ( )

overridevirtual

Called when voice module is loaded Initialize platform specific parts of template handling

Reimplemented from IModuleInterface.

StopAllListeners()

void FHttpServerModule::StopAllListeners

(

)

Stops all listeners

Tick()

bool FHttpServerModule::Tick ( float  DeltaTime )

overridevirtual

FTSTicker callback

Parameters

DeltaTime

The time in seconds since the last tick

Returns

false if no longer needs ticking, true otherwise

Implements FTSTickerObjectBase.

---

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

• Engine/Source/Runtime/Online/HTTPServer/Public/HttpServerModule.h
• Engine/Source/Runtime/Online/HTTPServer/Private/HttpServerModule.cpp