rpcbasic_register_trigger
rpcbasic_base
gnuradio/rpcregisterhelpers.h
typename T
std::string std::string rpcbasic_register_trigger< T >::d_id d_id rpcbasic_register_trigger::d_id
std::string std::string rpcbasic_register_trigger< T >::d_desc d_desc rpcbasic_register_trigger::d_desc
priv_lvl_t priv_lvl_t rpcbasic_register_trigger< T >::d_minpriv d_minpriv rpcbasic_register_trigger::d_minpriv
T * T* rpcbasic_register_trigger< T >::d_object d_object rpcbasic_register_trigger::d_object
rpcbasic_register_trigger< T >::rpcbasic_register_trigger
(const std::string &block_alias, const char *functionbase, void(T::*function)(), const char *desc_="", priv_lvl_t minpriv_=RPC_PRIVLVL_MIN)
rpcbasic_register_trigger
rpcbasic_register_trigger::rpcbasic_register_trigger
const std::string & block_alias
const char * functionbase
void(T::*)() function
const char * desc_ ""
priv_lvl_t minpriv_ RPC_PRIVLVL_MIN

Adds the ability to trigger a function over ControlPort.

This constructor is specifically for gr::block's to use to add trigger functions to ControlPort. Generally meant to be used in gr::block::setup_rpc.

Uses the block's alias to create the ControlPort interface. This alias is cross-referenced by the global_block_registry (static variable of type gr::block_registry) to get the pointer to the block.

block_alias

Block's alias; use alias() to get it from the block.

functionbase

The name of the function that we'll access over ControlPort

function

A function pointer to the real function accessed when called something like: &[block class]::set_[variable]

desc_

A string to describing the variable.

minpriv_

The required minimum privilege level

gr::block_registry::block_lookup
rpcmanager::get
global_block_registry
rpcserver_booter_base::i
pmt::intern
rpcserver_base::registerConfigureCallback
rpcbasic_register_trigger< T >::rpcbasic_register_trigger
(const std::string &name, const char *functionbase, T *obj, void(T::*function)(), const char *desc_="", priv_lvl_t minpriv_=RPC_PRIVLVL_MIN)
rpcbasic_register_trigger
rpcbasic_register_trigger::rpcbasic_register_trigger
const std::string & name
const char * functionbase
T * obj
void(T::*)() function
const char * desc_ ""
priv_lvl_t minpriv_ RPC_PRIVLVL_MIN

Adds the ability to trigger a function over ControlPort.

Allows us to add non gr::block related objects to ControlPort. Instead of using the block's alias, we give it a `name` and the actual pointer to the object as `obj`. We just need to make sure that the pointer to this object is always valid.

name

Name of the object being set up for ControlPort access

functionbase

The name of the function that we'll access over ControlPort

obj

A pointer to the object itself

function

A function pointer to the real function accessed when called something like: &[block class]::set_[variable]

desc_

A string to describing the variable.

minpriv_

The required minimum privilege level

rpcmanager::get
rpcserver_booter_base::i
rpcserver_base::registerConfigureCallback
rpcbasic_register_trigger< T >::~rpcbasic_register_trigger
() override
~rpcbasic_register_trigger
rpcbasic_register_trigger::~rpcbasic_register_trigger
rpcmanager::get
rpcserver_booter_base::i
rpcserver_base::unregisterConfigureCallback
std::string std::string rpcbasic_register_trigger< T >::description () const description rpcbasic_register_trigger::description
priv_lvl_t priv_lvl_t rpcbasic_register_trigger< T >::privilege_level () const privilege_level rpcbasic_register_trigger::privilege_level
void void rpcbasic_register_trigger< T >::description (std::string d) description rpcbasic_register_trigger::description std::string d
void void rpcbasic_register_trigger< T >::privilege_level (priv_lvl_t p) privilege_level rpcbasic_register_trigger::privilege_level priv_lvl_t p

Registers a 'trigger' function to trigger an action over ControlPort.

This class allows us to set up triggered events or function calls over ControlPort. When used from a ControlPort client, the `function` established here will be activated. Generally, this is meant to enable some kind of trigger or action that a block or object will perform, such as a reset, start, stop, etc.

Simpler than the rpcbasic_register_set class, the constructor here only takes a few parameters, mostly because there is not actual variable associated with these function calls. It takes in the information to set up the pointer to the object that has the `function`, a ControlPort name (`functionbase`) for the triggered action, a description (`desc_`), and a privilege level (`minpriv_`).

rpcbasic_base
rpcbasic_register_trigger< T >
rpcbasic_base
rpcbasic_register_trigger< T >
- rpcbasic_register_trigger
  d_desc
- rpcbasic_register_trigger
  d_id
- rpcbasic_register_trigger
  d_minpriv
- rpcbasic_register_trigger
  d_object
- rpcbasic_register_trigger
  description
- rpcbasic_register_trigger
  description
- rpcbasic_register_trigger
  privilege_level
- rpcbasic_register_trigger
  privilege_level
- rpcbasic_register_trigger
  rpcbasic_base
- rpcbasic_register_trigger
  rpcbasic_register_trigger
- rpcbasic_register_trigger
  rpcbasic_register_trigger
- rpcbasic_register_trigger
  ~rpcbasic_base
- rpcbasic_register_trigger
  ~rpcbasic_register_trigger