ApiClient.hpp

This File On Github
Ask A Question

API: latest
module: oatpp
#include "oatpp/web/client/ApiClient.hpp"

ApiClient

ApiClient class provides convenient Retrofit-like interface over the oatpp::web::client::RequestExecutor.

namespace oatpp { namespace web { namespace client { 
  class ApiClient : public oatpp::base::Countable {}
}}}

Typedefs

Type Name Summary
oatpp::web::protocol::http::Status Status Convenience typedef for oatpp::web::protocol::http::Status.
oatpp::web::protocol::http::Header Header Convenience typedef for oatpp::web::protocol::http::Header.
oatpp::data::mapping::type::String String Convenience typedef for oatpp::data::mapping::type::String.
oatpp::data::mapping::type::Int32 Int32 Convenience typedef for oatpp::data::mapping::type::Int32.
oatpp::data::mapping::type::Int64 Int64 Convenience typedef for oatpp::data::mapping::type::Int64.
oatpp::data::mapping::type::Float32 Float32 Convenience typedef for oatpp::data::mapping::type::Float32.
oatpp::data::mapping::type::Float64 Float64 Convenience typedef for oatpp::data::mapping::type::Float64.
oatpp::data::mapping::type::Boolean Boolean Convenience typedef for oatpp::data::mapping::type::Boolean.
oatpp::web::protocol::http::incoming::Response Response Convenience typedef for oatpp::web::protocol::http::incoming::Response.
RequestExecutor::AsyncCallback AsyncCallback Convenience typedef for oatpp::web::client::RequestExecutor::AsyncCallback.

Methods

Return Type Name Summary
std::shared_ptr<RequestExecutor::ConnectionHandle> getConnection Call oatpp::web::client::RequestExecutor::getConnection().
oatpp::async::CoroutineStarterForResult<const std::shared_ptr<RequestExecutor::ConnectionHandle>&> getConnectionAsync Call oatpp::web::client::RequestExecutor::getConnectionAsync().

ApiClient::Status

Convenience typedef for oatpp::web::protocol::http::Status.

typedef oatpp::web::protocol::http::Status Status

ApiClient::Header

Convenience typedef for oatpp::web::protocol::http::Header.

typedef oatpp::web::protocol::http::Header Header

ApiClient::String

Convenience typedef for oatpp::data::mapping::type::String.

typedef oatpp::data::mapping::type::String String

ApiClient::Int32

Convenience typedef for oatpp::data::mapping::type::Int32.

typedef oatpp::data::mapping::type::Int32 Int32

ApiClient::Int64

Convenience typedef for oatpp::data::mapping::type::Int64.

typedef oatpp::data::mapping::type::Int64 Int64

ApiClient::Float32

Convenience typedef for oatpp::data::mapping::type::Float32.

typedef oatpp::data::mapping::type::Float32 Float32

ApiClient::Float64

Convenience typedef for oatpp::data::mapping::type::Float64.

typedef oatpp::data::mapping::type::Float64 Float64

ApiClient::Boolean

Convenience typedef for oatpp::data::mapping::type::Boolean.

typedef oatpp::data::mapping::type::Boolean Boolean

ApiClient::Response

Convenience typedef for oatpp::web::protocol::http::incoming::Response.

typedef oatpp::web::protocol::http::incoming::Response Response

ApiClient::AsyncCallback

Convenience typedef for oatpp::web::client::RequestExecutor::AsyncCallback.

typedef RequestExecutor::AsyncCallback AsyncCallback

ApiClient::getConnection

Call oatpp::web::client::RequestExecutor::getConnection().

virtual std::shared_ptr<RequestExecutor::ConnectionHandle> getConnection()

ApiClient::getConnectionAsync

Call oatpp::web::client::RequestExecutor::getConnectionAsync().

  • @return - oatpp::async::CoroutineStarterForResult.

virtual oatpp::async::CoroutineStarterForResult<const std::shared_ptr<RequestExecutor::ConnectionHandle>&> getConnectionAsync()