クラス necbaas::NbService

MBaaS サービスクラス. [詳細]

#include "necbaas/nb_service.h"

Public メソッド
virtual	~NbService ()
	デストラクタ. [詳細]
const std::string &	GetAppId () const
	アプリケーションID取得. [詳細]
const std::string &	GetAppKey () const
	アプリケーションキー取得. [詳細]
const std::string &	GetEndpointUrl () const
	Endpoint URI 取得. [詳細]
const std::string &	GetTenantId () const
	テナントID取得. [詳細]
const std::string &	GetProxy () const
	Proxy URL取得. [詳細]
NbSessionToken	GetSessionToken ()
	[内部処理用] [詳細]
virtual void	SetSessionToken (const NbSessionToken &token)
	[内部処理用] [詳細]
void	ClearSessionToken ()
	[内部処理用] [詳細]
NbResult< NbHttpResponse >	ExecuteRequest (std::function< NbHttpRequest(NbHttpRequestFactory &)> create_request, int timeout)
	[内部処理用] [詳細]
NbResult< NbHttpResponse >	ExecuteFileDownload (std::function< NbHttpRequest(NbHttpRequestFactory &)> create_request, const std::string &file_path, int timeout)
	[内部処理用] [詳細]
NbResult< NbHttpResponse >	ExecuteFileUpload (std::function< NbHttpRequest(NbHttpRequestFactory &)> create_request, const std::string &file_path, int timeout)
	[内部処理用] [詳細]

Static Public メソッド
static std::shared_ptr< NbService >	CreateService (const std::string &endpoint_url, const std::string &tenant_id, const std::string &app_id, const std::string &app_key, const std::string &proxy="")
	サービスインスタンス生成. [詳細]
static void	SetDebugLogEnabled (bool flag)
	ロギング設定（デバッグログ）. [詳細]
static void	SetErrorLogEnabled (bool flag)
	ロギング設定（エラーログ）. [詳細]
static void	SetRestLogEnabled (bool flag)
	ロギング設定（RESTログ）. [詳細]

Protected メソッド
	NbService (const std::string &endpoint_url, const std::string &tenant_id, const std::string &app_id, const std::string &app_key, const std::string &proxy)
	コンストラクタ. [詳細]
virtual NbRestExecutor *	PopRestExecutor ()
	REST Executor 取り出し. [詳細]
virtual void	PushRestExecutor (NbRestExecutor *executor)
	REST Executor 返却. [詳細]
NbHttpRequestFactory	GetHttpRequestFactory ()
	HTTPリクエストファクトリ取得. [詳細]
NbResult< NbHttpResponse >	ExecuteCommon (std::function< NbHttpRequest(NbHttpRequestFactory &)> create_request, std::function< NbResult< NbHttpResponse >(NbRestExecutor *, const NbHttpRequest &)> executor_method)
	REST実行(共通処理). [詳細]

説明

MBaaS サービスクラス.

MBaaS 機能を提供するメインクラス.

コンストラクタとデストラクタ

virtual necbaas::NbService::~NbService ( )

virtual

デストラクタ.

necbaas::NbService::NbService ( const std::string &  endpoint_url, const std::string &  tenant_id, const std::string &  app_id, const std::string &  app_key, const std::string &  proxy  )

protected

コンストラクタ.

関数

void necbaas::NbService::ClearSessionToken

(

)

[内部処理用]

static std::shared_ptr<NbService> necbaas::NbService::CreateService ( const std::string &  endpoint_url, const std::string &  tenant_id, const std::string &  app_id, const std::string &  app_key, const std::string &  proxy = ""  )

static

サービスインスタンス生成.

サービスインスタンスは、本メソッドを使用して取得する. proxy以外のパラメータは必須である。必須パラメータが空文字の場合はREST実行時にエラーが発生する。 proxyに空文字を設定した場合はProxyを使用しない。Proxyを使用する場合は必ず設定すること。

引数

