UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FHttpConnectionRequestReadContext Struct Referencefinal

#include <HttpConnectionRequestReadContext.h>

+ Inheritance diagram for FHttpConnectionRequestReadContext:

Public Member Functions

 FHttpConnectionRequestReadContext (FSocket *InSocket)
 
EHttpConnectionContextState ReadStream (float DeltaTime)
 
FORCEINLINE TSharedPtr< FHttpServerRequest > GetRequest () const
 
void ResetContext ()
 
float GetSecondsWaitingForReadableSocket () const
 
void AddSecondsWaitingForReadableSocket (float Seconds)
 
void ResetSecondsWaitingForReadableSocket ()
 
- Public Member Functions inherited from FHttpConnectionContext
void AddElapsedIdleTime (float DeltaTime)
 
FORCEINLINE float GetElapsedIdleTime () const
 
FORCEINLINE EHttpServerResponseCodes GetErrorCode () const
 
FORCEINLINE const FString & GetErrorStr () const
 

Additional Inherited Members

- Protected Member Functions inherited from FHttpConnectionContext
 FHttpConnectionContext ()
 
virtual ~FHttpConnectionContext ()
 
void AddError (const FString &ErrorCodeStr, EHttpServerResponseCodes ErrorCode=EHttpServerResponseCodes::Unknown)
 
- Protected Attributes inherited from FHttpConnectionContext
float ElapsedIdleTime = 0.0f
 
EHttpServerResponseCodes ErrorCode = EHttpServerResponseCodes::Unknown
 
FStringOutputDevice ErrorBuilder
 

Constructor & Destructor Documentation

◆ FHttpConnectionRequestReadContext()

FHttpConnectionRequestReadContext::FHttpConnectionRequestReadContext ( FSocket *  InSocket)

Constructor

Parameters
SocketThe underlying connection

Member Function Documentation

◆ AddSecondsWaitingForReadableSocket()

void FHttpConnectionRequestReadContext::AddSecondsWaitingForReadableSocket ( float  Seconds)
inline

Add time (in seconds) spent waiting for the socket to be readable.

◆ GetRequest()

FORCEINLINE TSharedPtr< FHttpServerRequest > FHttpConnectionRequestReadContext::GetRequest ( ) const
inline

Gets the internally stored request object

◆ GetSecondsWaitingForReadableSocket()

float FHttpConnectionRequestReadContext::GetSecondsWaitingForReadableSocket ( ) const
inline

Get the time in seconds spent waiting for the socket to be readable.

◆ ReadStream()

EHttpConnectionContextState FHttpConnectionRequestReadContext::ReadStream ( float  DeltaTime)

Reads a request from the connection

Parameters
DeltaTimeThe elapsed time since the last invocation
Returns
The state of the read context

◆ ResetContext()

void FHttpConnectionRequestReadContext::ResetContext ( )

Resets the internal state. Should be called for every read.

◆ ResetSecondsWaitingForReadableSocket()

void FHttpConnectionRequestReadContext::ResetSecondsWaitingForReadableSocket ( )
inline

Reset the time spent waiting for the socket to be readable.

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