HttpRequestor Gem

You can use the HttpRequestor gem to make asynchronous HTTP/HTTPS requests and return data through a user-provided call back function. This gem uses the EBus for communication and provides all requests asynchronously. For more information, see Working with the Event Bus (EBus) system.

Note
This feature is supported only on Windows and replaces CryAction::HttpRequest.

Topics

• Getting Started
• C++ API Using EBUS_EVENT
• Example

Getting Started

To use the HttpRequestor gem, you must enable it in your project.

To enable the HttpRequestor gem

1. In the Project Configurator, select your project, and then click Enable Gems.

2. In the list of gems, select the check box next to HttpRequestor.

3. Click Save.

4. Enter the following command to build your project.

   lmbr_waf configure
   

C++ API Using EBUS_EVENT

The HttpRequestor gem has separate sets of APIs for adding requests and adding text requests.

AddRequest, AddRequestWithHeaders, AddRequestWithHeadersAndBody

You can use the AddRequest, AddRequestWithHeaders, and AddRequestWithHeadersAndBody APIs to send generic HTTP requests to any website and receive the returned data in JSON format. The methods return the data received in the callback parameter.

Syntax

EBUS_EVENT(HttpRequestor::HttpRequestorRequestBus,AddRequest, URI, method, callback)

EBUS_EVENT(HttpRequestor::HttpRequestorRequestBus, AddRequestWithHeaders, URI, method, headers, callback)

EBUS_EVENT(HttpRequestor::HttpRequestorRequestBus, AddRequestWithHeadersAndBody, URI, method, headers, body, callback)

Each add request method requires the URI, a method and a callback.

Parameters

Return: No return value.

JSON Request Callback

This callback is returned for the AddRequest, AddRequestWithHeaders, and AddRequestWithHeadersAndBody methods.

void Callback(const Aws::Utils::Json::JsonValue& json, Aws::Http::HttpResponseCode responseCode);

Parameters

Return: No return value.

AddTextRequest, AddTextRequestWithHeaders, AddTextRequestWithHeadersAndBody

You can use the AddTextRequest, AddTextRequestWithHeaders, and AddTextRequestWithHeadersAndBody APIs to send a generic HTTP request to any website and receive the returned data in a text string. The methods return the data received in the callback parameter.

Syntax

EBUS_EVENT(HttpRequestor::HttpRequestorRequestBus, AddTextRequest, URI, method, callback)

EBUS_EVENT(HttpRequestor::HttpRequestorRequestBus, AddTextRequestWithHeaders, URI, method, headers, callback)

EBUS_EVENT(HttpRequestor::HttpRequestorRequestBus, AddTextRequestWithHeadersAndBody, URI, method, headers, body, callback)

Each add text request method requires the URI, a method and a callback.

Parameters

Return: No return value.

Text Request Callback

This callback is returned for the AddTextRequest, AddTextRequestWithHeaders, AddTextRequestWithHeadersAndBody methods.

void Callback(const AZStd::string& response, Aws::Http::HttpResponseCode responseCode);

Parameters

Return: No return value.

Example

The following example uses the Metastream C++ API to obtain a gateway IP address.

EBUS_EVENT(HttpRequestor::HttpRequestorRequestBus, AddRequest, "https://httpbin.org/ip", Aws::Http::HttpMethod::HTTP_GET, [this](AXStd::string && data, Aws::Http::HttpResponseCode code)
{
     AZStd::string resultData = std::move(data);
     resultCode = code;

    /* Upon success:
    **  resultCode = Aws::Http::HttpResponceCode::Ok
    **  resultData = "{"origin": "xxx.xxx.xxx.xxx"}"  /* Your IP will be displayed */
    */
 }));