Skip to content

Class espos::flow::Poll

template <typename T, typename Fn>

ClassList > espos > flow > Poll

  • #include <espos_flow/nodes.hpp>

Inherits the following classes: espos::flow::NodeBase, espos::flow::Producer

Public Types inherited from espos::flow::Producer

See espos::flow::Producer

Type Name
typedef T produces_type

Public Attributes inherited from espos::flow::NodeBase

See espos::flow::NodeBase

Type Name
NodeBase * next_node = [**nullptr**](classespos_1_1flow_1_1Poll.md)

Public Functions

Type Name
Poll (const char * id, uint32_t period_ms, Fn fn)
uint32_t period_ms () const
void read_now ()
void set_period (uint32_t ms)
esp_err_t start ()
void stop ()

Public Functions inherited from espos::flow::NodeBase

See espos::flow::NodeBase

Type Name
NodeBase (const char * id="")
NodeBase (const NodeBase &) = delete
const char * id () const
NodeBase & operator= (const NodeBase &) = delete
const char * title () const
NodeBase & with_title (const char * t)
~NodeBase () = default

Public Functions inherited from espos::flow::Producer

See espos::flow::Producer

Type Name
Sink & connect_to (Sink & sink)
std::size_t edge_count () const
void emit (const T & value)
uint32_t emitted_at_ms () const
const T & get () const
bool has_value () const
Sink & operator>> (Sink & sink)

Protected Functions

Type Name
virtual const char * node_id_for_error () override const

Protected Functions inherited from espos::flow::NodeBase

See espos::flow::NodeBase

Type Name
void set_id (const char * id)

Protected Functions inherited from espos::flow::Producer

See espos::flow::Producer

Type Name
virtual const char * node_id_for_error () const
~Producer () = default

Public Functions Documentation

function Poll

inline espos::flow::Poll::Poll (
    const  char * id,
    uint32_t period_ms,
    Fn fn
)

function period_ms

inline uint32_t espos::flow::Poll::period_ms () const

function read_now

inline void espos::flow::Poll::read_now ()

function set_period

inline void espos::flow::Poll::set_period (
    uint32_t ms
)

function start

inline esp_err_t espos::flow::Poll::start ()

function stop

inline void espos::flow::Poll::stop ()

Protected Functions Documentation

function node_id_for_error

inline virtual const  char * espos::flow::Poll::node_id_for_error () override const

Implements espos::flow::Producer::node_id_for_error

The documentation for this class was generated from the following file espos_flow/include/espos_flow/nodes.hpp