NetworkInfo

Overview - API | NetworkInfo | NetworkInfo-IPInfo

#include <alproxies/networkinfo.h>

Describes the status of a network service. Many information are available for the service like the state of a service or its signal strength.

std::string NetworkInfo::serviceId()
Returns:The identifier for the network service.
std::string NetworkInfo::name()

Return the name for the network service, for ethernet service the name is “Wired”, for WiFi services the name is the SSID name of the network, if the network service is hidden hte name is not set.,

Returns:the network name
std::string NetworkInfo::type()

Return the type of the network this can be:

  • “ethernet” for Ethernet service or Usb networking
  • “wifi” for WiFi service
  • “bluetooth” for Bluetooth service
Returns:the type of the service
std::string NetworkInfo::state()

Return the state of the service possible values are :

  • “online” this state signals that an Internet connection is available and verified

(Only one service can be online at the same time)

  • “ready” this state mean that the service is succefully connected
  • “configuration” this state mean that the services is getting is configuration like the IP address
  • “association” for a WiFi service this state represents the association to the services using the security parameter.
  • “idle” this state mean that no action have been made for this services.
  • “failure” this state mean that a connection tentative have failed. Use error() method to get the reason.
Returns:the state of the service
bool NetworkInfo::favorite()

Will be true if a cable is plugged in or the user selected and successfully connected to this service.

This value is automatically changed and to revert it back to false, the method ALConnectionManagerProxy::forget() needs to be used.

Returns:true if the service is marked as favorite false instead
bool NetworkInfo::autoconnect()

If set to true, this service will auto-connect when no other connection is available. This can be be set to false to prevent automatic connection without calling forget() method of ALConnectionManager.

Returns:true if the service is marked as autoconnect false instead
std::vector<std::string> NetworkInfo::security()

For WiFi service type, this method will return a list of security methods or key management settings. For other network type this method will return an empty list.

Possible values are:

  • “none” The WiFi service have no security
  • “wep” The WiFi service use WEP security.
  • “psk” The WiFi use WPA or WPA2 personnal security.
  • “wps” The WiFi use the Wireless Protected Setup, this security is often an alternative for psk. WPS allow to connect to a WPA2 securised Network by pressing an association button or by giving a PIN code.
  • “ieee8021x” The WiFi service use a WPA/WPA2 entreprise protection, this security is not supported in the current version of NAOqi.
Returns:The available securities for the network.
std::vector<std::string> NetworkInfo::domains()

Return the list of currently used search domains. Can also be manual configured domains using ALConnectionMamanager::setServiceConfiguration.

Returns:The list of domains for this service
std::vector<std::string> NetworkInfo::nameserver()

Return the list of currently activate or manually configured domain name servers. The first one have a higher priority.

Returns:The activate or configured name servers
NetworkInfo::IPInfo NetworkInfo::ipv4()

Return a IPInfo which represents the actual system configuration or the manually configured IP address using ALConnectionMamanager::setServiceConfiguration.

Returns:The IPv4 configuration for this service.
NetworkInfo::IPInfo NetworkInfo::ipv6()

Experimental The IPv6 is not supported in the current version.

Return a IPInfo for the actual system configuration or the manually configured IP address using ALConnectionMamanager::setServiceConfiguration.

Returns:The IPv6 configuration for this service.
int NetworkInfo::strength()
Returns:The signal strength of the services (only available for WiFi).
int NetworkInfo::error()

When error occur during connection or disconnection the detailed information is represented in this property.

This property is only valid when the service is in the “failure” state. Otherwise it might be empty.

Returns:The connection error
AL::ALValue NetworkInfo::toALValue()

Converts the NetworkInfo object as an ALValue. ALValue NetworkInfo

Returns:The ALValue representation of the NetworkInfo object.

ALValue NetworkInfo

The ALValue NetworkInfo is an array of n-pair (key, value).

To exchange this object with other modules the NetworkInfo object can be represented as ALValue with the following structure.

key value type
“ServiceId” string
“Name” string
“Type” string
“State” string
“Favorite” bool
“Autoconnect” bool
“Security” array of string
“Domains” array of string
“Nameserver” array of string
“IPv4” ALValue ALValue IPInfo
“IPv6” ALValue ALValue IPInfo
“Strength” int
“Error” string

The empties values will not be present.

« ALConnectionManager API | ALConnectionManager | NetworkInfo-IPInfo »
« previous | up | next »