summaryrefslogtreecommitdiffhomepage
path: root/libs/nixio/docsrc/nixio.lua
diff options
context:
space:
mode:
authorSteven Barth <steven@midlink.org>2009-04-26 19:10:36 +0000
committerSteven Barth <steven@midlink.org>2009-04-26 19:10:36 +0000
commitd81b3548a92a7a9db95d2587d6d15aebdc9b8652 (patch)
tree0ce5776c20b7864c8275fe582e738552cc8ae8e2 /libs/nixio/docsrc/nixio.lua
parenta8da3a09a3fb34327cf02306726dad640e309f20 (diff)
nixio:
Added binding for getifaddrs(): List network interfaces, their flags, addresses and statistics Cleanups
Diffstat (limited to 'libs/nixio/docsrc/nixio.lua')
-rw-r--r--libs/nixio/docsrc/nixio.lua17
1 files changed, 17 insertions, 0 deletions
diff --git a/libs/nixio/docsrc/nixio.lua b/libs/nixio/docsrc/nixio.lua
index 7efeab8ef9..2d0056f179 100644
--- a/libs/nixio/docsrc/nixio.lua
+++ b/libs/nixio/docsrc/nixio.lua
@@ -20,6 +20,23 @@ module "nixio"
-- @param ipaddr IPv4 or IPv6-Address
-- @return FQDN
+--- (Linux, BSD) Get a list of available network interfaces and their addresses.
+-- @class function
+-- @name nixio.getifaddrs
+-- @return Table containing one or more tables containing: <ul>
+-- <li>name = Interface Name</li>
+-- <li>family = ["inet", "inet6", "packet"]</li>
+-- <li>addr = Interface Address (IPv4, IPv6, MAC, ...)</li>
+-- <li>broadaddr = Broadcast Address</li>
+-- <li>dstaddr = Destination Address (Point-to-Point)</li>
+-- <li>netmask = Netmask (if available)</li>
+-- <li>prefix = Prefix (if available)</li>
+-- <li>flags = Table of interface flags (up, multicast, loopback, ...)</li>
+-- <li>data = Statistics (Linux, "packet"-family)</li>
+-- <li>hatype = Hardware Type Identifier (Linix, "packet"-family)</li>
+-- <li>ifindex = Interface Index (Linux, "packet"-family)</li>
+-- </ul>
+
--- Create a new socket and bind it to a network address.
-- This function is a shortcut for calling nixio.socket and then bind()
-- on the socket object.