File Information
Library: IoT/NetworkEnvironment
Package: Generated
Header: IoT/NetworkEnvironment/INetworkEnvironmentService.h
Description
The NetworkEnvironmentService can be used to get notifications about network address and network interface changes.
Inheritance
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
Ptr
using Ptr = Poco::AutoPtr < INetworkEnvironmentService >;
Constructors
INetworkEnvironmentService
Creates a INetworkEnvironmentService.
Destructor
~INetworkEnvironmentService
virtual ~INetworkEnvironmentService();
Destroys the INetworkEnvironmentService.
Member Functions
enumerateInterfaces
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 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
bool isA(
const std::type_info & otherType
) const;
Returns true if the class is a subclass of the class given by otherType.
See also: Poco::OSP::Service::isA()
remoting__enableEvents
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 const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId();
Returns the TypeId of the class.
type
const std::type_info & type() const;
Returns the type information for the object's class.
See also: Poco::OSP::Service::type()
Variables
networkEnvironmentChanged
Poco::BasicEvent < const IoT::NetworkEnvironment::ChangeType > networkEnvironmentChanged;