Skip to content

Changes

Page history
Update home authored by Alexey Zakharov's avatar Alexey Zakharov
Hide whitespace changes
Inline Side-by-side
home.md
View page @ 15e413c2
# group `request` {#group__request} ---
title: Classes
Request/Reply communication is used to send commands to a motorcortex server.
## Summary ---
Members | Descriptions # Classes
--------------------------------|---------------------------------------------
`public `[`Request`](#group__request_1ga0bf696d0a423087fbe17c221307636fd)`() = delete` |
`public explicit `[`Request`](#group__request_1ga44c87d666fa137904e56bc5d1944d434)`(const ParameterTree & parameter_tree)` |
`public `[`~Request`](#group__request_1gac16054e325ff15f7d640dddef1c20567)`()` | * **struct [_AllTypes](Classes/struct__AllTypes.md)**
`public std::string `[`url`](#group__request_1gacfcdd3adb2b1211f4e44290ba169e3e0)`() const` | * **struct [_EmptyMessage](Classes/struct__EmptyMessage.md)**
`public ConnectionReply `[`connect`](#group__request_1ga98d0b1fa72a00894bb1f2e0d92ae9470)`(std::string url,size_t timeout_ms)` | * **struct [_Limits](Classes/struct__Limits.md)**
`public ConnectionReply `[`connect`](#group__request_1gaf7c3e05e562f529a60632e2e5cf1e566)`(std::string url,const ConnectionOptions & connection_options)` | * **struct [_SubMessage](Classes/struct__SubMessage.md)**
`public void `[`close`](#group__request_1ga27321c84e73a5cb48f279858c8c01191)`()` | * **struct [_motorcortex_ConsoleCmdListMsg](Classes/struct__motorcortex__ConsoleCmdListMsg.md)**
`public StatusReply `[`login`](#group__request_1ga563ffd90d911f4501b0cfd38a5d67cb6)`(std::string login,std::string password) const` | * **struct [_motorcortex_ConsoleCmdMsg](Classes/struct__motorcortex__ConsoleCmdMsg.md)**
`public ParameterTreeReply `[`getParameterTree`](#group__request_1ga78655693735ceedfc18d2d87d6a0d79b)`(size_t timeout_msec) const` | * **struct [_motorcortex_CreateGroupMsg](Classes/struct__motorcortex__CreateGroupMsg.md)**
`public StatusReply `[`setParameter`](#group__request_1gaafe3905a109847c73bcdbd7a82dac92b)`(SetParameter value) const` | * **struct [_motorcortex_Error](Classes/struct__motorcortex__Error.md)**
`public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1gaf8c7e702165817675f352e5b364a3d5d)`(const std::string & path,const T & value) const` | * **struct [_motorcortex_ErrorList](Classes/struct__motorcortex__ErrorList.md)**
`public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1ga9bfa52fa512e4bb457693fd18e07315b)`(const std::string & path,const std::initializer_list< T > & value) const` | * **struct [_motorcortex_GetParameterListMsg](Classes/struct__motorcortex__GetParameterListMsg.md)**
`public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1ga5d80f31b02f2580c2876abc749125499)`(const std::string & path,const std::vector< T > & value) const` | * **struct [_motorcortex_GetParameterMsg](Classes/struct__motorcortex__GetParameterMsg.md)**
`public GetParameterReply `[`getParameter`](#group__request_1ga4fe8fa3391225c2790479d38ee6e8ec9)`(const std::string & path) const` | * **struct [_motorcortex_GetParameterTreeHashMsg](Classes/struct__motorcortex__GetParameterTreeHashMsg.md)**
`public SubscriptionReply `[`createGroup`](#group__request_1gaf43939dd894f40759279cdae2db1fc4b)`(std::vector< std::string > path_list,const std::string & group_alias,size_t frequency_divider) const` | * **struct [_motorcortex_GetParameterTreeMsg](Classes/struct__motorcortex__GetParameterTreeMsg.md)**
`public StatusReply `[`removeGroup`](#group__request_1ga2265e5c93d801c6d458936c0c225d002)`(const std::string & group_alias) const` | * **struct [_motorcortex_GetSessionTokenMsg](Classes/struct__motorcortex__GetSessionTokenMsg.md)**
`public WorkerHandle `[`getWorker`](#group__request_1ga80a298c33217ce25fd1eed07dd837010)`() const` | * **struct [_motorcortex_GroupMsg](Classes/struct__motorcortex__GroupMsg.md)**
`public static McxStatus `[`send`](#group__request_1ga8880f52e569f160c255d0d0cc534b12f)`(WorkerHandle & worker)` | * **struct [_motorcortex_GroupParameterInfo](Classes/struct__motorcortex__GroupParameterInfo.md)**
`class `[`mcx_cpp::Request`](#classmcx__cpp_1_1Request) | * **struct [_motorcortex_GroupStatusMsg](Classes/struct__motorcortex__GroupStatusMsg.md)**
`struct `[`mcx_cpp::ConnectionOptions`](#structmcx__cpp_1_1ConnectionOptions) | * **struct [_motorcortex_Header](Classes/struct__motorcortex__Header.md)**
* **struct [_motorcortex_LoadMsg](Classes/struct__motorcortex__LoadMsg.md)**
## Members * **struct [_motorcortex_LoginMsg](Classes/struct__motorcortex__LoginMsg.md)**
* **struct [_motorcortex_LogoutMsg](Classes/struct__motorcortex__LogoutMsg.md)**
#### `public `[`Request`](#group__request_1ga0bf696d0a423087fbe17c221307636fd)`() = delete` {#group__request_1ga0bf696d0a423087fbe17c221307636fd} * **struct [_motorcortex_OverwriteParameterMsg](Classes/struct__motorcortex__OverwriteParameterMsg.md)**
* **struct [_motorcortex_ParameterInfo](Classes/struct__motorcortex__ParameterInfo.md)**
#### `public explicit `[`Request`](#group__request_1ga44c87d666fa137904e56bc5d1944d434)`(const ParameterTree & parameter_tree)` {#group__request_1ga44c87d666fa137904e56bc5d1944d434} * **struct [_motorcortex_ParameterListMsg](Classes/struct__motorcortex__ParameterListMsg.md)**
* **struct [_motorcortex_ParameterMsg](Classes/struct__motorcortex__ParameterMsg.md)**
#### `public `[`~Request`](#group__request_1gac16054e325ff15f7d640dddef1c20567)`()` {#group__request_1gac16054e325ff15f7d640dddef1c20567} * **struct [_motorcortex_ParameterOffset](Classes/struct__motorcortex__ParameterOffset.md)**
* **struct [_motorcortex_ParameterTreeHashMsg](Classes/struct__motorcortex__ParameterTreeHashMsg.md)**
#### `public std::string `[`url`](#group__request_1gacfcdd3adb2b1211f4e44290ba169e3e0)`() const` {#group__request_1gacfcdd3adb2b1211f4e44290ba169e3e0} * **struct [_motorcortex_ParameterTreeMsg](Classes/struct__motorcortex__ParameterTreeMsg.md)**
* **struct [_motorcortex_ReleaseParameterMsg](Classes/struct__motorcortex__ReleaseParameterMsg.md)**
#### `public ConnectionReply `[`connect`](#group__request_1ga98d0b1fa72a00894bb1f2e0d92ae9470)`(std::string url,size_t timeout_ms)` {#group__request_1ga98d0b1fa72a00894bb1f2e0d92ae9470} * **struct [_motorcortex_RemoveGroupMsg](Classes/struct__motorcortex__RemoveGroupMsg.md)**
* **struct [_motorcortex_RestoreSessionMsg](Classes/struct__motorcortex__RestoreSessionMsg.md)**
#### `public ConnectionReply `[`connect`](#group__request_1gaf7c3e05e562f529a60632e2e5cf1e566)`(std::string url,const ConnectionOptions & connection_options)` {#group__request_1gaf7c3e05e562f529a60632e2e5cf1e566} * **struct [_motorcortex_SaveMsg](Classes/struct__motorcortex__SaveMsg.md)**
* **struct [_motorcortex_SessionTokenMsg](Classes/struct__motorcortex__SessionTokenMsg.md)**
#### `public void `[`close`](#group__request_1ga27321c84e73a5cb48f279858c8c01191)`()` {#group__request_1ga27321c84e73a5cb48f279858c8c01191} * **struct [_motorcortex_SetParameterListMsg](Classes/struct__motorcortex__SetParameterListMsg.md)**
* **struct [_motorcortex_SetParameterMsg](Classes/struct__motorcortex__SetParameterMsg.md)**
#### `public StatusReply `[`login`](#group__request_1ga563ffd90d911f4501b0cfd38a5d67cb6)`(std::string login,std::string password) const` {#group__request_1ga563ffd90d911f4501b0cfd38a5d67cb6} * **struct [_motorcortex_StatusMsg](Classes/struct__motorcortex__StatusMsg.md)**
* **namespace [mcx_cpp](Namespaces/namespacemcx__cpp.md)**
#### `public ParameterTreeReply `[`getParameterTree`](#group__request_1ga78655693735ceedfc18d2d87d6a0d79b)`(size_t timeout_msec) const` {#group__request_1ga78655693735ceedfc18d2d87d6a0d79b} * **struct [ConnectionOptions](Classes/structmcx__cpp_1_1ConnectionOptions.md)**
* **class [ConnectionStatus](Classes/classmcx__cpp_1_1ConnectionStatus.md)**
#### `public StatusReply `[`setParameter`](#group__request_1gaafe3905a109847c73bcdbd7a82dac92b)`(SetParameter value) const` {#group__request_1gaafe3905a109847c73bcdbd7a82dac92b} * **class [GetParameter](Classes/classmcx__cpp_1_1GetParameter.md)**
* **class [McxStatus](Classes/classmcx__cpp_1_1McxStatus.md)**
#### `public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1gaf8c7e702165817675f352e5b364a3d5d)`(const std::string & path,const T & value) const` {#group__request_1gaf8c7e702165817675f352e5b364a3d5d} * **class [ParameterTree](Classes/classmcx__cpp_1_1ParameterTree.md)**
* **class [ParameterTreeMsg](Classes/classmcx__cpp_1_1ParameterTreeMsg.md)**
#### `public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1ga9bfa52fa512e4bb457693fd18e07315b)`(const std::string & path,const std::initializer_list< T > & value) const` {#group__request_1ga9bfa52fa512e4bb457693fd18e07315b} * **class [Request](Classes/classmcx__cpp_1_1Request.md)**
* **class [SetParameter](Classes/classmcx__cpp_1_1SetParameter.md)**
#### `public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1ga5d80f31b02f2580c2876abc749125499)`(const std::string & path,const std::vector< T > & value) const` {#group__request_1ga5d80f31b02f2580c2876abc749125499} * **struct [safe_underlying_type](Classes/structmcx__cpp_1_1SetParameter_1_1safe__underlying__type.md)**
* **struct [safe_underlying_type< T, false >](Classes/structmcx__cpp_1_1SetParameter_1_1safe__underlying__type_3_01T_00_01false_01_4.md)**
#### `public GetParameterReply `[`getParameter`](#group__request_1ga4fe8fa3391225c2790479d38ee6e8ec9)`(const std::string & path) const` {#group__request_1ga4fe8fa3391225c2790479d38ee6e8ec9} * **class [Status](Classes/classmcx__cpp_1_1Status.md)**
* **class [Subscribe](Classes/classmcx__cpp_1_1Subscribe.md)**
#### `public SubscriptionReply `[`createGroup`](#group__request_1gaf43939dd894f40759279cdae2db1fc4b)`(std::vector< std::string > path_list,const std::string & group_alias,size_t frequency_divider) const` {#group__request_1gaf43939dd894f40759279cdae2db1fc4b} * **class [Subscription](Classes/classmcx__cpp_1_1Subscription.md)**
* **struct [SharedState](Classes/structmcx__cpp_1_1Subscription_1_1SharedState.md)**
#### `public StatusReply `[`removeGroup`](#group__request_1ga2265e5c93d801c6d458936c0c225d002)`(const std::string & group_alias) const` {#group__request_1ga2265e5c93d801c6d458936c0c225d002} * **struct [Worker](Classes/structmcx__cpp_1_1Worker.md)**
* **class [WorkerHandle](Classes/classmcx__cpp_1_1WorkerHandle.md)**
#### `public WorkerHandle `[`getWorker`](#group__request_1ga80a298c33217ce25fd1eed07dd837010)`() const` {#group__request_1ga80a298c33217ce25fd1eed07dd837010} * **class [WorkerPool](Classes/classmcx__cpp_1_1WorkerPool.md)**
* **struct [measure](Classes/structmeasure.md)**
#### `public static McxStatus `[`send`](#group__request_1ga8880f52e569f160c255d0d0cc534b12f)`(WorkerHandle & worker)` {#group__request_1ga8880f52e569f160c255d0d0cc534b12f} * **namespace [motorcortex](Namespaces/namespacemotorcortex.md)**
* **struct [pb_bytes_array_s](Classes/structpb__bytes__array__s.md)**
# class `mcx_cpp::Request` {#classmcx__cpp_1_1Request} * **struct [pb_callback_s](Classes/structpb__callback__s.md)**
* **struct [pb_extension_s](Classes/structpb__extension__s.md)**
## Summary * **struct [pb_extension_type_s](Classes/structpb__extension__type__s.md)**
* **struct [pb_field_iter_s](Classes/structpb__field__iter__s.md)**
Members | Descriptions * **struct [pb_field_s](Classes/structpb__field__s.md)**
--------------------------------|--------------------------------------------- * **struct [pb_istream_s](Classes/structpb__istream__s.md)**
`public `[`Request`](#group__request_1ga0bf696d0a423087fbe17c221307636fd)`() = delete` | * **struct [pb_ostream_s](Classes/structpb__ostream__s.md)**
`public explicit `[`Request`](#group__request_1ga44c87d666fa137904e56bc5d1944d434)`(const `[`ParameterTree`](api_.md undefined#classmcx__cpp_1_1ParameterTree)` & parameter_tree)` | * **namespace [std](Namespaces/namespacestd.md)**
`public `[`~Request`](#group__request_1gac16054e325ff15f7d640dddef1c20567)`()` |
`public std::string `[`url`](#group__request_1gacfcdd3adb2b1211f4e44290ba169e3e0)`() const` |
`public ConnectionReply `[`connect`](#group__request_1ga98d0b1fa72a00894bb1f2e0d92ae9470)`(std::string url,size_t timeout_ms)` |
`public ConnectionReply `[`connect`](#group__request_1gaf7c3e05e562f529a60632e2e5cf1e566)`(std::string url,const `[`ConnectionOptions`](#structmcx__cpp_1_1ConnectionOptions)` & connection_options)` | -------------------------------
`public void `[`close`](#group__request_1ga27321c84e73a5cb48f279858c8c01191)`()` |
`public StatusReply `[`login`](#group__request_1ga563ffd90d911f4501b0cfd38a5d67cb6)`(std::string login,std::string password) const` | Updated on 7 February 2020 at 16:36:20 CET
`public ParameterTreeReply `[`getParameterTree`](#group__request_1ga78655693735ceedfc18d2d87d6a0d79b)`(size_t timeout_msec) const` | \ No newline at end of file
`public StatusReply `[`setParameter`](#group__request_1gaafe3905a109847c73bcdbd7a82dac92b)`(`[`SetParameter`](api_.md undefined#classmcx__cpp_1_1SetParameter)` value) const` |
`public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1gaf8c7e702165817675f352e5b364a3d5d)`(const std::string & path,const T & value) const` |
`public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1ga9bfa52fa512e4bb457693fd18e07315b)`(const std::string & path,const std::initializer_list< T > & value) const` |
`public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1ga5d80f31b02f2580c2876abc749125499)`(const std::string & path,const std::vector< T > & value) const` |
`public GetParameterReply `[`getParameter`](#group__request_1ga4fe8fa3391225c2790479d38ee6e8ec9)`(const std::string & path) const` |
`public SubscriptionReply `[`createGroup`](#group__request_1gaf43939dd894f40759279cdae2db1fc4b)`(std::vector< std::string > path_list,const std::string & group_alias,size_t frequency_divider) const` |
`public StatusReply `[`removeGroup`](#group__request_1ga2265e5c93d801c6d458936c0c225d002)`(const std::string & group_alias) const` |
`public `[`WorkerHandle`](api_.md undefined#classmcx__cpp_1_1WorkerHandle)` `[`getWorker`](#group__request_1ga80a298c33217ce25fd1eed07dd837010)`() const` |
## Members
#### `public `[`Request`](#group__request_1ga0bf696d0a423087fbe17c221307636fd)`() = delete` {#group__request_1ga0bf696d0a423087fbe17c221307636fd}
#### `public explicit `[`Request`](#group__request_1ga44c87d666fa137904e56bc5d1944d434)`(const `[`ParameterTree`](api_.md undefined#classmcx__cpp_1_1ParameterTree)` & parameter_tree)` {#group__request_1ga44c87d666fa137904e56bc5d1944d434}
#### `public `[`~Request`](#group__request_1gac16054e325ff15f7d640dddef1c20567)`()` {#group__request_1gac16054e325ff15f7d640dddef1c20567}
#### `public std::string `[`url`](#group__request_1gacfcdd3adb2b1211f4e44290ba169e3e0)`() const` {#group__request_1gacfcdd3adb2b1211f4e44290ba169e3e0}
#### `public ConnectionReply `[`connect`](#group__request_1ga98d0b1fa72a00894bb1f2e0d92ae9470)`(std::string url,size_t timeout_ms)` {#group__request_1ga98d0b1fa72a00894bb1f2e0d92ae9470}
#### `public ConnectionReply `[`connect`](#group__request_1gaf7c3e05e562f529a60632e2e5cf1e566)`(std::string url,const `[`ConnectionOptions`](#structmcx__cpp_1_1ConnectionOptions)` & connection_options)` {#group__request_1gaf7c3e05e562f529a60632e2e5cf1e566}
#### `public void `[`close`](#group__request_1ga27321c84e73a5cb48f279858c8c01191)`()` {#group__request_1ga27321c84e73a5cb48f279858c8c01191}
#### `public StatusReply `[`login`](#group__request_1ga563ffd90d911f4501b0cfd38a5d67cb6)`(std::string login,std::string password) const` {#group__request_1ga563ffd90d911f4501b0cfd38a5d67cb6}
#### `public ParameterTreeReply `[`getParameterTree`](#group__request_1ga78655693735ceedfc18d2d87d6a0d79b)`(size_t timeout_msec) const` {#group__request_1ga78655693735ceedfc18d2d87d6a0d79b}
#### `public StatusReply `[`setParameter`](#group__request_1gaafe3905a109847c73bcdbd7a82dac92b)`(`[`SetParameter`](api_.md undefined#classmcx__cpp_1_1SetParameter)` value) const` {#group__request_1gaafe3905a109847c73bcdbd7a82dac92b}
#### `public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1gaf8c7e702165817675f352e5b364a3d5d)`(const std::string & path,const T & value) const` {#group__request_1gaf8c7e702165817675f352e5b364a3d5d}
#### `public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1ga9bfa52fa512e4bb457693fd18e07315b)`(const std::string & path,const std::initializer_list< T > & value) const` {#group__request_1ga9bfa52fa512e4bb457693fd18e07315b}
#### `public template<>` <br/>`inline StatusReply `[`setParameter`](#group__request_1ga5d80f31b02f2580c2876abc749125499)`(const std::string & path,const std::vector< T > & value) const` {#group__request_1ga5d80f31b02f2580c2876abc749125499}
#### `public GetParameterReply `[`getParameter`](#group__request_1ga4fe8fa3391225c2790479d38ee6e8ec9)`(const std::string & path) const` {#group__request_1ga4fe8fa3391225c2790479d38ee6e8ec9}
#### `public SubscriptionReply `[`createGroup`](#group__request_1gaf43939dd894f40759279cdae2db1fc4b)`(std::vector< std::string > path_list,const std::string & group_alias,size_t frequency_divider) const` {#group__request_1gaf43939dd894f40759279cdae2db1fc4b}
#### `public StatusReply `[`removeGroup`](#group__request_1ga2265e5c93d801c6d458936c0c225d002)`(const std::string & group_alias) const` {#group__request_1ga2265e5c93d801c6d458936c0c225d002}
#### `public `[`WorkerHandle`](api_.md undefined#classmcx__cpp_1_1WorkerHandle)` `[`getWorker`](#group__request_1ga80a298c33217ce25fd1eed07dd837010)`() const` {#group__request_1ga80a298c33217ce25fd1eed07dd837010}
# struct `mcx_cpp::ConnectionOptions` {#structmcx__cpp_1_1ConnectionOptions}
## Summary
Members | Descriptions
--------------------------------|---------------------------------------------
`public std::string `[`certificate`](#group__request_1gac73902a245f268594fe43a2874ce2c41) |
`public size_t `[`timeout_msec`](#group__request_1ga590e32e59dca8a417bb0dd6e9273845b) |
## Members
#### `public std::string `[`certificate`](#group__request_1gac73902a245f268594fe43a2874ce2c41) {#group__request_1gac73902a245f268594fe43a2874ce2c41}
#### `public size_t `[`timeout_msec`](#group__request_1ga590e32e59dca8a417bb0dd6e9273845b) {#group__request_1ga590e32e59dca8a417bb0dd6e9273845b}