ESPHome
2026.11.0b6
Loading...
Searching...
No Matches
esphome
components
packet_interface
basic_session.h
Go to the documentation of this file.
1
#pragma once
2
3
#include "
esphome/core/defines.h
"
4
#ifdef USE_PACKET_INTERFACE_BASIC_SESSION
5
#include "
packet_interface.h
"
6
#ifdef USE_BINARY_SENSOR
7
#include "
esphome/components/binary_sensor/binary_sensor.h
"
8
#endif
9
10
namespace
esphome::packet_interface
{
11
22
class
BasicSession
:
public
PacketInterface
{
23
#ifdef USE_BINARY_SENSOR
24
SUB_BINARY_SENSOR(connected)
25
#endif
26
27
public
:
29
static
constexpr
size_t
HEADER_SIZE = 1;
30
31
explicit
BasicSession
(
PacketInterface
*lower);
32
33
void
setup()
override
;
34
void
dump_config()
override
;
35
bool
send_to_interface(
const
PacketBuffer
&data,
const
PacketMetaData
&meta_data)
override
;
36
37
void
set_keep_alive(
uint32_t
keep_alive_ms) { this->
keep_alive_ms_
= keep_alive_ms; }
38
void
set_session_timeout(
uint32_t
timeout_ms) { this->
timeout_ms_
= timeout_ms; }
39
40
bool
is_connected()
const
{
return
this->
connected_
; }
41
42
protected
:
43
void
receive_
(
const
PacketBuffer
&data,
const
PacketMetaData
&meta_data);
44
void
on_interval_
();
45
void
send_keep_alive_
();
46
void
set_connected_
(
bool
connected);
47
48
PacketInterface
*
lower_
;
49
uint32_t
keep_alive_ms_
{10000};
50
uint32_t
timeout_ms_
{30000};
51
uint32_t
last_receive_ms_
{0};
52
uint32_t
boot_id_
{0};
53
uint32_t
peer_boot_id_
{0};
54
bool
peer_known_
{
false
};
55
bool
connected_
{
false
};
56
};
57
58
}
// namespace esphome::packet_interface
59
#endif
binary_sensor.h
esphome::packet_interface::BasicSession
A session layer that reports whether the peer can be reached.
Definition
basic_session.h:22
esphome::packet_interface::BasicSession::keep_alive_ms_
uint32_t keep_alive_ms_
Definition
basic_session.h:49
esphome::packet_interface::BasicSession::peer_known_
bool peer_known_
Definition
basic_session.h:54
esphome::packet_interface::BasicSession::lower_
PacketInterface * lower_
Definition
basic_session.h:48
esphome::packet_interface::BasicSession::send_keep_alive_
void send_keep_alive_()
Definition
basic_session.cpp:65
esphome::packet_interface::BasicSession::set_connected_
void set_connected_(bool connected)
Definition
basic_session.cpp:81
esphome::packet_interface::BasicSession::connected_
bool connected_
Definition
basic_session.h:55
esphome::packet_interface::BasicSession::timeout_ms_
uint32_t timeout_ms_
Definition
basic_session.h:50
esphome::packet_interface::BasicSession::on_interval_
void on_interval_()
Definition
basic_session.cpp:73
esphome::packet_interface::BasicSession::boot_id_
uint32_t boot_id_
Definition
basic_session.h:52
esphome::packet_interface::BasicSession::peer_boot_id_
uint32_t peer_boot_id_
Definition
basic_session.h:53
esphome::packet_interface::BasicSession::last_receive_ms_
uint32_t last_receive_ms_
Definition
basic_session.h:51
esphome::packet_interface::BasicSession::receive_
void receive_(const PacketBuffer &data, const PacketMetaData &meta_data)
Definition
basic_session.cpp:90
esphome::packet_interface::PacketBuffer
A buffer class that efficiently represents a composite buffer with three sections:
Definition
packet_buffer.h:24
esphome::packet_interface::PacketInterface
A class that will transport data to and from an abstract channel.
Definition
packet_interface.h:56
esphome::packet_interface::PacketMetaData
A struct to hold metadata about a packet.
Definition
packet_interface.h:37
defines.h
esphome::packet_interface
Definition
basic_session.cpp:7
packet_interface.h
uint32_t
static void uint32_t
Definition
crash_handler.cpp:153
Generated by
1.12.0