class INetworkEnvironmentService

File Information

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


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


Direct Base Classes: Poco::OSP::Service

All Base Classes: Poco::OSP::Service, Poco::RefCountedObject

Known Derived Classes: NetworkEnvironmentServiceRemoteObject

Member Summary

Member Functions: enumerateInterfaces, findActiveNetworkInterface, isA, remoting__enableEvents, remoting__typeId, type

Inherited Functions: duplicate, isA, referenceCount, release, type

Types Aliases


using Ptr = Poco::AutoPtr < INetworkEnvironmentService >;





~INetworkEnvironmentService virtual

virtual ~INetworkEnvironmentService();

Member Functions

enumerateInterfaces virtual

virtual std::vector < IoT::NetworkEnvironment::NetworkInterface > enumerateInterfaces(
    int options = int (0)
) = 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

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

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.

isA virtual

bool isA(
    const std::type_info & otherType
) const;

Returns true if the class is a subclass of the class given by otherType.

remoting__enableEvents virtual

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

Enable or disable delivery of remote events.

The given Listener instance must implement the Poco::RemotingNG::EventListener interface, otherwise this method will fail with a RemotingException.

This method is only used with Proxy objects; calling this method on a RemoteObject will do nothing.

remoting__typeId static

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

Returns the TypeId of the class.

type virtual

const std::type_info & type() const;

Returns the type information for the object's class.



Poco::BasicEvent < const IoT::NetworkEnvironment::ChangeType > networkEnvironmentChanged;

Securely control IoT edge devices from anywhere   Connect a Device