The class implements the work with Regulators VPT LAN v1.0. Allows us to process and execute the commands from server. It means modify state of proper device. More...

#include <VPTDeviceManager.h>

Inheritance diagram for BeeeOn::VPTDeviceManager:

Data Structures
class	VPTSeeker
	Provides searching vpt devices on network in own thread. Also takes care of thread where is the listen command performed. More...

Public Member Functions
void	run () override

void	stop () override

void	setDevicePoller (DevicePoller::Ptr poller)

void	setRefresh (const Poco::Timespan &refresh)

void	setPingTimeout (const Poco::Timespan &timeout)

void	setHTTPTimeout (const Poco::Timespan &timeout)

void	setMaxMsgSize (int size)

void	setBlackList (const std::list< std::string > &list)

void	setPath (const std::string &path)

void	setPort (const int port)

void	setMinNetMask (const std::string &minNetMask)

void	setGatewayInfo (Poco::SharedPtr< GatewayInfo > gatewayInfo)

void	setCredentialsStorage (Poco::SharedPtr< CredentialsStorage > storage)

void	setCryptoConfig (Poco::SharedPtr< CryptoConfig > config)

Public Member Functions inherited from BeeeOn::DeviceManager
	DeviceManager (const DevicePrefix &prefix, const std::initializer_list< std::type_index > &acceptable={})

DevicePrefix	prefix () const override

void	setDeviceCache (DeviceCache::Ptr cache)

void	setDistributor (Poco::SharedPtr< Distributor > distributor)

bool	accept (const Command::Ptr cmd) override

void	handle (Command::Ptr cmd, Answer::Ptr answer) override

void	handleRemoteStatus (const DevicePrefix &prefix, const std::set< DeviceID > &devices, const DeviceStatusHandler::DeviceValues &values) override
	Called when devices from a remote server are fetched and so the pairing status of them can be reconsidered. The default implementation just updates the device cache appropriately.

Public Member Functions inherited from BeeeOn::CommandSender
void	setCommandDispatcher (CommandDispatcher *dispatcher)

void	dispatch (Poco::AutoPtr< Command > cmd, Poco::AutoPtr< Answer > answer)

void	dispatch (Poco::AutoPtr< Command > cmd)

AnswerQueue &	answerQueue ()

Protected Member Functions
void	handleGeneric (const Command::Ptr cmd, Result::Ptr result) override

void	handleAccept (const DeviceAcceptCommand::Ptr cmd) override
	Generic handler of the DeviceAcceptCommand. It might be helpful to override this method in case we need to make some technology-specific check of the device to be accepted. The default implementation simply marks the given device as paired.

AsyncWork::Ptr	startDiscovery (const Poco::Timespan &timeout) override
	Starts device discovery process in a technology-specific way. This method is always called inside a critical section and so its implementation does not have to be thread-safe nor reentrant (unless it cooperates with other threads itself). More...

AsyncWork< std::set< DeviceID > >::Ptr	startUnpair (const DeviceID &id, const Poco::Timespan &timeout) override
	Starts device unpair process in a technology-specific way. This method is always called inside a critical section and so its implementation does not have to be thread-safe nor reentrant (unless it cooperates with other threads itself). More...

void	searchPairedDevices ()
	Initialized search of paired devices that were obtained by deviceList().

bool	isAnySubdevicePaired (VPTDevice::Ptr device)
	Examines if any subdevice is paired for the VPT given in the parametr.

void	modifyValue (const DeviceSetValueCommand::Ptr cmd)
	Sets the proper device's module to given value. More...

bool	noSubdevicePaired (const DeviceID &id) const
	Returns true if any subdevice is paired. More...

std::vector< VPTDevice::Ptr >	seekDevices (const StopControl &stop)
	Searchs the devices on the network.

void	processNewDevice (Poco::SharedPtr< VPTDevice > newDevice)
	Processes a new device. It means saving the new device and informing the server about it.

std::string	findPassword (const DeviceID &id)
	Tries to find password credential for VPT by the given DeviceID from the credentials storage. If the password is not found the NotFoundException is thrown. More...

