WebCFace 2.5.2
Web-based Communication Framework & Dashboard-like UI
|
#include <webcface/func.h>
Public Member Functions | |
FuncListener ()=default | |
FuncListener (const Field &base) | |
FuncListener (const Field &base, const SharedString &field) | |
FuncListener & | listen () |
関数呼び出しの待受を開始する | |
FuncListener & | listen (std::size_t args_num, ValType return_type=ValType::none_) |
関数呼び出しの待受を開始する | |
FuncListener & | setArgs (const std::vector< Arg > &args) |
引数の情報をセットする | |
FuncListener & | setReturnType (ValType type) |
戻り値の型をセットする | |
FuncListener & | hidden (bool) |
関数を関数リストで非表示にする (他clientのentryに表示されなくする) | |
std::optional< FuncCallHandle > | fetchCall () const |
関数が呼び出されたかどうかを確認 | |
Member | member () const |
Memberを返す | |
const std::string & | name () const |
field名を返す | |
Protected Types | |
using | FuncType = void(CallHandle) |
Protected Member Functions | |
Func | child (std::string_view field) const |
「(thisの名前).(追加の名前)」を新しい名前とするField | |
Func | child (std::wstring_view field) const |
「(thisの名前).(追加の名前)」を新しい名前とするField (wstring) | |
Func | child (int index) const |
Field | child (const SharedString &field) const |
Func | operator[] (std::string_view field) const |
Func | operator[] (std::wstring_view field) const |
Func | operator[] (const char *field) const |
Func | operator[] (const wchar_t *field) const |
Func | operator[] (int index) const |
Func | parent () const |
nameの最後のピリオドの前までを新しい名前とするField | |
const Func & | setImpl (ValType return_type, std::vector< Arg > &&args, std::function< FuncType > &&func_impl) const |
const Func & | setImpl (ValType return_type, std::nullopt_t, std::function< FuncType > &&func_impl) const |
const Func & | setImpl (const std::shared_ptr< internal::FuncInfo > &func_info) const |
template<typename T , typename traits::FuncObjTrait< T >::ReturnTypeTrait::ReturnTypeSupportedByWebCFaceFunc = traits::TraitOk, typename traits::FuncObjTrait< T >::ArgTypesTrait::ArgTypesSupportedByWebCFaceFunc = traits::TraitOk> | |
const Func & | set (T func) const |
関数をセットする | |
template<typename T , typename std::enable_if_t< std::is_same_v< std::invoke_result_t< T, CallHandle >, void >, std::nullptr_t > = nullptr> | |
const Func & | set (std::vector< Arg > args, ValType return_type, T callback) const |
引数にCallHandleを取る関数を登録する | |
template<typename T , typename std::enable_if_t< std::is_same_v< std::invoke_result_t< T, CallHandle >, void >, std::nullptr_t > = nullptr> | |
const Func & | set (T callback) const |
引数にCallHandleを取る関数を登録する | |
template<typename T , typename traits::FuncObjTrait< T >::ReturnTypeTrait::ReturnTypeSupportedByWebCFaceFunc = traits::TraitOk, typename traits::FuncObjTrait< T >::ArgTypesTrait::ArgTypesSupportedByWebCFaceFunc = traits::TraitOk> | |
const Func & | setAsync (T func) const |
非同期に実行される関数をセットする | |
template<typename T , typename std::enable_if_t< std::is_same_v< std::invoke_result_t< T, CallHandle >, void >, std::nullptr_t > = nullptr> | |
const Func & | setAsync (std::vector< Arg > args, ValType return_type, T callback) const |
引数にFuncCallHandleを取り非同期に実行される関数を登録する | |
template<typename T , typename std::enable_if_t< std::is_same_v< std::invoke_result_t< T, CallHandle >, void >, std::nullptr_t > = nullptr> | |
const Func & | setAsync (T callback) const |
引数にFuncCallHandleを取り非同期に実行される関数を登録する | |
const Func & | hidden (bool) const |
関数を関数リストで非表示にする (他clientのentryに表示されなくする) | |
const Func & | free () const |
関数の設定を削除 | |
template<typename... Args> | |
ValAdaptor | run (Args... args) const |
関数を実行する (同期) | |
ValAdaptor | run (std::vector< ValAdaptor > &&args_vec) const |
template<typename... Args> | |
ValAdaptor | operator() (Args... args) const |
run()と同じ | |
template<typename... Args> | |
Promise | runAsync (Args... args) const |
関数を実行する (非同期) | |
Promise | runAsync (std::vector< ValAdaptor > args_vec) const |
bool | exists () const |
関数の情報が存在すればtrue | |
ValType | returnType () const |
戻り値の型を返す | |
std::vector< Arg > | args () const |
引数の情報を返す | |
const Arg | args (std::size_t i) const |
const Func & | setArgs (const std::vector< Arg > &args) const |
引数の情報を更新する | |
const Func & | setReturnType (ValType return_type) const |
戻り値の型の情報を更新する | |
template<typename T , typename std::enable_if_t< std::is_same_v< T, Func >, std::nullptr_t > = nullptr> | |
bool | operator== (const T &other) const |
Funcの参照先を比較 | |
bool | operator== (const Field &other) const |
bool | operator== (const FieldBase &rhs) const |
template<typename T , typename std::enable_if_t< std::is_same_v< T, Func >, std::nullptr_t > = nullptr> | |
bool | operator!= (const T &other) const |
bool | operator!= (const Field &other) const |
bool | operator!= (const FieldBase &rhs) const |
std::string | lastName () const |
nameのうちピリオドで区切られた最後の部分を取り出す | |
const std::wstring & | nameW () const |
field名を返す (wstring) | |
std::shared_ptr< internal::ClientData > | dataLock () const |
data_wをlockし、失敗したらruntime_errorを投げる | |
std::shared_ptr< internal::ClientData > | setCheck () const |
data_wをlockし、memberがselfではなければinvalid_argumentを投げる | |
bool | expired () const |
SharedString | lastName8 () const |
std::wstring | lastNameW () const |
nameのうちピリオドで区切られた最後の部分を取り出す (wstring) | |
Value | value (std::string_view field="") const |
Value | value (std::wstring_view field) const |
Text | text (std::string_view field="") const |
Text | text (std::wstring_view field) const |
RobotModel | robotModel (std::string_view field="") const |
RobotModel | robotModel (std::wstring_view field) const |
Image | image (std::string_view field="") const |
Image | image (std::wstring_view field) const |
Func | func (std::string_view field="") const |
Func | func (std::wstring_view field) const |
FuncListener | funcListener (std::string_view field) const |
FuncListener | funcListener (std::wstring_view field) const |
View | view (std::string_view field="") const |
View | view (std::wstring_view field) const |
Canvas3D | canvas3D (std::string_view field="") const |
Canvas3D | canvas3D (std::wstring_view field) const |
Canvas2D | canvas2D (std::string_view field="") const |
Canvas2D | canvas2D (std::wstring_view field) const |
Log | log (std::string_view field="") const |
Log | log (std::wstring_view field) const |
std::vector< Value > | valueEntries () const |
std::vector< Text > | textEntries () const |
std::vector< RobotModel > | robotModelEntries () const |
std::vector< Func > | funcEntries () const |
std::vector< View > | viewEntries () const |
std::vector< Canvas3D > | canvas3DEntries () const |
std::vector< Canvas2D > | canvas2DEntries () const |
std::vector< Image > | imageEntries () const |
std::vector< Log > | logEntries () const |
bool | isSelf () const |
memberがselfならtrue | |
Static Protected Member Functions | |
template<typename F1 > | |
static void | catchAll (F1 &&f_run, const CallHandle &handle) |
template<typename F1 > | |
static void | tryRun (F1 &&f_run, const CallHandle &handle) |
Protected Attributes | |
std::weak_ptr< internal::ClientData > | data_w |
ClientDataの参照 | |
SharedString | member_ |
メンバー名 | |
SharedString | field_ |
フィールド名 | |
Friends | |
class | TemporalViewComponent |
class | TemporalCanvas2DComponent |
|
inherited |
|
default |
FuncListener | ( | const Field & | base | ) |
|
inline |
|
inherited |
引数の情報を返す
変更するにはsetArgsを使う(このvectorの中身を書き換えても反映されない)
|
inlineinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inlinestaticprotectedinherited |
f_run()を実行し例外を投げた場合はrejectする
|
inherited |
|
inlineinherited |
|
inlineinherited |
「(thisの名前).(追加の名前)」を新しい名前とするField
|
inlineinherited |
「(thisの名前).(追加の名前)」を新しい名前とするField (wstring)
|
inherited |
data_wをlockし、失敗したらruntime_errorを投げる
|
inherited |
関数の情報が存在すればtrue
|
inherited |
std::optional< FuncCallHandle > fetchCall | ( | ) | const |
関数が呼び出されたかどうかを確認
1回の関数呼び出しに対してfetchCallは1回だけhandleを返す
|
inherited |
関数の設定を削除
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inline |
関数を関数リストで非表示にする (他clientのentryに表示されなくする)
|
inlineinherited |
関数を関数リストで非表示にする (他clientのentryに表示されなくする)
|
inherited |
|
inherited |
|
inherited |
|
inherited |
memberがselfならtrue
data_wがlockできなければruntime_errorを投げる
|
inlineinherited |
nameのうちピリオドで区切られた最後の部分を取り出す
|
protectedinherited |
|
inlineinherited |
nameのうちピリオドで区切られた最後の部分を取り出す (wstring)
FuncListener & listen | ( | ) |
関数呼び出しの待受を開始する
|
inline |
関数呼び出しの待受を開始する
args_num | 引数の個数 (setArgsで設定していない場合) |
return_type | 戻り値の型 (setReturnTypeで設定していない場合) |
|
inherited |
|
inherited |
|
inherited |
Member member | ( | ) | const |
Memberを返す
|
inline |
field名を返す
|
inlineinherited |
field名を返す (wstring)
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
run()と同じ
|
inherited |
|
inlineinherited |
|
inlineinherited |
Funcの参照先を比較
|
inlineinherited |
operator[](long, const char *)と解釈されるのを防ぐための定義
|
inlineinherited |
|
inlineinherited |
nameの最後のピリオドの前までを新しい名前とするField
|
inherited |
戻り値の型を返す
|
inherited |
|
inherited |
|
inherited |
|
inlineinherited |
関数を実行する (同期)
例外が発生した場合 runtime_error, 関数が存在しない場合 FuncNotFound をthrowする
|
inlineinherited |
|
inlineinherited |
関数を実行する (非同期)
|
inherited |
|
inlineinherited |
引数にCallHandleを取る関数を登録する
args | 引数の型などの情報 |
return_type | 戻り値の型 |
func | セットする関数または関数オブジェクト。 引数としてCallHandleを1つ取り、戻り値はvoidで、 CallHandle::respond() や reject() を通して値を返す |
|
inlineinherited |
引数にCallHandleを取る関数を登録する
func | セットする関数または関数オブジェクト。 引数としてCallHandleを1つ取り、戻り値はvoidで、 CallHandle::respond() や reject() を通して値を返す |
|
inlineinherited |
関数をセットする
func | セットする関数または関数オブジェクト。 引数はValAdaptorからキャスト可能な型ならいくつでも、 戻り値はvoidまたはValAdaptorにキャスト可能な型が使用可能 |
|
inline |
引数の情報をセットする
listen() の前に呼ばなければならない。
引数の情報を更新する
setArgsで渡された引数の情報(名前など)とFuncがすでに持っている引数の情報(型など)がマージされる
関数のセットの後に呼ばなければならない(セット前に呼ぶと std::invalid_argument) (例えば Func(...).set(...).setArgs({...}) ) また、関数をセットしたあと cli.sync() をする前に呼ばなければならない 実際にセットした関数の引数の数とargsの要素数は一致していなければならない (一致していない場合 std::invalid_argument )
|
inlineinherited |
引数にFuncCallHandleを取り非同期に実行される関数を登録する
args | 引数の型などの情報 |
return_type | 戻り値の型 |
func | セットする関数または関数オブジェクト。 引数としてCallHandleを1つ取り、戻り値はvoidで、 CallHandle::respond() や reject() を通して値を返す |
|
inlineinherited |
引数にFuncCallHandleを取り非同期に実行される関数を登録する
func | セットする関数または関数オブジェクト。 引数としてCallHandleを1つ取り、戻り値はvoidで、 CallHandle::respond() や reject() を通して値を返す |
|
inlineinherited |
非同期に実行される関数をセットする
func | セットする関数または関数オブジェクト。 引数はValAdaptorからキャスト可能な型ならいくつでも、 戻り値はvoidまたはValAdaptorにキャスト可能な型が使用可能 |
|
inherited |
data_wをlockし、memberがselfではなければinvalid_argumentを投げる
|
protectedinherited |
|
protectedinherited |
引数の個数不定バージョン
|
protectedinherited |
set2()で構築された関数の情報(FuncInfo)をclientにセット
|
inline |
戻り値の型をセットする
listen() の前に呼ばなければならない。
|
inherited |
|
inherited |
|
inherited |
|
inlinestaticprotectedinherited |
f_run()を実行し結果をCallHandleに渡す
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
friend |
|
friend |
|
inherited |
ClientDataの参照
ClientData内に保持するクラスもあるので循環参照を避けるためweak_ptr
|
inherited |
フィールド名
Memberなどフィールド名が不要なクラスでは使用しない
|
inherited |
メンバー名