[in]	endpoint_url	Endpoint URI
[in]	tenant_id	テナントID
[in]	app_id	アプリケーションID
[in]	app_key	アプリケーションキー
[in]	proxy	Proxy URL "[scheme]://[hostname]:[port]" デフォルト：Proxy無効(空文字) 例）"http://proxyhost:8080"

戻り値

サービスインスタンス

NbResult<NbHttpResponse> necbaas::NbService::ExecuteCommon ( std::function< NbHttpRequest(NbHttpRequestFactory &)>  create_request, std::function< NbResult< NbHttpResponse >(NbRestExecutor *, const NbHttpRequest &)>  executor_method  )

protected

REST実行(共通処理).

引数

[in]	create_request	HTTPリクエスト作成関数ポインタ
[in]	executor_method	Executor関数ポインタ

戻り値

処理結果

NbResult<NbHttpResponse> necbaas::NbService::ExecuteFileDownload	(	std::function< NbHttpRequest(NbHttpRequestFactory &)>	create_request,
		const std::string &	file_path,
		int	timeout
	)

[内部処理用]

NbResult<NbHttpResponse> necbaas::NbService::ExecuteFileUpload	(	std::function< NbHttpRequest(NbHttpRequestFactory &)>	create_request,
		const std::string &	file_path,
		int	timeout
	)

[内部処理用]

NbResult<NbHttpResponse> necbaas::NbService::ExecuteRequest	(	std::function< NbHttpRequest(NbHttpRequestFactory &)>	create_request,
		int	timeout
	)

[内部処理用]

const std::string& necbaas::NbService::GetAppId

(

)

const

アプリケーションID取得.

戻り値

アプリケーションID

const std::string& necbaas::NbService::GetAppKey

(

)

const

アプリケーションキー取得.

戻り値

アプリケーションキー

const std::string& necbaas::NbService::GetEndpointUrl

(

)

const

Endpoint URI 取得.

戻り値

Endpoint URI

NbHttpRequestFactory necbaas::NbService::GetHttpRequestFactory ( )

protected

HTTPリクエストファクトリ取得.

引数

[in]

executor

RESTタイムアウト(秒)

戻り値

リクエストファクトリ

const std::string& necbaas::NbService::GetProxy

(

)

const

Proxy URL取得.

戻り値

Proxy URL

NbSessionToken necbaas::NbService::GetSessionToken

(

)

[内部処理用]

const std::string& necbaas::NbService::GetTenantId

(

)

const

テナントID取得.

戻り値

テナントID

virtual NbRestExecutor* necbaas::NbService::PopRestExecutor ( )

protectedvirtual

REST Executor 取り出し.

戻り値

REST Executor

戻り値

nullptr以外	取得成功
nullptr	同時接続数オーバー

virtual void necbaas::NbService::PushRestExecutor ( NbRestExecutor *  executor )

protectedvirtual

REST Executor 返却.

引数

[in]

executor

REST Executor

static void necbaas::NbService::SetDebugLogEnabled ( bool  flag )

static

ロギング設定（デバッグログ）.

プロセス内の全サービスに対して設定される。
default設定: Debug版: 有効、Release版: 無効

引数

[in]

flag

true:有効／false:無効

static void necbaas::NbService::SetErrorLogEnabled ( bool  flag )

static

ロギング設定（エラーログ）.

プロセス内の全サービスに対して設定される。
default設定: Debug版: 有効、Release版: 無効

引数

[in]

flag

true:有効／false:無効

static void necbaas::NbService::SetRestLogEnabled ( bool  flag )

static

ロギング設定（RESTログ）.

プロセス内の全サービスに対して設定される。
default設定: Debug版: 有効、Release版: 無効

引数

[in]

flag

true:有効／false:無効

virtual void necbaas::NbService::SetSessionToken ( const NbSessionToken &  token )

virtual

[内部処理用]

---

このクラスの説明は次のファイルから生成されました:

• nb_service.h