FRequestPayload Class Reference

#include <HttpRequestPayload.h>

Inheritance diagram for FRequestPayload:

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

Detailed Description

Abstraction that encapsulates the location of a request payload

Constructor & Destructor Documentation

~FRequestPayload()

virtual FRequestPayload::~FRequestPayload ( )

inlinevirtual

Member Function Documentation

Close()

virtual void FRequestPayload::Close ( )

pure virtual

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

Implemented in FRequestPayloadInFileStream, and FRequestPayloadInMemory.

FillOutputBuffer() [1/2]

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

pure virtual

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

Implemented in FRequestPayloadInFileStream, and FRequestPayloadInMemory.

FillOutputBuffer() [2/2]

virtual size_t FRequestPayload::FillOutputBuffer ( void *  OutputBuffer, size_t  MaxOutputBufferSize, size_t  SizeAlreadySent  )

pure virtual

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

Implemented in FRequestPayloadInFileStream, and FRequestPayloadInMemory.

GetContent()

virtual const TArray< uint8 > & FRequestPayload::GetContent ( ) const

pure virtual

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

Implemented in FRequestPayloadInFileStream, and FRequestPayloadInMemory.

GetContentLength()

virtual uint64 FRequestPayload::GetContentLength ( ) const

pure virtual

Get the total content length of the request payload in bytes

Implemented in FRequestPayloadInFileStream, and FRequestPayloadInMemory.

IsURLEncoded()

virtual bool FRequestPayload::IsURLEncoded ( ) const

pure virtual

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

Implemented in FRequestPayloadInFileStream, and FRequestPayloadInMemory.

Open()

virtual bool FRequestPayload::Open ( )

pure virtual

Open the upload payload before start

Implemented in FRequestPayloadInFileStream, and FRequestPayloadInMemory.

---

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

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