Rtos API example

Embed: (wiki syntax)

« Back to documentation index

AttFindByTypeValueResponse Struct Reference

AttFindByTypeValueResponse Struct Reference

Find by type value responses are sent in response to find by type value request. More...

#include <AttServerMessage.h>

Inherits ble::pal::AttServerMessage.

Inherited by SimpleAttFindByTypeValueResponse.

Public Member Functions

 AttFindByTypeValueResponse ()
 Base constructor, setup the OpCode of the response.
virtual ~AttFindByTypeValueResponse ()
 virtual destructor to overide if the sub class needs it.
virtual std::size_t size () const =0
 Returns the number of attribute_handle_range_t present in the response.
virtual attribute_handle_range_t operator[] (size_t index) const =0
 Access to the attribute range present in the response.

Data Fields

const AttributeOpcode opcode
 Op code used to identify the type of the attribute response.

Detailed Description

Find by type value responses are sent in response to find by type value request.

The response contains a sequence of Found Attribute Handle, Group End Handle pair where:

  • Found Attribute Handle is the handle of an attribute matching the type and the value requested.
  • Group End Handle is the end of the attribute group if the attribute found is a grouping attribute or the same value as Found Attribute Handle if the attribute is not a grouping attribute.

This class should be subclassed by an implementation specific class defining the member function size and the subscript operator.

Note:
see BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part F Section 3.4.3.4

Definition at line 357 of file AttServerMessage.h.


Constructor & Destructor Documentation

Base constructor, setup the OpCode of the response.

Definition at line 361 of file AttServerMessage.h.

virtual ~AttFindByTypeValueResponse (  ) [virtual]

virtual destructor to overide if the sub class needs it.

Definition at line 368 of file AttServerMessage.h.


Member Function Documentation

virtual attribute_handle_range_t operator[] ( size_t  index ) const [pure virtual]

Access to the attribute range present in the response.

Note:
Out of range access is undefined.

Implemented in SimpleAttFindByTypeValueResponse.

virtual std::size_t size (  ) const [pure virtual]

Returns the number of attribute_handle_range_t present in the response.

Implemented in SimpleAttFindByTypeValueResponse.


Field Documentation

const AttributeOpcode opcode [inherited]

Op code used to identify the type of the attribute response.

Definition at line 102 of file AttServerMessage.h.