octane::internal::HttpClientBase Class Reference

HTTP通信を行うインタフェース。 More...

#include <http_client.h>

Inheritance diagram for octane::internal::HttpClientBase:

Public Member Functions
virtual	~HttpClientBase () noexcept=0
virtual Result< _, ErrorResponse >	init () noexcept=0
	HttpClientを初期化する。 More...
virtual Result< HttpResponse, ErrorResponse >	request (std::string_view origin, const HttpRequest &request)=0
	HTTPリクエストを発行する。 More...

Detailed Description

HTTP通信を行うインタフェース。

{

See also

HttpClient } このインタフェースを実装したクラス。

Constructor & Destructor Documentation

~HttpClientBase()

octane::internal::HttpClientBase::~HttpClientBase ( )

pure virtualnoexcept

Member Function Documentation

init()

virtual Result< _, ErrorResponse > octane::internal::HttpClientBase::init ( )

pure virtualnoexcept

HttpClientを初期化する。

このメソッドはインスタンスを生成した直後に呼び出さなければならない。 また、複数回呼び出すことはできない。 失敗した場合は以下のエラーレスポンスを返す。

• ERR_CURL_INITIALIZATION_FAILED: CURLの初期化に失敗したとき

Returns

Result<_, ErrorResponse> 成功した場合は何も返さず、失敗した場合は上記のエラーレスポンスを返す。

Implemented in octane::internal::HttpClient.

Here is the caller graph for this function:

request()

virtual Result< HttpResponse, ErrorResponse > octane::internal::HttpClientBase::request ( std::string_view  origin, const HttpRequest &  request  )

pure virtual

HTTPリクエストを発行する。

失敗した場合は以下のエラーレスポンスを返す。

• ERR_INCORRECT_HTTP_METHOD: GET, POST, PUT, DELETE以外のメソッドを使用したり、GET, DELETEでボディ部を指定したとき
• ERR_CURL_CONNECTION_FAILED: CURLの接続に失敗したとき

Parameters

[in]	origin	リクエスト先のオリジン。"http://localhost:3000"など。
[in]	request	リクエスト用のオブジェクト。

Returns

Result<HttpResponse, ErrorResponse>

Implemented in octane::internal::HttpClient.

---

The documentation for this class was generated from the following files:

• src/include/internal/http_client.h
• src/cpp/internal/http_client.cpp