rc_api_process_ping_response

Parses the response for keeping the game session active.

Syntax

// 11.0+
int rc_api_process_ping_server_response(
    rc_api_ping_response_t* response,
    const rc_api_server_response_t* server_response
);

// [deprecated]
int rc_api_process_ping_response(
    rc_api_ping_response_t* response,
    const char* server_response
);

Parameters

response

The rc_api_ping_response_t to construct.

server_response

The body of the HTTP response received from the server.

---

struct rc_api_ping_response_t
{
  rc_api_response_t response;
};

response

Common server-provided response information. Contains a succeeded flag, and an error_message field.

Return value

If the function succeeds, the return value is RC_OK. Otherwise, the error code can be converted to a string using rc_error_str.

• RC_INVALID_JSON - the response was not valid JSON.
• RC_MISSING_VALUE - one or more required fields was not found in the response.

Remarks

The rc_api_ping_response_t must be destroyed by rc_api_destroy_ping_response when the caller is done with it.

Minimum version: 10.0.0

See also

rc_api_init_ping_request

rc_api_destroy_ping_response