Web3S_Demo > Web 3S Http Request

Web 3S Http Request

Manages an arbitrary HTTP Request. After setting the parameters required by the HTTP Method used, ProcessRequest can be used to pass the request to the HTTP Request Subsystem to register it and send it. When request finishes, regardless of the outcome and response, all delegate bindings will be cleared.

Inheritance Hierarchy

Object

References

Module	Web3S_Http_Runtime
Header	Plugins/Web3S_Plugin/Source/Web3S_Http_Runtime/Public/Http/Web3S_HttpRequest.h
Source	Plugins/Web3S_Plugin/Source/Web3S_Http_Runtime/Private/Http/Web3S_HttpRequest.cpp
Include	Http/Web3S_HttpRequest.h

Functions

Cancel	Cancels the processed Request.
Event InitializePayload	Implementation-defined initializer with custom payload for data.
Generate ID	Pre-Generates a Request ID.
Get URL	The URL this Request will be sent to. Without this it is not possible to process the Request.
GetBody	Body of data sent along with the Request. This might be mandatory depending on the HTTP Method used and server configuration.
GetBytesReceived	Cached amount of currently received bytes.
GetBytesSent	Cached amount of currently sent bytes.
GetFilepath	Get Filepath
GetHeader	Returns the value of the Header associated with given Header Name.
GetHeaders	Headers sent along with the Request. These might be mandatory depending on the HTTP Method used and server configuration.
GetId	The internal ID used by the Request. It shows up in square brackets [] in Log associated with this Request. It can either be Pre-Generated, or generated automatically when the Request is sent.
GetRequestName	The Request Name.
GetRequestSize	Cached amount of bytes in the request body.
GetResponse	Cached Response to this Request. Provides the result of the last finished Request.
GetResponseSize	Cached amount of bytes in the response body. This value will be fetched from a Content-Length header. If no such header is received, it will stay at 0, unless an expected ResponseSize is passed when sending the request.
GetStatus	Current Status of the request. Depending on its value, the Request may refuse to be modified.
GetVerb	The HTTP Method used in the Request. Depending on the value of this field, Headers and Body might be mandatory to provide.
HasHeader	Checks if specified Header is set within the Request.
IsRequestFinished
ProcessRequest	Processes the request. This will process the request to be sent through the HTTP Request Subsystem.
RemoveHeader	Removes a single Header from the Headers Map.
Set URL	Sets the URL.
SetBody	Sets the Body.
SetFilepath	Sets the Filepath.
SetHeader	Sets a single Header.
SetHeaders	Sets the Headers.
SetRequestName	Sets the Request Name.
SetStreamFromFile	Sets the request body source to be a file specified by the Filepath property.
SetVerb	Sets the Verb.