IoT::NetworkEnvironment

class NetworkEnvironmentServiceRemoteObject

File Information

Library: IoT/NetworkEnvironment
Package: Generated
Header: IoT/NetworkEnvironment/NetworkEnvironmentServiceRemoteObject.h

Description

The NetworkEnvironmentService can be used to get notifications about network address and network interface changes.

Inheritance

Direct Base Classes: INetworkEnvironmentService, Poco::RemotingNG::RemoteObject

All Base Classes: INetworkEnvironmentService, Poco::OSP::Service, Poco::RefCountedObject, Poco::RemotingNG::Identifiable, Poco::RemotingNG::RemoteObject

Member Summary

Member Functions: enumerateInterfaces, event__networkEnvironmentChanged, findActiveNetworkInterface, remoting__enableEvents, remoting__enableRemoteEvents, remoting__hasEvents, remoting__typeId

Inherited Functions: duplicate, enumerateInterfaces, findActiveNetworkInterface, isA, mutex, referenceCount, release, remoting__enableEvents, remoting__enableRemoteEvents, remoting__getURI, remoting__hasEvents, remoting__objectId, remoting__setURI, remoting__typeId, type

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < NetworkEnvironmentServiceRemoteObject >;

Constructors

NetworkEnvironmentServiceRemoteObject

NetworkEnvironmentServiceRemoteObject(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    Poco::SharedPtr < IoT::NetworkEnvironment::NetworkEnvironmentService > pServiceObject
);

Destructor

~NetworkEnvironmentServiceRemoteObject virtual

virtual ~NetworkEnvironmentServiceRemoteObject();

Member Functions

enumerateInterfaces virtual inline

std::vector < IoT::NetworkEnvironment::NetworkInterface > enumerateInterfaces(
    int options = int (0)
);

Returns a vector containing available network interfaces. The options parameter can be used to include non-IP interfaces or interfaces that are down.

findActiveNetworkInterface virtual inline

virtual std::string findActiveNetworkInterface(
    IoT::NetworkEnvironment::IPVersion ipVersion
);

Finds and returns the name of the first active network interface that supports the given IP protocol version.

Throws a Poco::NotFoundException if no suitable network interface is found.

remoting__enableEvents virtual

virtual std::string remoting__enableEvents(
    Poco::RemotingNG::Listener::Ptr pListener,
    bool enable = bool (true)
);

remoting__enableRemoteEvents virtual

virtual void remoting__enableRemoteEvents(
    const std::string & protocol
);

remoting__hasEvents virtual

virtual bool remoting__hasEvents() const;

remoting__typeId virtual inline

virtual const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId() const;

event__networkEnvironmentChanged protected

void event__networkEnvironmentChanged(
    const IoT::NetworkEnvironment::ChangeType & data
);

Securely control IoT edge devices from anywhere   Connect a Device