Protected Member Functions inherited from BeeeOn::DeviceManager
std::set< DeviceID >	waitRemoteStatus (const Poco::Timespan &timeout)
	Wait until the remote status is delivered or timeout exceeds. DO NOT USE this method, it is intended as a transition mechanism from calling of the deprecated method deviceList(). More...

void	handleListen (const GatewayListenCommand::Ptr cmd)
	Implements handling of the listen command in a generic way. The method ensures that only 1 thread can execute the discovery process at a time. More...

virtual AsyncWork::Ptr	startSearch (const Poco::Timespan &timeout, const Poco::Net::IPAddress &address)
	Start searching a device by IP address in a technology-specific way. This method is always called inside a critical section and so its implementation does not have to be thread-safe nor reentrant (unless it cooperates with other threads itself). More...

virtual AsyncWork::Ptr	startSearch (const Poco::Timespan &timeout, const MACAddress &address)
	Start searching a device by MAC address in a technology-specific way. This method is always called inside a critical section and so its implementation does not have to be thread-safe nor reentrant (unless it cooperates with other threads itself). More...

virtual AsyncWork::Ptr	startSearch (const Poco::Timespan &timeout, const uint64_t serialNumber)
	Start searching a device by serial number in a technology-specific way. This method is always called inside a critical section and so its implementation does not have to be thread-safe nor reentrant (unless it cooperates with other threads itself). More...

void	handleSearch (const DeviceSearchCommand::Ptr cmd)
	Implements handling of the search command in a generic way. The method ensures that only 1 thread can exactly the search process at a time. It is also mutual exclusive to the discovery process.

std::set< DeviceID >	handleUnpair (const DeviceUnpairCommand::Ptr cmd)
	Implements handling of the unpair command in a generic way. The method ensures that only 1 thread can execute the unpair process at a time. More...

virtual AsyncWork< double >::Ptr	startSetValue (const DeviceID &id, const ModuleID &module, const double value, const Poco::Timespan &timeout)
	Starts set-value operation in a technology specific way. The method is always called inside a critical section and so its implementation does not have to be thread-save nor reentrant (unless it cooperates with other threads itself). More...

AsyncWork< double >::Ptr	startSetValueByMode (const DeviceID &id, const ModuleID &module, const double value, const OpMode &mode, const Poco::Timespan &timeout)
	Call an implementation of startSetValue() based on the given operation mode.

virtual AsyncWork< double >::Ptr	startSetValueTryHarder (const DeviceID &id, const ModuleID &module, const double value, const Poco::Timespan &timeout)
	Default implementation just calls startSetValue().

virtual AsyncWork< double >::Ptr	startSetValueRepeatOnFail (const DeviceID &id, const ModuleID &module, const double value, const Poco::Timespan &timeout)
	Default implementation calls startSetValue() again if a Poco::IOException is thrown until timeout exceeds. However, due to asynchronous behaviour, this way of repeating on fail might be inappropriate.

void	handleSetValue (const DeviceSetValueCommand::Ptr cmd)
	Implements handling of the set-value command in a generic way. The method ensures that only 1 thread can execute set-value process at a time. If the set-value operation succeeds, it ships the set value. More...

void	ship (const SensorData &sensorData)

DeviceCache::Ptr	deviceCache () const

CancellableSet &	cancellable ()

Poco::Timespan	checkDelayedOperation (const std::string &opname, const Poco::Clock &started, const Poco::Timespan &duration) const
	When starting an asynchronous operation, it might happen we sleep too long on a lock because the previous operation did not finished yet. This method performs such checks and also tests for global stop request. If everything is in order it just fixes the duration by the time elapsed by waiting. Otherwise, it throws an exception. More...

bool	manageUntilFinished (const std::string &opname, AnyAsyncWork::Ptr work, const Poco::Timespan &timeout)
	Manage an AsyncWork after it is started. If it does not finish in the given timeout, it is cancelled explicitly. More...

