Interface IBluetoothRemoteDescriptor

Namespace

Bluetooth.Abstractions.Scanning

Assembly

Bluetooth.Abstractions.Scanning.dll

Interface representing a Bluetooth descriptor, providing properties and methods for interacting with it. Descriptors provide additional information about a characteristic (e.g., Client Characteristic Configuration Descriptor).

public interface IBluetoothRemoteDescriptor : INotifyPropertyChanged, IAsyncDisposable

Inherited Members

INotifyPropertyChanged.PropertyChanged

IAsyncDisposable.DisposeAsync()

Properties

CanRead

Gets a value indicating whether the descriptor can be read.

bool CanRead { get; }

Property Value

bool

CanWrite

Gets a value indicating whether the descriptor can be written to.

bool CanWrite { get; }

Property Value

bool

Characteristic

Gets the Bluetooth characteristic associated with this descriptor.

IBluetoothRemoteCharacteristic Characteristic { get; }

Property Value

IBluetoothRemoteCharacteristic

Id

Gets the unique identifier of the descriptor. This is typically a UUID that identifies the type of descriptor (e.g., Client Characteristic Configuration Descriptor has a well-known UUID).

Guid Id { get; }

Property Value

Guid

IsReadingValue

Gets a value indicating whether the descriptor is currently reading its value.

bool IsReadingValue { get; }

Property Value

bool

IsWritingValue

Gets a value indicating whether the descriptor is currently writing its value.

bool IsWritingValue { get; }

Property Value

bool

Name

The name of the Bluetooth descriptor. This is typically used for debugging and logging purposes, and may not be available for all descriptor. If the descriptor is not recognized, this will default to "Unknown Descriptor".

string Name { get; }

Property Value

string

Value

Gets the value of the descriptor as a read-only memory segment. Useful for asynchronous operations.

ReadOnlyMemory<byte> Value { get; }

Property Value

ReadOnlyMemory<byte>

ValueSpan

Gets the value of the descriptor as a read-only span. Useful for high-performance scenarios.

ReadOnlySpan<byte> ValueSpan { get; }

Property Value

ReadOnlySpan<byte>

Methods

ReadValueAsync(bool, TimeSpan?, CancellationToken)

Reads the value of the descriptor asynchronously.

ValueTask<ReadOnlyMemory<byte>> ReadValueAsync(bool skipIfPreviouslyRead = false, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

skipIfPreviouslyRead bool

If true, skips reading if the value was previously read.

timeout TimeSpan?

The timeout for this operation

cancellationToken CancellationToken

A cancellation token to cancel this operation.

Returns

ValueTask<ReadOnlyMemory<byte>>

A task that represents the asynchronous read operation. The task result contains the value read.

Exceptions

DeviceNotConnectedException

Thrown when the device is not connected.

DescriptorCantReadException

Thrown when the descriptor doesn't support read operations.

DescriptorException

Thrown when the read operation fails.

TimeoutException

Thrown when the operation times out.

OperationCanceledException

Thrown when the operation is cancelled.

WaitForValueChangeAsync(Func<ReadOnlyMemory<byte>, bool>?, TimeSpan?, CancellationToken)

Waits for the value of the descriptor to change asynchronously.

ValueTask<ReadOnlyMemory<byte>> WaitForValueChangeAsync(Func<ReadOnlyMemory<byte>, bool>? valueFilter = null, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

valueFilter Func<ReadOnlyMemory<byte>, bool>

An optional filter function to apply to the value changes. If provided, the task completes only when the filter returns true.

timeout TimeSpan?

The timeout for this operation

cancellationToken CancellationToken

A cancellation token to cancel this operation.

Returns

ValueTask<ReadOnlyMemory<byte>>

A task that represents the asynchronous operation. The task result contains the new value of the descriptor.

WriteValueAsync(ReadOnlyMemory<byte>, bool, TimeSpan?, CancellationToken)

Writes a value to the descriptor asynchronously.

ValueTask WriteValueAsync(ReadOnlyMemory<byte> value, bool skipIfOldValueMatchesNewValue = false, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

value ReadOnlyMemory<byte>

The value to write.

skipIfOldValueMatchesNewValue bool

If true, skips writing if the old value matches the new value.

timeout TimeSpan?

The timeout for this operation

cancellationToken CancellationToken

A cancellation token to cancel this operation.

Returns

ValueTask

A task that represents the asynchronous write operation.

Exceptions

ArgumentNullException

Thrown when value is null.

DeviceNotConnectedException

Thrown when the device is not connected.

DescriptorCantWriteException

Thrown when the descriptor doesn't support write operations.

DescriptorException

Thrown when the write operation fails.

TimeoutException

Thrown when the operation times out.

OperationCanceledException

Thrown when the operation is cancelled.

Events

ValueUpdated

Event raised when the value of the descriptor is updated, only triggered when IsListening is true.

event EventHandler<ValueUpdatedEventArgs> ValueUpdated

Event Type

EventHandler<ValueUpdatedEventArgs>