github/esphome
2
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-09-11 23:37:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

[api] Address review: make ActiveClientsView read-only WRT ownership

Browse Source 
Change the view to hold `const unique_ptr<APIConnection>&` so external
callers can't reset() or move slots — which would break the
api_connection_count_ invariant. Callers still get a non-const
APIConnection& on dereference (via `(*ptr).method()`), so all existing
call sites work unchanged.

active_clients() is now const-qualified since it only returns a view
over const unique_ptrs.
This commit is contained in:
J. Nick Koston
2026-04-21 12:13:12 +02:00
parent df53dff97a
commit 69896446c5
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esphome/components/api/api_server.h
+9 -7
View File
@@ -190,18 +190,20 @@ class APIServer final : public Component,
bool is_connected() const { return this->api_connection_count_ != 0; }
bool is_connected_with_state_subscription() const;
// Range-for view over the populated slice [0, api_connection_count_).
// Range-for view over the populated slice [0, api_connection_count_). Read-only with respect
// to ownership — callers get `const unique_ptr&` so they can invoke non-const methods on the
// APIConnection but cannot reset/move the slot and break the count invariant.
using APIConnectionPtr = std::unique_ptr<APIConnection>;
class ActiveClientsView {
APIConnectionPtr *begin_;
APIConnectionPtr *end_;
const APIConnectionPtr *begin_;
const APIConnectionPtr *end_;
public:
ActiveClientsView(APIConnectionPtr *b, APIConnectionPtr *e) : begin_(b), end_(e) {}
APIConnectionPtr *begin() { return this->begin_; }
APIConnectionPtr *end() { return this->end_; }
ActiveClientsView(const APIConnectionPtr *b, const APIConnectionPtr *e) : begin_(b), end_(e) {}
const APIConnectionPtr *begin() const { return this->begin_; }
const APIConnectionPtr *end() const { return this->end_; }
};
ActiveClientsView active_clients() {
ActiveClientsView active_clients() const {
return {this->clients_.data(), this->clients_.data() + this->api_connection_count_};
}