Class IoT::Devices::IOServerHelper

File Information

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

Description

The interface for general purpose input/output (GPIO) ports.

This class represents a single GPIO pin. Mapping to physical pins is configured when setting up the specific IO implementation class, typically using a configuration file.

Implementations supporting dynamically changing pin directions should expose a string property named "direction" that takes the values "in" and "out".

Member Summary

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

Types Aliases

Service

using Service = IoT::Devices::IO;

Constructors

IOServerHelper

IOServerHelper();

Creates a IOServerHelper.

Destructor

~IOServerHelper

~IOServerHelper();

Destroys the IOServerHelper.

Member Functions

createRemoteObject

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

Creates and returns a RemoteObject wrapper for the given IoT::Devices::IO 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::IO > pServiceObject,
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    const std::string & listenerId
);

Creates a RemoteObject wrapper for the given IoT::Devices::IO 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::IORemoteObject > 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::IO from the ORB.

unregisterObject

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

Unregisters a service object identified by URI from the ORB.