Class IoT::Devices::SwitchServerHelper

File Information

Library: IoT/Devices
Package: Generated
Header: IoT/Devices/SwitchServerHelper.h

Description

The base class for switchable things (that can be turned on and off).

A Switch has a current state and a target state. Depending upon the implementation, the current state and target state may be different for a short amount of time (e.g., while the device is powering on).

In addition to the methods defined in this interface, a Switch implementation should expose the following properties:

displayState (string, optional): The current state of the Switch, formatted as string for display purposes.

Member Summary

Member Functions: createRemoteObject, enableEvents, registerObject, registerRemoteObject, shutdown, unregisterObject

Types Aliases

Service

using Service = IoT::Devices::Switch;

Constructors

SwitchServerHelper

SwitchServerHelper();

Creates a SwitchServerHelper.

Destructor

~SwitchServerHelper

~SwitchServerHelper();

Destroys the SwitchServerHelper.

Member Functions

createRemoteObject

static Poco::AutoPtr < IoT::Devices::SwitchRemoteObject > createRemoteObject(
Poco::SharedPtr < IoT::Devices::Switch > pServiceObject,
const Poco::RemotingNG::Identifiable::ObjectId & oid
);

Creates and returns a RemoteObject wrapper for the given IoT::Devices::Switch instance.

enableEvents

static void enableEvents(
const std::string & uri,
const std::string & protocol
);

Enables remote events for the RemoteObject identified by the given URI.

Events will be delivered using the Transport for the given protocol. Can be called multiple times for the same URI with different protocols.

registerObject

static std::string registerObject(
    Poco::SharedPtr < IoT::Devices::Switch > pServiceObject,
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    const std::string & listenerId
);

Creates a RemoteObject wrapper for the given IoT::Devices::Switch instance and registers it with the ORB and the Listener instance uniquely identified by the Listener's ID.

Returns the URI created for the object.

registerRemoteObject

static std::string registerRemoteObject(
Poco::AutoPtr < IoT::Devices::SwitchRemoteObject > pRemoteObject,
const std::string & listenerId
);

Registers the given RemoteObject with the ORB and the Listener instance uniquely identified by the Listener's ID.

Returns the URI created for the object.

shutdown

static void shutdown();

Removes the Skeleton for IoT::Devices::Switch from the ORB.

unregisterObject

static void unregisterObject(
const std::string & uri
);

Unregisters a service object identified by URI from the ORB.