FHttpRequestAdapterBase

Inheritance Hierarchy

Syntax

class FHttpRequestAdapterBase : public FHttpRequestImpl

Remarks

Adapter class for IHttpRequest abstract interface does not fully expose the wrapped interface in the base. This allows client defined marshalling of the requests when end point permissions are at issue.

Variables

Name Description

Protected variable

TSharedRef < IHt ...

 

HttpRequest

Constructors

Name Description

Public function

FHttpRequestAdapterBase

(
    const TSharedRef < IHttpRequest >& ...
)

Overridden from IHttpRequest

Name Description

Public function Virtual

void

 

AppendToHeader

(
    const FString & HeaderName,
    const FString & AdditionalHeaderVal...
)

Appends to the value already set in the header.

Public function Virtual Const

float

 

GetElapsedTime()

Gets the time that it took for the server to fully respond to the request.

Public function Virtual Const

const FHttpR ...

 

GetResponse()

Get the associated Response

Public function Virtual Const

EHttpRequest ...

 

GetStatus()

Get the current status of the request being processed

Public function Virtual Const

FString

 

GetVerb()

Gets the verb (GET, PUT, POST) used by the request.

Public function Virtual

void

 

SetContent

(
    const TArray < uint8 >& ContentPayl...
)

Sets the content of the request (optional data). Usually only set for POST requests.

Public function Virtual

bool

 

SetContentAsStreamedFile

(
    const FString & Filename
)

Sets the content of the request to stream from a file.

Public function Virtual

void

 

SetContentAsString

(
    const FString & ContentString
)

Sets the content of the request as a string encoded as UTF8.

Public function Virtual

bool

 

SetContentFromStream

(
    TSharedRef < FArchive , ESPMode::Thre ...
)

Sets the content of the request to stream directly from an archive.

Public function Virtual

void

 

SetHeader

(
    const FString & HeaderName,
    const FString & HeaderValue
)

Sets optional header info.

Public function Virtual

void

 

SetURL

(
    const FString & URL
)

Sets the URL for the request Eg.

Public function Virtual

void

 

SetVerb

(
    const FString & Verb
)

Sets the verb used by the request.

Public function Virtual

void

 

Tick

(
    float DeltaSeconds
)

Used to tick the request

Overridden from IHttpBase

Name Description

Public function Virtual Const

TArray < FStr ...

 

GetAllHeaders()

Return all headers in an array in "Name: Value" format.

Public function Virtual Const

const TArray ...

 

GetContent()

Get the content payload of the request or response.

Public function Virtual Const

int32

 

GetContentLength()

Shortcut to get the Content-Length header value.

Public function Virtual Const

FString

 

GetContentType()

Shortcut to get the Content-Type header value (if available)

Public function Virtual Const

FString

 

GetHeader

(
    const FString & HeaderName
)

Gets the value of a header, or empty string if not found.

Public function Virtual Const

FString

 

GetURL()

Get the URL used to send the request.

Public function Virtual Const

FString

 

GetURLParameter

(
    const FString & ParameterName
)

Gets an URL parameter.

References

Module

HTTP

Header

Runtime/Online/HTTP/Public/HttpRequestAdapter.h