Click or drag to resize
wclGattClientConnection Class
The class represents a Bluetooth LE GATT client connection.
Inheritance Hierarchy

Namespace: wclBluetooth
Assembly: wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.1.0.0 (7.1.0.0)

The wclGattClientConnection type exposes the following members.

Constructors
  NameDescription
Public methodwclGattClientConnection
Creates a new GATT client connection object.
Top
Properties
  NameDescription
Public propertyAddress
Gets a remote device MAC address.
Public propertyRadio
Gets the connection owner.
Protected propertyReceiver
Gets the connection message receiver object.
(Inherited from wclCustomConnection.)
Public propertyReliableWriteActive
Returns thr reliable write state.
Public propertyState
Gets the connection state.
(Inherited from wclClientConnection.)
Protected propertyThreadId
Gets the connection's thread ID.
(Inherited from wclCustomConnection.)
Public propertyTimeout
Gets the connect timeout value.
(Inherited from wclClientConnection.)
Top
Methods
  NameDescription
Public methodBeginReliableWrite
The method specifies that reliable writes are about to begin.
Public methodConnect(Int64)
Connects to a remote device.
Public methodConnect(UInt32)
Connects to a remote device.
(Inherited from wclClientConnection.)
Public methodDisconnect
Disconnects from the connected remote device.
(Inherited from wclClientConnection.)
Protected methodDoCharacteristicChanged
Fires the OnCharacteristicChanged event.
Protected methodDoConnect
Fires the OnConnect event.
(Inherited from wclClientConnection.)
Protected methodDoDisconnect
Fires the OnDisconnect event.
(Inherited from wclClientConnection.)
Public methodEndReliableWrite
The method specifies the end of reliable writes, and the writes should be committed.
Public methodEquals (Inherited from Object.)
Protected methodFinalize
Frees the connection.
(Inherited from wclClientConnection.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodHalBeginReliableWrite
The method specifies that reliable writes are about to begin.
Protected methodHalCommunicate
Implements a hardware depended code that communicate with the connected remote device.
(Inherited from wclClientConnection.)
Protected methodHalConnect
Implements a hardware depended code that connects to a remote device.
(Overrides wclClientConnectionHalConnect(WaitHandle).)
Protected methodHalDisconnect
Implements a hardware depended code that disconnects from the connected remote device.
(Overrides wclClientConnectionHalDisconnect.)
Protected methodHalEndReliableWrite
The method specifies the end of reliable writes, and the writes should be committed.
Protected methodHalGetReliableWriteActive
The getter for the ReliableWriteActive property.
Protected methodHalReadCharacteristics
Implements a hardware depended code for reading the characteristics available for the specified service.
Protected methodHalReadCharacteristicValue
Implements a hardware depended code for reading the value of the specified characteristic.
Protected methodHalReadDescriptors
The method reads all the descriptors available for the specified characteristic.
Protected methodHalReadDescriptorValue
Implements a hardware depended code for reading the value of the specified descriptor.
Protected methodHalReadIncludedServices
Implements a hardware depended code for reading the included services available for a given service.
Protected methodHalReadServices
Implements a hardware depended code for reading available services from a remote Bluetooth LE device.
Protected methodHalSubscribe
Subscribes for the characteristic changes notifications.
Protected methodHalUnsubscribe
Unsubscribes from the characteristic changes notifications.
Protected methodHalWriteCharacteristicValue
Implements a hardware depended code to write the specified characteristic value to the Bluetooth device.
Protected methodHalWriteDescriptorValue
Implements a hardware depended code to write the specified descriptor value to the Bluetooth device.
Protected methodInternalDisconnect
The internal disconnect method. Disconnects from a connected remote device.
(Inherited from wclClientConnection.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodMessageReceived
The method called when a new notification message received.
(Overrides wclClientConnectionMessageReceived(wclMessage).)
Protected methodNotifyClosed
Send a Disconnect notification message.
(Inherited from wclClientConnection.)
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 methodSubscribe
Subscribes for the characteristic changes notifications.
Public methodToString (Inherited from Object.)
Public methodUnsubscribe
Unsubscribes from the characteristic changes notifications.
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 completed (with or without success).
(Inherited from wclClientConnection.)
Public eventOnDisconnect
The event fires when the remote connected device has been disconnected.
(Inherited from wclClientConnection.)
Top
Remarks
An application must never create instances of this class directly. Instead of that an application must use related methods from the wclBluetoothRadio object.
See Also