Bluetooth Framework C++ Edition
Public Member Functions | Protected Member Functions | List of all members
CwclGattLocalCharacteristic Class Referenceabstract

This class represents a local GATT characteristic. More...

#include <wclBluetooth.h>

Inheritance diagram for CwclGattLocalCharacteristic:
CwclGattLocalAttribute

Public Member Functions

 CwclGattLocalCharacteristic (CwclGattLocalService *const Service, const wclGattUuid &Uuid, const wclGattLocalCharacteristicParameters &Params)
 Creates new local GATT characteristic.
 
virtual ~CwclGattLocalCharacteristic ()
 Frees the object.
 
int Notify (const __int64 Address, const unsigned char *const Data, const unsigned long Size) const
 Sends notification to the given subscribed client.
 
bool GetAdded () const
 Gets the characteristic's status.
 
 __declspec (property(get=GetAdded)) bool Added
 Gets the characteristic's status.
 
CwclGattServerClientGetClients (const size_t Index) const
 Gets the subscribed client by its index.
 
 __declspec (property(get=GetClients)) CwclGattServerClient *Clients[]
 Gets the subscribed client by its index.
 
size_t GetCount () const
 Gets the subscribed clients count.
 
 __declspec (property(get=GetCount)) size_t Count
 Gets the subscribed clients count.
 
int GetError () const
 Gets the characteristic's publishing error.
 
 __declspec (property(get=GetError)) int Error
 Gets the characteristic's publishing error.
 
wclGattLocalCharacteristicParameters GetParams () const
 Gets the characteristic's parameters.
 
 __declspec (property(get=GetParams)) wclGattLocalCharacteristicParameters Params
 Gets the characteristic's parameters.
 
CwclGattLocalServiceGetService () const
 Gets the GATT service object that owns the characteristic.
 
 __declspec (property(get=GetService)) CwclGattLocalService *Service
 Gets the GATT service object that owns the characteristic.
 
- Public Member Functions inherited from CwclGattLocalAttribute
 CwclGattLocalAttribute (const wclGattUuid &Uuid)
 Creates new local GATT attribute.
 
virtual ~CwclGattLocalAttribute ()
 Frees the object.
 
wclGattUuid GetUuid () const
 Gets the attribute's UUID.
 
 __declspec (property(get=GetUuid)) wclGattUuid Uuid
 Gets the attribute's UUID.
 

Protected Member Functions

virtual int HalAdd ()=0
 The method implements a driver specific code to add characteristic to the local GATT service.
 
virtual int HalRemove ()=0
 The method implements a driver specific code to remove characteristic from the local GATT service.
 
virtual int HalNotify (const __int64 Address, const unsigned char *const Data, const unsigned long Size) const =0
 The function implements a driver specific code to send notification to the given subscribed client.
 
- Protected Member Functions inherited from CwclGattLocalAttribute
void Enter () const
 Enters the GATT local attribute protection critical section.
 
void Leave () const
 Leaves the GATT local attribute protection critical section.
 

Detailed Description

This class represents a local GATT characteristic.

An application must not create or destroy this class directly. Instead of that an application must use methods of the

See also
CwclGattLocalService

class.

See also
CwclGattLocalAttribute