VSQSnapInfoClient Class Reference

SNAP protocol's INFO Client implementation. More...

#include <VSQSnapINFOClient.h>

Inheritance diagram for VSQSnapInfoClient:

Collaboration diagram for VSQSnapInfoClient:

Public Types
enum	EPolling { GENERAL_INFO = VirgilIoTKit::VS_SNAP_INFO_GENERAL, STATISTICS = VirgilIoTKit::VS_SNAP_INFO_STATISTICS }
	Polling elements. More...
using	TEnumDevicesArray = QVector< VSQDeviceInfo >
	"Devices list" data type More...

Signals
void	fireDeviceInfo (const VSQDeviceInfo &deviceInfo)
	Signal "New information has been received". More...
void	fireNewDevice (const VSQDeviceInfo &deviceInfo)
	Signal "New device has been activated". More...

Public Member Functions
const VirgilIoTKit::vs_snap_service_t *	serviceInterface () override
	Get service interface. More...
VSQFeatures::EFeature	serviceFeature () const override
	Get service feature. More...
const QString &	serviceName () const override
	Get service name. More...
bool	changePolling (std::initializer_list< EPolling > pollingOptions, const VSQMac &deviceMac=broadcastMac, bool enable=true, quint16 periodSeconds=1)
	Change device's polling state. More...
bool	startFullPolling (const VSQMac &deviceMac=broadcastMac, quint16 periodSeconds=1)
	Start full polling. More...
const TEnumDevicesArray &	devicesList () const
	Get devices list. More...
Public Member Functions inherited from VSQSnapServiceBase
virtual	~VSQSnapServiceBase ()=default

Additional Inherited Members
Static Public Member Functions inherited from VSQSingleton< VSQSnapInfoClient >
static VSQSnapInfoClient &	instance ()
	Get static instance. More...

Detailed Description

SNAP protocol's INFO Client implementation.

Use VSQIoTKitFacade::init to initialize this class

Member Typedef Documentation

TEnumDevicesArray

using VSQSnapInfoClient::TEnumDevicesArray = QVector<VSQDeviceInfo>

"Devices list" data type

Member Enumeration Documentation

EPolling

enum VSQSnapInfoClient::EPolling

Polling elements.

Enumerator
GENERAL_INFO	General information.
STATISTICS	Statistics information.

Member Function Documentation

changePolling()

bool VSQSnapInfoClient::changePolling	(	std::initializer_list< EPolling >	pollingOptions,
		const VSQMac &	deviceMac = broadcastMac,
		bool	enable = true,
		quint16	periodSeconds = 1
	)

Change device's polling state.

Parameters

pollingOptions	Polling options list
deviceMac	Device's MAC address. broadcastMac is used by default for broadcast polling options
enable	Enable pollingOptions. True by default
periodSeconds	Polling period in seconds. 1 second is used by default

Returns

Here is the caller graph for this function:

devicesList()

const TEnumDevicesArray& VSQSnapInfoClient::devicesList ( ) const

inline

Get devices list.

Returns

Current devices list

fireDeviceInfo

void VSQSnapInfoClient::fireDeviceInfo ( const VSQDeviceInfo &  deviceInfo )

signal

Signal "New information has been received".

Parameters

deviceInfo

Device information

fireNewDevice

void VSQSnapInfoClient::fireNewDevice ( const VSQDeviceInfo &  deviceInfo )

signal

Signal "New device has been activated".

Parameters

deviceInfo

Device information

serviceFeature()

VSQFeatures::EFeature VSQSnapInfoClient::serviceFeature ( ) const

inlineoverridevirtual

Get service feature.

Returns

Service feature

Implements VSQSnapServiceBase.

serviceInterface()

const VirgilIoTKit::vs_snap_service_t* VSQSnapInfoClient::serviceInterface ( )

inlineoverridevirtual

Get service interface.

Returns

Service interface

Implements VSQSnapServiceBase.

serviceName()

const QString& VSQSnapInfoClient::serviceName ( ) const

inlineoverridevirtual

Get service name.

Returns

Service name

Implements VSQSnapServiceBase.

startFullPolling()

bool VSQSnapInfoClient::startFullPolling ( const VSQMac &  deviceMac = broadcastMac, quint16  periodSeconds = 1  )

inline

Start full polling.

Parameters

deviceMac	Device's MAC address. broadcastMac is used by default for broadcast polling options
periodSeconds	Polling period in seconds. 1 second is used by default

Returns

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• VSQSnapINFOClient.h