CwclGattServerClient Class Reference

The class represents a GATT client connected to the GATT server. More...

#include <wclBluetooth.h>

Public Member Functions
	CwclGattServerClient (const __int64 Address, CwclGattServerConnection *const Connection)
	Creates new client object.
virtual	~CwclGattServerClient ()
	Frees the object.
int	Disconnect ()
	Disconnects the client from a server.
int	GetConnectionParams (wclBluetoothLeConnectionParameters &Params)
	Gets the current connection parameters.
int	SetConnectionParams (const wclBluetoothLeConnectionParametersType Params)
	Request the connection parameters change to the specified preferred connection parameters.
int	SetConnectionParams (const wclBluetoothLeConnectionParametersValue &Params)
	Request the connection parameters change to the specified preferred connection parameters.
int	GetMaxNotificationSize (unsigned short &Size)
	Reads the maximum notification size.
int	GetMaxPduSize (unsigned short &Size)
	Reads the maximum PDU size for the current connection.
int	GetConnectionPhyInfo (wclBluetoothLeConnectionPhy &Info)
	Reads the Bluetooth LE physical layer (PHY) information.
__int64	GetAddress () const
	Gets the client's address.
	__declspec (property(get=GetAddress)) __int64 Address
	Gets the client's address.
CwclGattLocalCharacteristic *	GetCharacteristics (const size_t Index) const
	Gets the subscribed characteristic by its index.
	__declspec (property(get=GetCharacteristics)) CwclGattLocalCharacteristic *Characteristics[]
	Gets the subscribed characteristic by its index.
CwclGattServerConnection *	GetConnection () const
	Gets the CwclGattServerConnection object that owns the client.
	__declspec (property(get=GetConnection)) CwclGattServerConnection *Connection
	Gets the CwclGattServerConnection object that owns the client.
size_t	GetCount () const
	Gets the subscribed characteristics count.
	__declspec (property(get=GetCount)) size_t Count
	Gets the subscribed characteristics count.
bool	GetSubscribed () const
	Gets the client subscribed status.
	__declspec (property(get=GetSubscribed)) bool Subscribed
	Gets the client subscribed status.

Protected Member Functions
virtual void	AfterConnect (CwclBluetoothGattServerClientParams *const Params)
	The method called right after client connected.
virtual void	AfterDisconnect ()
	The method right after a client disconnected from the server and before the client will be destroyed.
virtual void	AfterSubscribed (CwclGattLocalCharacteristic *const Characteristic)
	The method called right after the client subscribed to a characteristic.
virtual void	AfterUnsubscribed (CwclGattLocalCharacteristic *const Characteristic)
	The method called right after the client unsubscribed from a characteristic.
virtual int	HalDisconnect ()=0
	Provide a driver specific code to disconnect the client from a server.
virtual int	HalGetConnectionParams (wclBluetoothLeConnectionParameters &Params)=0
	Implements a hardware-dependent code to get the current connection parameters.
virtual int	HalSetConnectionParams (const wclBluetoothLeConnectionParametersType Params)=0
	Implements a hardware-dependent code to request the connection parameters change to the specified preferred connection parameters.
virtual int	HalSetConnectionParams (const wclBluetoothLeConnectionParametersValue &Params)=0
	Implements a hardware-dependent code to request the connection parameters change to the specified preferred connection parameters.
virtual int	HalGetMaxNotificationSize (unsigned short &Size)=0
	Provides a driver specific code to read the maximum notification size.
virtual int	HalGetMaxPduSize (unsigned short &Size)=0
	Implements a hardware-dependent code to read the maximum PDU size for the current connection.
virtual int	HalGetConnectionPhyInfo (wclBluetoothLeConnectionPhy &Info)=0
	Implements a hardware-dependent code to reads the Bluetooth LE physical layer (PHY) information.

Detailed Description

The class represents a GATT client connected to the GATT server.

An application must not create and destroy objects of this class directly. The objects of this class managed by the CwclGattServerConnection.

See also

CwclGattServerConnection