Intermediate base for ListEntities*Response messages (proto (base_class) = "InfoResponseProtoMessage"). More...

Inheritance diagram for esphome::api::InfoResponseBase:

Collaboration diagram for esphome::api::InfoResponseBase:

Public Member Functions
virtual std::uint32_t	key () const =0

virtual const std::string &	name () const =0

virtual const std::string &	object_id () const =0

Public Member Functions inherited from esphome::api::ProtoMessage
	ProtoMessage ()=default

	ProtoMessage (const ProtoMessage &)=default

	ProtoMessage (ProtoMessage &&)=default

ProtoMessage &	operator= (const ProtoMessage &)=default

ProtoMessage &	operator= (ProtoMessage &&)=default

virtual	~ProtoMessage ()=default

virtual void	encode (ProtoWriter &writer) const =0
	Serialize this message's fields to `writer` (ascending field number).

virtual bool	decode (ProtoReader &reader)=0
	Decode wire bytes into this message.

virtual std::size_t	calculate_size () const =0
	Exact number of bytes `encode()` will write.

virtual std::uint32_t	message_id () const =0
	The protocol message id (the proto `(id)` option), or 0 if the message carries none.

virtual const char *	message_name () const =0
	The proto message name (e.g. "ListEntitiesLightResponse").

virtual std::unique_ptr< ProtoMessage >	clone () const =0
	A deep copy of this message as a new owning pointer.

std::size_t	ByteSizeLong () const
	Alias for calculate_size() — matches protobuf's API.

bool	SerializeToArray (void *data, const int size) const
	Serialize into a caller-provided buffer of exactly `size` bytes.

std::string	SerializeAsString () const
	Serialize to a freshly allocated string.

bool	ParseFromArray (const void *data, const int size)
	Parse wire bytes into this message. Returns false on malformed input.

Detailed Description

Intermediate base for ListEntities*Response messages (proto (base_class) = "InfoResponseProtoMessage").

Exposes the shared entity fields as virtuals so EntityStore can read them without reflection.

Member Function Documentation

virtual std::uint32_t esphome::api::InfoResponseBase::key ( ) const

pure virtual

virtual const std::string & esphome::api::InfoResponseBase::name ( ) const

pure virtual

virtual const std::string & esphome::api::InfoResponseBase::object_id ( ) const

pure virtual

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