LocalDescriptor — ble | Standard libraries

Class LocalDescriptor

Class summary

constructor characteristic/LocalCharacteristic uuid/BleUuid properties/int permissions/int value/Data

Constructors

constructor characteristic/LocalCharacteristic uuid/BleUuid properties/int permissions/int value/Data

Methods

handle -> int

The handle of the descriptor.

Typically, users do not need to access the handle directly. It may be useful for debugging purposes, but it is not required for normal operation.

is-closed -> bool

operator == other/any -> bool

Whether this object is equal to the other.

By default, identical is used for equality.

Inheritance

Classes overwrite this operator to get an equality specific to their needs. Equality operators often compare the type and field contents. For example:


class Pin:
  number/int

  constructor .number:

  operator == other:
    if other is not Pin: return false
    return number == other.number

A class doesn't have to follow the above format, but it must keep the operator in sync with any hash-code method. That is, if a class has a hash-code member, then the equality and hash-code must agree. If two instances are equal (a == b), then their hash codes must also be equal (a.hash-code == b.hash-code).

read -> ByteArray

Reads a value that is written to this descriptor.

set-value value/Data -> none

Sets the value of the descriptor.

This value is returned when a client reads the descriptor.

In most cases write is sufficient and easier to use. The main reason to use this function is to set a value without sending out any notification.

stringify -> string

Stringifies this object.