prova

Fork of BLE_API by Bluetooth Low Energy

Embed: (wiki syntax)

« Back to documentation index

DiscoveredCharacteristic::Properties_t Struct Reference

DiscoveredCharacteristic::Properties_t Struct Reference

Structure that encapsulates the properties of a discovered characteristic. More...

#include <DiscoveredCharacteristic.h>

Public Member Functions

bool broadcast (void) const
 Check if broadcasting is permitted.
bool read (void) const
 Check reading is permitted.
bool writeWoResp (void) const
 Check if writing with Write Command is permitted.
bool write (void) const
 Check if writing with Write Request is permitted.
bool notify (void) const
 Check notifications are permitted.
bool indicate (void) const
 Check if indications are permitted.
bool authSignedWrite (void) const
 Check if writing with Signed Write Command is permitted.

Data Fields

uint8_t _broadcast:1
 Broadcasting the value permitted.
uint8_t _read:1
 Reading the value permitted.
uint8_t _writeWoResp:1
 Writing the value with Write Command permitted.
uint8_t _write:1
 Writing the value with Write Request permitted.
uint8_t _notify:1
 Notifications of the value permitted.
uint8_t _indicate:1
 Indications of the value permitted.
uint8_t _authSignedWrite:1
 Writing the value with Signed Write Command permitted.

Friends

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

Detailed Description

Structure that encapsulates the properties of a discovered characteristic.

Definition at line 49 of file DiscoveredCharacteristic.h.


Member Function Documentation

bool authSignedWrite ( void   ) const

Check if writing with Signed Write Command is permitted.

Returns:
true if writing the value with Signed Write Command is permitted, false otherwise.

Definition at line 125 of file DiscoveredCharacteristic.h.

bool broadcast ( void   ) const

Check if broadcasting is permitted.

Returns:
true if broadcasting the value is permitted, and false otherwise.

Definition at line 65 of file DiscoveredCharacteristic.h.

bool indicate ( void   ) const

Check if indications are permitted.

Returns:
true if indications of the value are permitted, false otherwise.

Definition at line 115 of file DiscoveredCharacteristic.h.

bool notify ( void   ) const

Check notifications are permitted.

Returns:
true if notifications of the value are permitted, false otherwise.

Definition at line 105 of file DiscoveredCharacteristic.h.

bool read ( void   ) const

Check reading is permitted.

Returns:
true if reading the value is permitted, and false otherwise.

Definition at line 75 of file DiscoveredCharacteristic.h.

bool write ( void   ) const

Check if writing with Write Request is permitted.

Returns:
true if writing the value with Write Request is permitted, false otherwise.

Definition at line 95 of file DiscoveredCharacteristic.h.

bool writeWoResp ( void   ) const

Check if writing with Write Command is permitted.

Returns:
true if writing the value with Write Command is permitted, false otherwise.

Definition at line 85 of file 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:
lhsThe right hand side of the expression
rhsThe left hand side of the expression
Returns:
true if operands are not equals, false otherwise.

Definition at line 155 of file DiscoveredCharacteristic.h.

bool operator== ( Properties_t  lhs,
Properties_t  rhs 
) [friend]

"Equal to" operator for DiscoveredCharacteristic::Properties_t

Parameters:
[in]lhsThe left hand side of the equality expression
[in]rhsThe right hand side of the equality expression
Returns:
true if operands are equals, false otherwise.

Definition at line 137 of file DiscoveredCharacteristic.h.


Field Documentation

Writing the value with Signed Write Command permitted.

Definition at line 56 of file DiscoveredCharacteristic.h.

uint8_t _broadcast

Broadcasting the value permitted.

Definition at line 50 of file DiscoveredCharacteristic.h.

uint8_t _indicate

Indications of the value permitted.

Definition at line 55 of file DiscoveredCharacteristic.h.

uint8_t _notify

Notifications of the value permitted.

Definition at line 54 of file DiscoveredCharacteristic.h.

uint8_t _read

Reading the value permitted.

Definition at line 51 of file DiscoveredCharacteristic.h.

uint8_t _write

Writing the value with Write Request permitted.

Definition at line 53 of file DiscoveredCharacteristic.h.

uint8_t _writeWoResp

Writing the value with Write Command permitted.

Definition at line 52 of file DiscoveredCharacteristic.h.