wclGattClientConnection Class

The class represents a Bluetooth LE GATT client connection.

Inheritance Hierarchy

SystemObject
  wclCommunicationwclCustomConnection
    wclCommunicationwclClientConnection
      wclBluetoothwclGattClientConnection

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

Syntax

C++

Copy

public abstract class wclGattClientConnection : wclClientConnection

Public MustInherit Class wclGattClientConnection
	Inherits wclClientConnection

public ref class wclGattClientConnection abstract : public wclClientConnection

The wclGattClientConnection type exposes the following members.

Constructors

	Name	Description
	wclGattClientConnection	Creates a new GATT client connection object.

Top

Properties

	Name	Description
	Address	Gets a remote device MAC address.
	ConnectOnRead	Gets connection mode.
	ForceNotifications	Gets the notifications mode.
	Radio	Gets the connection owner.
	Receiver	Gets the connection message receiver object. (Inherited from wclCustomConnection)
	State	Gets the connection state. (Inherited from wclClientConnection)
	ThreadId	Gets the connection's thread ID. (Inherited from wclCustomConnection)
	Timeout	Gets the connect timeout value. (Inherited from wclClientConnection)

Top

Methods

	Name	Description
	Connect(UInt32)	Connects to a remote device. (Inherited from wclClientConnection)
	Connect(Int64, Boolean, Boolean)	Connects to a remote device.
	Disconnect	Disconnects from the connected remote device. (Inherited from wclClientConnection)
	DoCharacteristicChanged	Fires the OnCharacteristicChanged event.
	DoConnect	Fires the OnConnect event. (Inherited from wclClientConnection)
	DoConnectionParamsChanged	Fires the OnConnectionParamsChanged event.
	DoConnectionPhyChanged	Fires the OnConnectionPhyChanged event.
	DoDisconnect	Fires the OnDisconnect event. (Inherited from wclClientConnection)
	DoMaxPduSizeChanged	Fires the OnPduMaxSizeChanged event.
	Enter	Enters the connection's critical section. (Inherited from wclCustomConnection)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object)
	Finalize	Frees the connection. (Inherited from wclClientConnection)
	GetConnectionParams	Gets the current connection parameters.
	GetConnectionPhyInfo	Reads the Bluetooth LE physical layer (PHY) information.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object)
	GetMaxPduSize	Reads the maximum PDU size for the current connection.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	HalCommunicate	Implements a hardware-dependent code that communicate with the connected remote device. (Inherited from wclClientConnection)
	HalConnect	Implements a hardware-dependent code that connects to a remote device. (Overrides wclClientConnectionHalConnect(IntPtr))
	HalDisconnect	Implements a hardware-dependent code that disconnects from the connected remote device. (Overrides wclClientConnectionHalDisconnect)
	HalGetConnectionParams	Implements a hardware-dependent code to get the current connection parameters.
	HalGetConnectionPhyInfo	Implements a hardware-dependent code to reads the Bluetooth LE physical layer (PHY) information.
	HalGetMaxPduSize	Implements a hardware-dependent code to reads the maximum PDU size for the current connection.
	HalReadCharacteristics	Implements a hardware-dependent code for reading the characteristics available for the specified service.
	HalReadCharacteristicValue	Implements a hardware-dependent code for reading the value of the specified characteristic.
	HalReadDescriptors	The method reads all the descriptors available for the specified characteristic.
	HalReadDescriptorValue	Implements a hardware-dependent code for reading the value of the specified descriptor.
	HalReadIncludedServices	Implements a hardware-dependent code for reading the included services available for a given service.
	HalReadServices	Implements a hardware-dependent code for reading available services from a remote Bluetooth LE device.
	HalSetConnectionParams(wclBluetoothLeConnectionParametersType)	Implements a hardware-dependent code to request the connection parameters change to the specified preferred connection parameters.
	HalSetConnectionParams(wclBluetoothLeConnectionParametersValue)	Implements a hardware-dependent code to request the connection parameters change to the specified preferred connection parameters.
	HalSubscribe	Implements a hardware-dependent code to subscribes for the characteristic changes notifications.
	HalUnsubscribe	Implements a hardware-dependent code to unsubscribes from the characteristic changes notifications.
	HalWriteCharacteristicValue	Implements a hardware-dependent code to write the specified characteristic value to the Bluetooth device.
	HalWriteDescriptorValue	Implements a hardware-dependent code to write the specified descriptor value to the Bluetooth device.
	InternalDisconnect	The internal disconnect method. Disconnects from a connected remote device. (Inherited from wclClientConnection)
	Leave	Exists *leaves) the connection's critical section. (Inherited from wclCustomConnection)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	MessageReceived	The method called when a new notification message received. (Overrides wclClientConnectionMessageReceived(wclMessage))
	NotifyClosed	Send a Disconnect notification message. (Inherited from wclClientConnection)
	PrepareForConnection	The method called internally before connection.
	ReadCharacteristics	The method reads all the characteristics available for the specified service.
	ReadCharacteristicValue	The method reads the value of the specified characteristic.
	ReadDescriptors	The method reads all the descriptors available for the specified characteristic.
	ReadDescriptorValue	The method reads the value of the specified descriptor.
	ReadIncludedServices	The method reads all the included services available for a given service.
	ReadServices	Reads available services from a remote Bluetooth LE device.
	SetConnectionParams(wclBluetoothLeConnectionParametersType)	Request the connection parameters change to the specified preferred connection parameters.
	SetConnectionParams(wclBluetoothLeConnectionParametersValue)	Request the connection parameters change to the specified preferred connection parameters.
	Subscribe	Subscribes for the characteristic changes notifications.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	Unsubscribe	Unsubscribes from the characteristic changes notifications.
	WriteCharacteristicValue	The method writes the specified characteristic value to the Bluetooth device.
	WriteClientConfiguration	Writes the client configuration descriptor to the device.
	WriteDescriptorValue	The method writes the specified descriptor value to the Bluetooth device.

Top

Events

	Name	Description
	OnCharacteristicChanged	The event fires when a subscribed characteristic value has been changed.
	OnConnect	The event fires when a connection to a remote device has been completed (with or without success). (Inherited from wclClientConnection)
	OnConnectionParamsChanged	The event fires when the connection parameters changed.
	OnConnectionPhyChanged	The event fires when the connection PHY changed.
	OnDisconnect	The event fires when the remote connected device has been disconnected. (Inherited from wclClientConnection)
	OnMaxPduSizeChanged	The event fires when the maximum PDU size changed.

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.

Reference

wclBluetooth Namespace

wclBluetoothRadio

wclClientConnection