WebCFace 2.9.0
Web-based Communication Framework & Dashboard-like UI
Loading...
Searching...
No Matches
CallHandle Class Reference

呼び出された関数の引数の取得と戻り値のセットをするインタフェース More...

#include <webcface/func_result.h>

Inheritance diagram for CallHandle:
[legend]
Collaboration diagram for CallHandle:
[legend]

Public Member Functions

 CallHandle ()=default
 
 CallHandle (const Field &base, const std::shared_ptr< internal::PromiseData > &data)
 
const std::vector< ValAdaptor > & args () const
 関数の引数を取得する
 
const wcfMultiValcArgs () const
 
const wcfMultiValWcWArgs () const
 
void respond (const ValAdaptor &value) const
 
void reject (const ValAdaptor &message) const
 
void reach (bool found) const
 
bool assertArgsNum (std::size_t expected) const
 引数の数をチェックする
 
template<typename T >
void respond (const T &value) const
 関数の結果を送信する
 
template<std::size_t N>
void respond (const char(&value)[N]) const
 
template<std::size_t N>
void respond (const wchar_t(&value)[N]) const
 
void respond () const
 空の値を関数の結果として送信する
 
void reject (StringInitializer message) const
 関数の結果を例外として送信する
 
bool respondable () const
 respond()またはreject()が可能かどうかを返す
 
StringView name () const
 field名を返す
 
WStringView nameW () const
 field名を返す (wstring)
 

Friends

class Func
 
class FuncListener
 
struct internal::FuncInfo
 
struct internal::ClientData
 

Detailed Description

呼び出された関数の引数の取得と戻り値のセットをするインタフェース

Since
ver1.5

ver1.11までFuncCallHandle, ver2.0からCallHandleに名前変更

Constructor & Destructor Documentation

◆ CallHandle() [1/2]

CallHandle ( )
default

◆ CallHandle() [2/2]

CallHandle ( const Field base,
const std::shared_ptr< internal::PromiseData > &  data 
)

Member Function Documentation

◆ args()

const std::vector< ValAdaptor > & args ( ) const

関数の引数を取得する

◆ assertArgsNum()

bool assertArgsNum ( std::size_t  expected) const

引数の数をチェックする

Since
ver2.0

args().size() != expected ならエラーメッセージとともにrejectし、falseを返す

Returns
引数の個数がexpectedと一致していたらtrue

◆ cArgs()

const wcfMultiVal * cArgs ( ) const

引数データを表すwcfMultiValの配列を構築 (createHandle() 用)

Since
ver1.7

◆ cWArgs()

const wcfMultiValW * cWArgs ( ) const

引数データを表すwcfMultiValWの配列を構築 (createHandle() 用)

Since
ver2.0

◆ name()

StringView name ( ) const
inline

field名を返す

ver2.10〜 std::stringの参照から StringView に変更

◆ nameW()

WStringView nameW ( ) const
inline

field名を返す (wstring)

Since
ver2.0

ver2.10〜 std::wstringの参照から WStringView に変更

◆ reach()

void reach ( bool  found) const
Since
ver2.0

◆ reject() [1/2]

void reject ( const ValAdaptor message) const
Since
ver2.0

◆ reject() [2/2]

void reject ( StringInitializer  message) const
inline

関数の結果を例外として送信する

  • ver1.11まで: 2回呼ぶと std::future_error を投げ、 このHandleがデフォルト構築されていた場合 std::runtime_error を投げる
  • ver2.0から: respondable() がfalseの場合 std::runtime_error を投げる
  • ver2.0〜 wstring対応、ver2.10〜 String型に変更

◆ respond() [1/5]

void respond ( ) const
inline

空の値を関数の結果として送信する

  • ver1.11まで: 2回呼ぶと std::future_error を投げ、 このHandleがデフォルト構築されていた場合 std::runtime_error を投げる
  • ver2.0から: respondable() がfalseの場合 std::runtime_error を投げる

◆ respond() [2/5]

template<std::size_t N>
void respond ( const char(&)  value[N]) const
inline
Since
ver2.10

◆ respond() [3/5]

template<typename T >
void respond ( const T &  value) const
inline

関数の結果を送信する

  • ver1.11まで: 2回呼ぶと std::future_error を投げ、 このHandleがデフォルト構築されていた場合 std::runtime_error を投げる
  • ver2.0から: respondable() がfalseの場合 std::runtime_error を投げる

◆ respond() [4/5]

void respond ( const ValAdaptor value) const
Since
ver2.0

◆ respond() [5/5]

template<std::size_t N>
void respond ( const wchar_t(&)  value[N]) const
inline
Since
ver2.10

◆ respondable()

bool respondable ( ) const

respond()またはreject()が可能かどうかを返す

Since
ver2.0
Returns
このhandleが有効(デフォルト構築などではない)、 かつまだrespond()もreject()もしていない状態ならtrue

Friends And Related Symbol Documentation

◆ Func

friend class Func
friend

◆ FuncListener

friend class FuncListener
friend

◆ internal::ClientData

friend struct internal::ClientData
friend

◆ internal::FuncInfo

friend struct internal::FuncInfo
friend

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