Click or drag to resize

wclGattClient Class

Bluetooth Low Energy GATT client.
Inheritance Hierarchy
SystemObject
  wclBluetoothwclBluetoothComponent
    wclBluetoothwclGattClient

Namespace: wclBluetooth
Assembly: wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.19.35.0 (7.19.35.0)
Syntax
Copy
public class wclGattClient : wclBluetoothComponent

The wclGattClient type exposes the following members.

Constructors
 NameDescription
Public methodwclGattClient Creates new TwclGattClient component.
Top
Properties
 NameDescription
Public propertyAddress Gets and sets a target Bluetooth device's MAC address.
Public propertyConnectOnRead Gets and sets connection mode.
Protected propertyCS Gets the critical section object.
(Inherited from wclBluetoothComponent)
Public propertyForceNotifications Gets and sets the notifications mode.
Public propertyRadio Gets the Radio used for connection.
Public propertyReliableWriteActive Gets a reliable write operation status.
Public propertyState Gets the client state.
Top
Methods
 NameDescription
Public methodAbortReliableWrite The method specifies the end of reliable write procedures, and the writes should be aborted.
Public methodBeginReliableWrite The method specifies that reliable writes are about to begin.
Public methodConnect Connects to a remote Bluetooth LE device.
Public methodDisconnect Disconnects from a remote device.
Protected methodDoCharacteristicChanged Fires the OnCharacteristicChanged event.
Protected methodDoConnect Fires the OnConnected event.
Protected methodDoConnectionParamsChanged Fires the OnConnectionParamsChanged event.
Protected methodDoConnectionPhyChanged Fires the OnConnectionPhyChanged event.
Protected methodDoDisconnect Fires then OnDisconnected event.
Protected methodDoMaxPduSizeChanged Fires the OnMaxPduSizeChanged event.
Public methodEndReliableWrite The method specifies the end of reliable writes, and the writes should be committed.
Public methodEqualsDetermines whether the specified Object is equal to the current Object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFindCharacteristic The method searches the characteristic in given service with the specified UUID.
Public methodFindService The method searches the service with specified UUID.
Public methodGetConnectionParams Gets the current connection parameters.
Public methodGetConnectionPhyInfo Reads the Bluetooth LE physical layer (PHY) information.
Public methodGetHashCodeServes as a hash function for a particular type.
(Inherited from Object)
Public methodGetMaxPayloadSize Reads the maximum payload size for the current connection.
Public methodGetMaxPduSize Reads the maximum PDU size for the current connection.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodReadCharacteristics The method reads all the characteristics available for the specified service.
Public methodReadCharacteristicValue The method reads the value of the specified characteristic.
Public methodReadDescriptors The method reads all the descriptors available for the specified characteristic.
Public methodReadDescriptorValue The method reads the value of the specified descriptor.
Public methodReadIncludedServices The method reads all the included services available for a given service.
Public methodReadServices Reads available services from a remote Bluetooth LE device.
Public methodSetConnectionParams(wclBluetoothLeConnectionParametersType) Request the connection parameters change to the specified preferred connection parameters.
Public methodSetConnectionParams(wclBluetoothLeConnectionParametersValue) Request the connection parameters change to the specified preferred connection parameters.
Public methodSubscribe Subscribes for the characteristic changes notifications.
Public methodSubscribeForNotifications Subscribes for the characteristic changes notifications and writes the client configuration descriptor to the device.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUnsubscribe Unsubscribes from the characteristic changes notifications.
Public methodUnsubscribeFromNotifications Unsubscribes from the characteristic changes notifications and writes the client configuration descriptor to the device.
Public methodWriteCharacteristicValue The method writes the specified characteristic value to the Bluetooth device.
Public methodWriteClientConfiguration Writes the client configuration descriptor to the device.
Public methodWriteDescriptorValue The method writes the specified descriptor value to the Bluetooth device.
Top
Events
 NameDescription
Public eventOnCharacteristicChanged The event fires when a subscribed characteristic value has been changed.
Public eventOnConnect The event fires when a connection to a remote device has been established.
Public eventOnConnectionParamsChanged The event fires when the connection parameters changed.
Public eventOnConnectionPhyChanged The event fires when the connection PHY changed.
Public eventOnDisconnect The even fires when a connection to a remote device has been closed.
Public eventOnMaxPduSizeChanged The event fires when the maximum PDU size changed.
Top
Remarks
The TwclGattClient component enables an application to connect to a Bluetooth Low Energy device and work with GATT profiles.
See Also