FRequestPayloadInMemory Class Reference

#include <HttpRequestPayload.h>

Inheritance diagram for FRequestPayloadInMemory:

Public Member Functions
	FRequestPayloadInMemory (const TArray< uint8 > &Array)
	FRequestPayloadInMemory (TArray< uint8 > &&Array)
virtual	~FRequestPayloadInMemory ()
virtual uint64	GetContentLength () const override
virtual const TArray< uint8 > &	GetContent () const override
virtual bool	IsURLEncoded () const override
virtual size_t	FillOutputBuffer (void *OutputBuffer, size_t MaxOutputBufferSize, size_t SizeAlreadySent) override
virtual size_t	FillOutputBuffer (TArrayView< uint8 > OutputBuffer, size_t SizeAlreadySent) override
virtual bool	Open () override
virtual void	Close () override
Public Member Functions inherited from FRequestPayload
virtual	~FRequestPayload ()

Constructor & Destructor Documentation

FRequestPayloadInMemory() [1/2]

FRequestPayloadInMemory::FRequestPayloadInMemory

(

const TArray< uint8 > &

Array

)

FRequestPayloadInMemory() [2/2]

FRequestPayloadInMemory::FRequestPayloadInMemory

(

TArray< uint8 > &&

Array

)

~FRequestPayloadInMemory()

FRequestPayloadInMemory::~FRequestPayloadInMemory ( )

virtual

Member Function Documentation

Close()

void FRequestPayloadInMemory::Close ( )

overridevirtual

Close the upload payload when the http request don't need to use it anymore

Implements FRequestPayload.

FillOutputBuffer() [1/2]

size_t FRequestPayloadInMemory::FillOutputBuffer ( TArrayView< uint8 >  OutputBuffer, size_t  SizeAlreadySent  )

overridevirtual

Read part of the underlying request payload into an output buffer.

Parameters

OutputBuffer	- the destination memory address where the payload should be copied
MaxOutputBufferSize	- capacity of OutputBuffer in bytes
SizeAlreadySent	- how much of payload has previously been sent.

Returns

Returns the number of bytes copied into OutputBuffer

Implements FRequestPayload.

FillOutputBuffer() [2/2]

size_t FRequestPayloadInMemory::FillOutputBuffer ( void *  OutputBuffer, size_t  MaxOutputBufferSize, size_t  SizeAlreadySent  )

overridevirtual

Read part of the underlying request payload into an output buffer.

Parameters

OutputBuffer	- the destination memory address where the payload should be copied
MaxOutputBufferSize	- capacity of OutputBuffer in bytes
SizeAlreadySent	- how much of payload has previously been sent.

Returns

Returns the number of bytes copied into OutputBuffer

Implements FRequestPayload.

GetContent()

const TArray< uint8 > & FRequestPayloadInMemory::GetContent ( ) const

overridevirtual

Return a reference to the underlying memory buffer. Only valid for in-memory request payloads

Implements FRequestPayload.

GetContentLength()

uint64 FRequestPayloadInMemory::GetContentLength ( ) const

overridevirtual

Get the total content length of the request payload in bytes

Implements FRequestPayload.

IsURLEncoded()

bool FRequestPayloadInMemory::IsURLEncoded ( ) const

overridevirtual

Check if the request payload is URL encoded. This check is only performed for in-memory request payloads

Implements FRequestPayload.

Open()

bool FRequestPayloadInMemory::Open ( )

overridevirtual

Open the upload payload before start

Implements FRequestPayload.

---

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

• Engine/Source/Runtime/Online/HTTP/Public/GenericPlatform/HttpRequestPayload.h
• Engine/Source/Runtime/Online/HTTP/Private/GenericPlatform/HttpRequestPayload.cpp