All Classes Namespaces Files Functions Pages
WirelessEndpoint.NetworkInfo Class Reference

Network information of the wireless endpoint. More...

Methods

 Description.Get
 Returns a textual description of the object.
 
 IPv4.Get
 Returns a list of IPv4 addresses. More...
 
 IPv6.Global.Get
 Returns a list of IPv6 global addresses. More...
 
 IPv6.LinkLocal.Get
 Returns a list of IPv6 linklocal addresses. More...
 
 Interface.Get
 Returns a list of network interfaces. More...
 
 Parent.Get
 Returns the parent object.
 
 Refresh
 Updates the information with the latest data available from the ByteBlower server. More...
 

Class overview

Network information of the wireless endpoint.

Contains all useful network information of a wireless endpoint. All methods return immediately. The values are updated from the wireless endpoint at regular intervals.

Since
2.6.0
Example
1 set device [ $meeting_point Device.Get $uuid ] ;# we got a WirelessEndpoint
2  set deviceInfo [ $device Device.Info.Get ]
3  set networkInfo [ $deviceInfo Network.Info.Get ]
4  printing IPv4 address
5  puts "IP: [ $networkInfo IPv4.Get ]"

Definition at line 24867 of file api.tcl.

Method documentation

WirelessEndpoint.NetworkInfo::Interface.Get

Returns a list of network interfaces.

Returns
list of WirelessEndpoint.NetworkInterface
Example
1 $networkInfo Interface.Get

Returns:

[ <WirelessEndpoint.NetworkInterface object> ... ] 

Definition at line 24920 of file api.tcl.

WirelessEndpoint.NetworkInfo::IPv4.Get

Returns a list of IPv4 addresses.

This is a convenient method that will return the list of IPv4 addresses of the first interface. If you want the IP of a specific interface use the Interfaces.Get method to retrieve them.

Example
1 $networkInfo IPv4.Get

Returns:

10.5.5.188 

Definition at line 24884 of file api.tcl.

WirelessEndpoint.NetworkInfo::IPv6.Global.Get

Returns a list of IPv6 global addresses.

This is a convenient method that will return the list of IPv4 addresses of the first interface. If you want the IP of a specific interface use the Iterface.Get method to retrieve them.

Example
1 $networkInfo IPv6.Global.Get

Returns:

fdec:5ef9:84b5:1000:a00:27ff:fe5f:b447/64 

Definition at line 24896 of file api.tcl.

WirelessEndpoint.NetworkInfo::IPv6.LinkLocal.Get

Returns a list of IPv6 linklocal addresses.

This is a convenient method to get a list of the IPv6 linkLocal addresses. If your WE has 2 active interfaces, only the first will be returned. You can use Interfaces.Get to retrieve the interfaces

Example
1 $networkInfo IPv6.LinkLocal.Get

Returns:

fe80::2ae:faff:fede:a665/64 

Definition at line 24908 of file api.tcl.

WirelessEndpoint.NetworkInfo::Refresh

Updates the information with the latest data available from the ByteBlower server.

Example
1 $networkInfo Refresh

Definition at line 24935 of file api.tcl.