Protected Member Functions inherited from BeeeOn::Loggable
void	setupLogger (Poco::Logger *logger=0) const

Poco::Logger &	logger () const

	Loggable (const ClassInfo &info)

	Loggable (const std::type_info &info)

Additional Inherited Members
Public Types inherited from BeeeOn::DeviceManager
typedef Poco::SharedPtr < DeviceManager >	Ptr

Public Types inherited from BeeeOn::DeviceStatusHandler
typedef Poco::SharedPtr < DeviceStatusHandler >	Ptr

typedef std::map< DeviceID, std::map< ModuleID, double > >	DeviceValues

Public Types inherited from BeeeOn::StoppableRunnable
typedef Poco::SharedPtr < StoppableRunnable >	Ptr

Protected Types inherited from BeeeOn::StoppableRunnable
typedef Poco::SharedPtr < StoppableRunnable >	Ptr

Static Protected Member Functions inherited from BeeeOn::Loggable
static Poco::Logger &	forMethod (const char *name)

static Poco::Logger &	forClass (const ClassInfo &info)

static Poco::Logger &	forClass (const std::type_info &info)

template<typename T >
static Poco::Logger &	forInstance (const T *i)

static void	configureSimple (Poco::Logger &logger, const std::string &level)

static void	logException (Poco::Logger &logger, const Poco::Message::Priority priority, const Poco::Exception &e, const char *file, size_t line)

Protected Attributes inherited from BeeeOn::DeviceManager
StopControl	m_stopControl

Detailed Description

The class implements the work with Regulators VPT LAN v1.0. Allows us to process and execute the commands from server. It means modify state of proper device.

Member Function Documentation

string VPTDeviceManager::findPassword ( const DeviceID & id )

protected

Tries to find password credential for VPT by the given DeviceID from the credentials storage. If the password is not found the NotFoundException is thrown.

Parameters

id	DeviceID of real VPT

void VPTDeviceManager::handleGeneric	(	const Command::Ptr	cmd,
		Result::Ptr	result
	)

overrideprotectedvirtual

Generic implementation of the handle(). If any device manager needs to override the handle() method, it is more desirable to override handleGeneric().

Reimplemented from BeeeOn::DeviceManager.

void VPTDeviceManager::modifyValue ( const DeviceSetValueCommand::Ptr cmd )

protected

Sets the proper device's module to given value.

Parameters

result Will contains information about the success of the request

bool VPTDeviceManager::noSubdevicePaired ( const DeviceID & id ) const

protected

Returns true if any subdevice is paired.

Parameters

id	DeviceID of real VPT

AsyncWork::Ptr VPTDeviceManager::startDiscovery ( const Poco::Timespan & timeout )

overrideprotectedvirtual

Starts device discovery process in a technology-specific way. This method is always called inside a critical section and so its implementation does not have to be thread-safe nor reentrant (unless it cooperates with other threads itself).

The purpose of this call is to initialize and start the discovery process which might be a non-blocking operation. The caller uses the provided AsyncWork<> instance to wait until it finishes or to cancel it earlier if needed.

Reimplemented from BeeeOn::DeviceManager.

AsyncWork< set< DeviceID > >::Ptr VPTDeviceManager::startUnpair	(	const DeviceID &	id,
		const Poco::Timespan &	timeout
	)

overrideprotectedvirtual

Starts device unpair process in a technology-specific way. This method is always called inside a critical section and so its implementation does not have to be thread-safe nor reentrant (unless it cooperates with other threads itself).

The unpairing process might be a non-blocking operation. The unpaired devices are provided via the result of the returned AsyncWork instance.

Reimplemented from BeeeOn::DeviceManager.

void VPTDeviceManager::stop ( )

overridevirtual

A generic stop implementation to be used by most DeviceManager implementations.

Reimplemented from BeeeOn::DeviceManager.

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

/var/lib/jenkins/workspace/beeeon-gateway-master/src/vpt/VPTDeviceManager.h
/var/lib/jenkins/workspace/beeeon-gateway-master/src/vpt/VPTDeviceManager.cpp

Data Structures

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation