Properties of a discovered characteristic. More...

#include <DiscoveredCharacteristic.h>

Public Member Functions
bool	broadcast () const
	Return the value of the broadcast propertie. More...

bool	read () const
	Return the value of the read property. More...

bool	writeWoResp () const
	Return the value of the write without response property. More...

bool	write () const
	Return the value of the write property. More...

bool	notify () const
	Return the value of the notification property. More...

bool	indicate () const
	Return the value of the indicate property. More...

bool	authSignedWrite () const
	Return the value of the authenticated signed writes property. More...

Data Fields
uint8_t	_broadcast:1
	Permits broadcasts of the characteristic value using the character the Server Characteristic Configuration Descriptor. More...

uint8_t	_read:1
	If set, the value of the characteristic can be read. More...

uint8_t	_writeWoResp:1
	If set, a write command can write the characteristic value (write without response). More...

uint8_t	_write:1
	If set, clients can issue requests to write the characteristic. More...

uint8_t	_notify:1
	If set, the server can emit notifications of the Characteristic Value (without client acknowledgment). More...

uint8_t	_indicate:1
	If set, the server can emit indication of the Characteristic Value (with client acknowledgement). More...

uint8_t	_authSignedWrite:1
	If set, signed write of the Characteristic Value is supported. More...

Friends
bool	operator== (Properties_t lhs, Properties_t rhs)
	Equal to operator for DiscoveredCharacteristic::Properties_t. More...

bool	operator!= (Properties_t lhs, Properties_t rhs)
	Not equal to operator for DiscoveredCharacteristic::Properties_t. More...

Detailed Description

Properties of a discovered characteristic.

Definition at line 99 of file gatt/DiscoveredCharacteristic.h.

Member Function Documentation

bool authSignedWrite ( ) const

Return the value of the authenticated signed writes property.

Returns: true if the characteristic accepts authenticated signed write and false otherwise.

Definition at line 242 of file gatt/DiscoveredCharacteristic.h.

bool broadcast ( ) const

Return the value of the broadcast propertie.

Returns: true if the Server Characteristic Configuration Descriptor of the characteristic can be configured to broadcast the characteristic value during broadcast procedure.

See also: _broadcast

Definition at line 158 of file gatt/DiscoveredCharacteristic.h.

bool indicate ( ) const

Return the value of the indicate property.

Returns: true if the Client Characteristic Configuration Descriptor can be configured to indicate the characteristic value to a given client and false otherwise.

Note: unlike notification the indication procedure does require acknowledgment from the client.

See also: _indicate

Definition at line 231 of file gatt/DiscoveredCharacteristic.h.

bool notify ( ) const

Return the value of the notification property.

Returns: true if the Client Characteristic Configuration Descriptor can be configured to notify the characteristic value to a given client and false otherwise.

Note: unlike indication, the notification procedure does not require acknowledgement from the client.

See also: _notify

Definition at line 214 of file gatt/DiscoveredCharacteristic.h.

bool read ( ) const

Return the value of the read property.

Returns: true if the characteristic value can be read and false otherwise.

See also: _read

Definition at line 171 of file gatt/DiscoveredCharacteristic.h.

bool write ( ) const

Return the value of the write property.

Returns: true if writing the characteristic accepts write requests and false otherwise.

See also: _write

Definition at line 197 of file gatt/DiscoveredCharacteristic.h.

bool writeWoResp ( ) const

Return the value of the write without response property.

Returns: true if the characteristic accepts write without response commands and false otherwise.

See also: _writeWoResp

Definition at line 184 of file gatt/DiscoveredCharacteristic.h.

Friends And Related Function Documentation

bool operator!=	(	Properties_t	lhs,
		Properties_t	rhs
	)

friend

Not equal to operator for DiscoveredCharacteristic::Properties_t.

Parameters

lhs	The left hand side of the expression.
rhs	The right hand side of the expression.

Returns: true if operands are not equals, false otherwise.

Definition at line 274 of file gatt/DiscoveredCharacteristic.h.

bool operator==	(	Properties_t	lhs,
		Properties_t	rhs
	)

friend

Equal to operator for DiscoveredCharacteristic::Properties_t.

Parameters

[in]	lhs	The left hand side of the equality expression.
[in]	rhs	The right hand side of the equality expression.

Returns: true if operands are equals and false otherwise.

Definition at line 255 of file gatt/DiscoveredCharacteristic.h.

Field Documentation

uint8_t _authSignedWrite

If set, signed write of the Characteristic Value is supported.

Definition at line 146 of file gatt/DiscoveredCharacteristic.h.

uint8_t _broadcast

Permits broadcasts of the characteristic value using the character the Server Characteristic Configuration Descriptor.

Note: If set, descriptors of the characteristic contain a Server Characteristic Configuration Descriptor.

Definition at line 107 of file gatt/DiscoveredCharacteristic.h.

uint8_t _indicate

If set, the server can emit indication of the Characteristic Value (with client acknowledgement).

Note: If set, descriptors of the characteristic contain a Client Characteristic Configuration Descriptor.

Definition at line 141 of file gatt/DiscoveredCharacteristic.h.

uint8_t _notify

If set, the server can emit notifications of the Characteristic Value (without client acknowledgment).

Note: If set, descriptors of the characteristic contain a Client Characteristic Configuration Descriptor.

Definition at line 132 of file gatt/DiscoveredCharacteristic.h.

uint8_t _read

If set, the value of the characteristic can be read.

Definition at line 112 of file gatt/DiscoveredCharacteristic.h.

uint8_t _write

If set, clients can issue requests to write the characteristic.

Definition at line 123 of file gatt/DiscoveredCharacteristic.h.

uint8_t _writeWoResp

If set, a write command can write the characteristic value (write without response).

Definition at line 118 of file gatt/DiscoveredCharacteristic.h.

Public Member Functions

Data Fields

Friends

Detailed Description

Member Function Documentation

Friends And Related Function Documentation

Field Documentation

Important Information for this Arm website