Inheritance diagram for esphome::api::ListEntitiesIterator:

Public Member Functions
	ListEntitiesIterator (APIConnection *client)

bool	on_service (UserServiceDescriptor *service) override

bool	on_camera (camera::Camera *entity) override

bool	on_end () override

Public Member Functions inherited from esphome::ComponentIterator
void	begin (bool include_internal=false)

ESPHOME_ALWAYS_INLINE void	try_advance (size_t max_steps)
	Run up to max_steps iteration steps; stops early when iteration completes or a callback refuses (that step is retried on the next call).

	ESPDEPRECATED ("Use try_advance() instead. Removed in 2027.3.0", "2026.8.1") void advance()

bool	completed () const

virtual bool	on_begin ()

Protected Attributes
APIConnection *	client_

Protected Attributes inherited from esphome::ComponentIterator
uint16_t	at_ {0}

IteratorState	state_ {IteratorState::NONE}

bool	yield_requested_: 1 {false}

bool	include_internal_: 1 {false}

Additional Inherited Members
Protected Types inherited from esphome::ComponentIterator
enum class	IteratorState : uint8_t { NONE = 0 , BEGIN , ENTITY_TYPE_ , ENTITY_CONTROLLER_TYPE_ , SERVICE , CAMERA , MAX }

Protected Member Functions inherited from esphome::ComponentIterator
void	yield_after_step_ ()
	End the current try_advance() pass after this step; lets callbacks that write directly to the socket cap direct writes per pass.

template<typename Container >
bool	process_platform_item_ (const Container &items, bool(ComponentIterator::*on_item)(typename Container::value_type))

bool	advance_step_ ()
	One iteration step; false if no progress was made (callback refused or iterator not running).

void	advance_platform_ ()

Detailed Description

Definition at line 18 of file list_entities.h.

Constructor & Destructor Documentation

esphome::api::ListEntitiesIterator::ListEntitiesIterator ( APIConnection * client )

Definition at line 95 of file list_entities.cpp.

bool esphome::api::ListEntitiesIterator::on_camera ( camera::Camera * entity )

overridevirtual

bool esphome::api::ListEntitiesIterator::on_end ( )

overridevirtual

bool esphome::api::ListEntitiesIterator::on_service ( UserServiceDescriptor * service )

overridevirtual

Definition at line 101 of file list_entities.cpp.

APIConnection* esphome::api::ListEntitiesIterator::client_

protected

Definition at line 41 of file list_entities.h.

The documentation for this class was generated from the following files: