IHttpRequest

Interface for Http requests (created using FHttpFactory)

Windows
MacOS
Linux

Inheritance Hierarchy

Syntax

class IHttpRequest :
    public IHttpBase,
    public TSharedFromThis< IHttpRequest >

Remarks

Interface for Http requests (created using FHttpFactory)

Destructors

Name Description

Public function Virtual

~IHttpRequest()

Destructor for overrides

Functions

Name Description

Public function

void

 

AppendToHeader

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

Appends to the value already set in the header.

Public function

void

 

CancelRequest()

Called to cancel a request that is still being processed

Public function Const

float

 

GetElapsedTime()

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

Public function Const

const FHttpR...

 

GetResponse()

Get the associated Response

Public function Const

EHttpRequest...

 

GetStatus()

Get the current status of the request being processed

Public function Const

FString

 

GetVerb()

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

Public function

FHttpRequest...

 

OnHeaderReceived()

Delegate called to signal the receipt of a header. See FHttpRequestHeaderReceivedDelegate

Public function

FHttpRequest...

 

OnProcessRequestComplete()

Delegate called when the request is complete. See FHttpRequestCompleteDelegate

Public function

FHttpRequest...

 

OnRequestProgress()

Delegate called to update the request/response progress. See FHttpRequestProgressDelegate

Public function

bool

 

ProcessRequest()

Called to begin processing the request.

Public function

void

 

SetContent

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

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

Public function

bool

 

SetContentAsStreamedFile

(
    const FString& Filename
)

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

Public function

void

 

SetContentAsString

(
    const FString& ContentString
)

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

Public function

bool

 

SetContentFromStream

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

Public function

void

 

SetHeader

(
    const FString& HeaderName,
    const FString& HeaderValue
)

Sets optional header info.

Public function

void

 

SetURL

(
    const FString& URL
)

Sets the URL for the request Eg.

Public function

void

 

SetVerb

(
    const FString& Verb
)

Sets the verb used by the request.

Public function

void

 

Tick

(
    float DeltaSeconds
)

Used to tick the request

References

Module

HTTP

Header

Runtime/Online/HTTP/Public/Interfaces/IHttpRequest.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback