AM Daemon ライブラリリファレンス
公開メンバ関数 | 全メンバ一覧
amdaemon::RequestState クラス

Daemonプロセスへの処理要求状態を保持するクラス。 [詳解]

#include <RequestState.h>

公開メンバ関数

 RequestState ()
 コンストラクタ。 [詳解]
 
 RequestState (const InnerInfo &)
 コンストラクタ。 [詳解]
 
 RequestState (const RequestState &src)
 コピーコンストラクタ。 [詳解]
 
 RequestState (RequestState &&src)
 ムーブコンストラクタ。 [詳解]
 
 ‾RequestState ()
 デストラクタ。 [詳解]
 
RequestStateoperator= (const RequestState &r)
 コピー代入演算子のオーバロード。 [詳解]
 
RequestStateoperator= (RequestState &&r)
 ムーブ代入演算子のオーバロード。 [詳解]
 
bool valid () const
 要求が有効であるか否かを取得する。 [詳解]
 
bool isSent () const
 要求がDaemonプロセスへ送信済みであるか否かを取得する。 [詳解]
 
bool isDone () const
 要求が処理完了済みであるか否かを取得する。 [詳解]
 
bool isSucceeded () const
 要求が処理成功したか否かを取得する。 [詳解]
 

詳解

Daemonプロセスへの処理要求状態を保持するクラス。

参照
Backup, CanTarget, Aime::sendLog

このクラスの有効なインスタンスをアプリ側で直接生成することはできない。 Daemonプロセスへ処理要求を行う各種関数の戻り値として取得できる。

コピーおよびムーブはほぼオーバヘッド無く可能である。 内部状態はコピーしたインスタンス間で共有される。

void func(std::vector<amdaemon::BackupRecord>& records)
{
amdaemon::RequestState state = backup.setupRecords(records);
// ほぼオーバヘッドなくコピー可能
// temp と state は同じ処理要求状態を共有する
amdaemon::RequestState temp = state;
// …後略…
}

構築子と解体子

amdaemon::RequestState::RequestState ( )

コンストラクタ。

無効な処理要求状態として初期化される。

amdaemon::RequestState::RequestState ( const InnerInfo &  )
explicit

コンストラクタ。

覚え書き
アプリ側からは利用できない。
amdaemon::RequestState::RequestState ( const RequestState src)

コピーコンストラクタ。

引数
[in]srcコピー元。
amdaemon::RequestState::RequestState ( RequestState &&  src)

ムーブコンストラクタ。

引数
[in]srcムーブ元。
amdaemon::RequestState::‾RequestState ( )

デストラクタ。

関数詳解

RequestState& amdaemon::RequestState::operator= ( const RequestState r)

コピー代入演算子のオーバロード。

引数
[in]r右辺値。
戻り値
自身の参照。
RequestState& amdaemon::RequestState::operator= ( RequestState &&  r)

ムーブ代入演算子のオーバロード。

引数
[in]r右辺値。
戻り値
自身の参照。
bool amdaemon::RequestState::valid ( ) const

要求が有効であるか否かを取得する。

戻り値
true要求が有効である場合。
false要求が無効である場合。
bool amdaemon::RequestState::isSent ( ) const

要求がDaemonプロセスへ送信済みであるか否かを取得する。

戻り値
true送信済みである場合。
false未送信であるか、要求が無効である場合。

処理要求元が非同期で動作している場合、 この関数が true を返してもまだ処理完了していない可能性がある。 処理完了済みか否かはメンバ関数 isDone で取得できる。

bool amdaemon::RequestState::isDone ( ) const

要求が処理完了済みであるか否かを取得する。

戻り値
true処理完了済みである場合。
false処理未完了であるか、要求が無効である場合。
bool amdaemon::RequestState::isSucceeded ( ) const

要求が処理成功したか否かを取得する。

戻り値
true処理成功した場合。
false処理失敗したか、処理未完了であるか、要求が無効である場合。

メンバ関数 isDone が false を返す状態の場合、この関数も必ず false を返す。


このクラス詳解は次のファイルから抽出されました: