|
| | BasicSession (PacketInterface *lower) |
| |
| void | setup () override |
| |
| void | dump_config () override |
| |
| bool | send_to_interface (const PacketBuffer &data, const PacketMetaData &meta_data) override |
| |
| void | set_keep_alive (uint32_t keep_alive_ms) |
| |
| void | set_session_timeout (uint32_t timeout_ms) |
| |
| void | set_connected_sensor (binary_sensor::BinarySensor *sensor) |
| |
| bool | is_connected () const |
| |
| size_t | get_max_packet_size () const |
| | The largest packet this layer accepts; fixed when the layer is constructed.
|
| |
| virtual size_t | get_send_capacity () const |
| | How many packets send_to_interface() would accept now, so a layer above can tell before sending a series.
|
| |
| uint8_t | get_capabilities () const |
| | The capabilities of this layer and every layer below it.
|
| |
| bool | has_capability (Capability capability) const |
| |
| template<typename F > |
| void | add_on_session_state_callback (F &&callback) |
| | With CAPABILITY_SESSION, the callback is called with true when the peer can be reached, including after it restarts, and with false when it is lost.
|
| |
| PacketInterface * | top () |
| | The topmost layer stacked on this one, or this one if nothing is stacked on it.
|
| |
| void | set_name (const char *name) |
| | Name shown in log messages; a layer takes the name of the link it is stacked on.
|
| |
| const char * | get_name () const |
| |
| template<typename F > |
| void | add_packet_interface_listener (F &&callback) |
| | Add a listener that will be called when data is received.
|
| |
| void | dump_config () override |
| |
| virtual void | loop () |
| | This method will be called repeatedly.
|
| |
| virtual float | get_setup_priority () const |
| | priority of setup().
|
| |
| float | get_actual_setup_priority () const |
| |
| void | set_setup_priority (float priority) |
| |
| void | call () |
| |
| virtual void | on_shutdown () |
| |
| virtual void | on_safe_shutdown () |
| |
| virtual bool | teardown () |
| | Called during teardown to allow component to gracefully finish operations.
|
| |
| virtual void | on_powerdown () |
| | Called after teardown is complete to power down hardware.
|
| |
| uint8_t | get_component_state () const |
| |
| void | reset_to_construction_state () |
| | Reset this component back to the construction state to allow setup to run again.
|
| |
| bool | is_in_loop_state () const |
| | Check if this component has completed setup and is in the loop state.
|
| |
| bool | is_idle () const |
| | Check if this component is idle.
|
| |
| void | mark_failed () |
| | Mark this component as failed.
|
| |
| void | mark_failed (const LogString *message) |
| |
| void | disable_loop () |
| | Disable this component's loop.
|
| |
| void | enable_loop () |
| | Enable this component's loop.
|
| |
| void | enable_loop_soon_any_context () |
| | Thread and ISR-safe version of enable_loop() that can be called from any context.
|
| |
| bool | is_failed () const |
| |
| bool | is_ready () const |
| |
| virtual bool | can_proceed () |
| |
| bool | status_has_warning () const |
| |
| bool | status_has_error () const |
| |
| void | status_set_warning () |
| |
| void | status_set_warning (const char *message) |
| |
| void | status_set_warning (const LogString *message) |
| |
| bool | status_comm_result (bool ok) |
| | Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
|
| |
| bool | status_comm_result (bool ok, const LogString *message) |
| |
| void | status_set_error () |
| |
| void | status_set_error (const LogString *message) |
| |
| void | status_clear_warning () |
| |
| void | status_clear_error () |
| |
| | ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name |
| |
| void | status_momentary_warning (uint32_t length=5000) |
| | Set warning status flag and clear it after length ms.
|
| |
| void | status_momentary_warning (const LogString *message, uint32_t length=5000) |
| |
| | ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name |
| |
| void | status_momentary_error (uint32_t length=5000) |
| | Set error status flag and clear it after length ms.
|
| |
| void | status_momentary_error (const LogString *message, uint32_t length=5000) |
| |
| bool | has_overridden_loop () const |
| |
| const LogString * | get_component_log_str () const ESPHOME_ALWAYS_INLINE |
| | Get the integration where this component was declared as a LogString for logging.
|
| |
| bool | should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out) |
| |
|
| void | receive_ (const PacketBuffer &data, const PacketMetaData &meta_data) |
| |
| void | on_interval_ () |
| |
| void | send_keep_alive_ () |
| |
| void | set_connected_ (bool connected) |
| |
| | PacketInterface (size_t max_packet_size) |
| |
| virtual | ~PacketInterface ()=default |
| |
| void | on_receive_from_interface_ (const PacketBuffer &data, const PacketMetaData &meta_data) |
| | This function should be called by implementing classes with received data to be passed to any listeners.
|
| |
| void | note_received_ (bool understood) |
| | Called by a layer for each received packet it understood, or could not make sense of.
|
| |
| void | stack_on_ (PacketInterface *lower, Capability capability) |
| | Called by a layer's constructor to record itself as the layer above lower, adding its own capability.
|
| |
| void | inherit_from_ (PacketInterface *lower, Capability capability) |
| | Takes the name and capabilities of lower without becoming its top, for one of several stacks on a link.
|
| |
| friend | void::setup () |
| |
| friend | void::original_setup () |
| |
| void | set_component_source_ (uint8_t index) |
| | Set where this component was loaded from for some debug messages.
|
| |
| virtual void | call_setup () |
| |
| void | call_dump_config_ () |
| |
| void | enable_loop_slow_path_ () |
| |
| void | set_component_state_ (uint8_t state) |
| | Helper to set component state (clears state bits and sets new state)
|
| |
| bool | set_status_flag_ (uint8_t flag) |
| | Helper to set a status LED flag on both this component and the app.
|
| |
| bool | set_error_flag_ (const LogString *message) |
| | Set the error flag and log it; true when it was not set before.
|
| |
| void | set_interval (const char *name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a const char* name.
|
| |
| void | set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a numeric ID (zero heap allocation).
|
| |
| void | set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f) |
| |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| |
| bool | cancel_interval (const char *name) |
| | Cancel an interval function.
|
| |
| bool | cancel_interval (uint32_t id) |
| |
| bool | cancel_interval (InternalSchedulerID id) |
| |
| void | set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a const char* name.
|
| |
| void | set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a numeric ID (zero heap allocation).
|
| |
| void | set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f) |
| |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| |
| bool | cancel_timeout (const char *name) |
| | Cancel a timeout function.
|
| |
| bool | cancel_timeout (uint32_t id) |
| |
| bool | cancel_timeout (InternalSchedulerID id) |
| |
| void | defer (const char *name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call with a const char* name.
|
| |
| void | defer (std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| void | defer (uint32_t id, std::function< void()> &&f) |
| | Defer a callback with a numeric ID (zero heap allocation)
|
| |
| bool | cancel_defer (const char *name) |
| | Cancel a defer callback using the specified name, name must not be empty.
|
| |
| bool | cancel_defer (uint32_t id) |
| |
| void | status_clear_warning_slow_path_ () |
| |
| void | status_clear_error_slow_path_ () |
| |
A session layer that reports whether the peer can be reached.
Every packet starts with a type byte. A data packet carries the payload of the layer above. A keep-alive packet carries a random number chosen at boot, so that a restart of the peer is noticed even if it is quicker than the timeout. A keep-alive is sent every keep_alive interval, and at once when a new peer is heard. The peer is considered gone when nothing has been received from it for the timeout; this is checked every keep_alive interval. A restart of the peer is reported as a disconnect followed by a connect. So is a reset of a reliability layer below, which discards data: the session is reported lost, and connected again when the peer is next heard.
Definition at line 22 of file basic_session.h.
Public Member Functions inherited from esphome::packet_interface::PacketInterface
1.12.0