Class IoT::XBee::XBeeNodeServerHelper

File Information

Library: IoT/XBee
Package: Generated
Header: IoT/XBee/XBeeNodeServerHelper.h

Description

This class provides a high-level interface to a Digi XBee device using the Digi XBee API frame-based protocol. This class can be used with all XBee devices supporting the XBee API frame-based protocol, including ZigBee devices. Actually supported methods and events are depending on the kind of XBee device, e.g., an 802.15.4 module won't support ZigBee-specific API frames, and vice-versa. Please refer to the XBee product manual for detailed information about the API.

Member Summary

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

Types Aliases

Service

using Service = IoT::XBee::XBeeNode;

Constructors

XBeeNodeServerHelper

XBeeNodeServerHelper();

Creates a XBeeNodeServerHelper.

Destructor

~XBeeNodeServerHelper

~XBeeNodeServerHelper();

Destroys the XBeeNodeServerHelper.

Member Functions

createRemoteObject

static Poco::AutoPtr < IoT::XBee::XBeeNodeRemoteObject > createRemoteObject(
Poco::SharedPtr < IoT::XBee::XBeeNode > pServiceObject,
const Poco::RemotingNG::Identifiable::ObjectId & oid
);

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

Creates a RemoteObject wrapper for the given IoT::XBee::XBeeNode 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::XBee::XBeeNodeRemoteObject > 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::XBee::XBeeNode from the ORB.

unregisterObject

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

Unregisters a service object identified by URI from the ORB.