diff options
Diffstat (limited to 'documentation/api')
| -rw-r--r-- | documentation/api/modules/luci.http.protocol.html | 4 | ||||
| -rw-r--r-- | documentation/api/modules/luci.ip.cidr.html | 330 | ||||
| -rw-r--r-- | documentation/api/modules/luci.ip.html | 288 | ||||
| -rw-r--r-- | documentation/api/modules/luci.util.html | 2 | ||||
| -rw-r--r-- | documentation/api/modules/nixio.README.html | 6 | ||||
| -rw-r--r-- | documentation/api/modules/nixio.UnifiedIO.html | 10 |
6 files changed, 584 insertions, 56 deletions
diff --git a/documentation/api/modules/luci.http.protocol.html b/documentation/api/modules/luci.http.protocol.html index 57063bbcf9..e6e93ad3d6 100644 --- a/documentation/api/modules/luci.http.protocol.html +++ b/documentation/api/modules/luci.http.protocol.html @@ -341,7 +341,7 @@ Ltn12 source function Decode a mime encoded http message body with multipart/form-data Content-Type. Stores all extracted data associated with its parameter name -in the params table within the given message object. Multiple parameter +in the params table within the given message object. Multiple parameter values are stored as tables, ordinary ones as strings. If an optional file callback function is given then it is feeded with the file contents chunk by chunk and only the extracted file name is stored @@ -556,7 +556,7 @@ The decoded string Decode an urlencoded http message body with application/x-www-urlencoded Content-Type. Stores all extracted data associated with its parameter name -in the params table within the given message object. Multiple parameter +in the params table within the given message object. Multiple parameter values are stored as tables, ordinary ones as strings. diff --git a/documentation/api/modules/luci.ip.cidr.html b/documentation/api/modules/luci.ip.cidr.html index ce8c567952..5a2b06ec67 100644 --- a/documentation/api/modules/luci.ip.cidr.html +++ b/documentation/api/modules/luci.ip.cidr.html @@ -260,6 +260,30 @@ Checks whether the CIDR instance is an IPv6 mapped IPv4 address </tr> <tr> + <td class="name" nowrap><a href="#cidr.ismac">cidr:ismac</a> ()</td> + <td class="summary"> + +Checks whether the CIDR instance is an ethernet MAC address range + </td> + </tr> + + <tr> + <td class="name" nowrap><a href="#cidr.ismaclocal">cidr:ismaclocal</a> ()</td> + <td class="summary"> + +Checks whether the CIDR instance is a locally administered (LAA) MAC address + </td> + </tr> + + <tr> + <td class="name" nowrap><a href="#cidr.ismacmcast">cidr:ismacmcast</a> ()</td> + <td class="summary"> + +Checks whether the CIDR instance is a multicast MAC address + </td> + </tr> + + <tr> <td class="name" nowrap><a href="#cidr.lower">cidr:lower</a> (addr)</td> <td class="summary"> @@ -323,6 +347,20 @@ Derive mapped IPv4 address of CIDR instance.</td> </tr> <tr> + <td class="name" nowrap><a href="#cidr.tomac">cidr:tomac</a> ()</td> + <td class="summary"> + +Derive MAC address of IPv6 link local CIDR instance.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#cidr.tolinklocal">cidr:tolinklocal</a> ()</td> + <td class="summary"> + +Derive IPv6 link local address from MAC address CIDR instance.</td> + </tr> + + <tr> <td class="name" nowrap><a href="#cidr.contains">cidr:contains</a> (addr)</td> <td class="summary"> @@ -405,6 +443,10 @@ Checks whether the CIDR instance is an IPv4 address range cidr:is6 </a> + <li><a href="#cidr.ismac"> + cidr:ismac + </a> + </ul> </dd> @@ -499,6 +541,10 @@ Checks whether the CIDR instance is an IPv6 address range cidr:is4 </a> + <li><a href="#cidr.ismac"> + cidr:ismac + </a> + </ul> </dd> @@ -566,13 +612,108 @@ end</pre> +<dt><a name="cidr.ismac"></a><strong>cidr:ismac</strong> ()</dt> +<dd> + + +Checks whether the CIDR instance is an ethernet MAC address range + + + + + + + + +<h3>Return value:</h3> +<code>true</code> if the CIDR is a MAC address range, else <code>false</code> + + + +<h3>See also:</h3> +<ul> + + <li><a href="#cidr.is4"> + cidr:is4 + </a> + + <li><a href="#cidr.is6"> + cidr:is6 + </a> + +</ul> + +</dd> + + + + +<dt><a name="cidr.ismaclocal"></a><strong>cidr:ismaclocal</strong> ()</dt> +<dd> + + +Checks whether the CIDR instance is a locally administered (LAA) MAC address + + + + + + +<h3>Usage:</h3> +<pre>local mac = luci.ip.new("02:C0:FF:EE:00:01") +if mac:ismaclocal() then + print("Is an LAA MAC address") +end</pre> + + + +<h3>Return value:</h3> +<code>true</code> if the MAC address sets the locally administered bit. + + + +</dd> + + + + +<dt><a name="cidr.ismacmcast"></a><strong>cidr:ismacmcast</strong> ()</dt> +<dd> + + +Checks whether the CIDR instance is a multicast MAC address + + + + + + +<h3>Usage:</h3> +<pre>local mac = luci.ip.new("01:00:5E:7F:00:10") +if addr:ismacmcast() then + print("Is a multicast MAC address") +end</pre> + + + +<h3>Return value:</h3> +<code>true</code> if the MAC address sets the multicast bit. + + + +</dd> + + + + <dt><a name="cidr.lower"></a><strong>cidr:lower</strong> (addr)</dt> <dd> Checks whether this CIDR instance is lower than the given argument. The comparisation follows these rules: -<ul><li>An IPv4 address is always lower than an IPv6 address</li> +<ul><li>An IPv4 address is always lower than an IPv6 address and IPv6 addresses +are considered lower than MAC addresses</li> <li>Prefix sizes are ignored</li></ul> @@ -595,7 +736,8 @@ The comparisation follows these rules: print(addr:lower(addr)) -- false print(addr:lower("10.10.10.10/24")) -- false print(addr:lower(luci.ip.new("::1"))) -- true -print(addr:lower(luci.ip.new("192.168.200.1"))) -- true</pre> +print(addr:lower(luci.ip.new("192.168.200.1"))) -- true +print(addr:lower(luci.ip.new("00:14:22:01:23:45"))) -- true</pre> @@ -629,7 +771,8 @@ print(addr:lower(luci.ip.new("192.168.200.1"))) -- true</pre> Checks whether this CIDR instance is higher than the given argument. The comparisation follows these rules: -<ul><li>An IPv4 address is always lower than an IPv6 address</li> +<ul><li>An IPv4 address is always lower than an IPv6 address and IPv6 addresses +are considered lower than MAC addresses</li> <li>Prefix sizes are ignored</li></ul> @@ -652,7 +795,8 @@ The comparisation follows these rules: print(addr:higher(addr)) -- false print(addr:higher("10.10.10.10/24")) -- true print(addr:higher(luci.ip.new("::1"))) -- false -print(addr:higher(luci.ip.new("192.168.200.1"))) -- false</pre> +print(addr:higher(luci.ip.new("192.168.200.1"))) -- false +print(addr:higher(luci.ip.new("00:14:22:01:23:45"))) -- false</pre> @@ -709,7 +853,11 @@ print(addr:equal(luci.ip.new("::1"))) -- false local addr6 = luci.ip.new("::1") print(addr6:equal("0:0:0:0:0:0:0:1/64")) -- true -print(addr6:equal(luci.ip.new("fe80::221:63ff:fe75:aa17"))) -- false</pre> +print(addr6:equal(luci.ip.new("fe80::221:63ff:fe75:aa17"))) -- false + +local mac = luci.ip.new("00:14:22:01:23:45") +print(mac:equal("0:14:22:1:23:45")) -- true +print(mac:equal(luci.ip.new("01:23:45:67:89:AB")) -- false</pre> @@ -752,8 +900,8 @@ else the current prefix size is returned. <li> mask: Either a number containing the number of bits (<code>0..32</code> - for IPv4, <code>0..128</code> for IPv6) or a string containing a valid - netmask (optional) + for IPv4, <code>0..128</code> for IPv6 or <code>0..48</code> for MAC addresses) or a string + containing a valid netmask (optional) </li> </ul> @@ -800,8 +948,8 @@ optional mask parameter. <li> mask: Either a number containing the number of bits (<code>0..32</code> - for IPv4, <code>0..128</code> for IPv6) or a string containing a valid - netmask (optional) + for IPv4, <code>0..128</code> for IPv6 or <code>0..48</code> for MAC addresses) or a string + containing a valid netmask (optional) </li> </ul> @@ -837,7 +985,7 @@ CIDR instance representing the network address Derive host address of CIDR instance. This function essentially constructs a copy of this CIDR with the prefix size -set to <code>32</code> for IPv4 and <code>128</code> for IPv6. +set to <code>32</code> for IPv4, <code>128</code> for IPv6 or <code>48</code> for MAC addresses. @@ -877,8 +1025,8 @@ prefix size can be overridden by the optional mask parameter. <li> mask: Either a number containing the number of bits (<code>0..32</code> - for IPv4, <code>0..128</code> for IPv6) or a string containing a valid - netmask (optional) + for IPv4, <code>0..128</code> for IPv6 or <code>0..48</code> for MAC addresses) or a string + containing a valid netmask (optional) </li> </ul> @@ -913,8 +1061,8 @@ Derive broadcast address of CIDR instance. Constructs a CIDR instance representing the broadcast address of this instance. The used prefix size can be overridden by the optional mask parameter. -This function has no effect on IPv6 instances, it will return nothing in this -case. +This function has no effect on IPv6 or MAC address instances, it will return +nothing in this case. @@ -922,9 +1070,8 @@ case. <ul> <li> - mask: Either a number containing the number of bits (<code>0..32</code> - for IPv4, <code>0..128</code> for IPv6) or a string containing a valid - netmask (optional) + mask: Either a number containing the number of bits (<code>0..32</code> for IPv4) or + a string containing a valid netmask (optional) </li> </ul> @@ -960,8 +1107,8 @@ Derive mapped IPv4 address of CIDR instance. Constructs a CIDR instance representing the IPv4 address of the IPv6 mapped IPv4 address in this instance. -This function has no effect on IPv4 instances or IPv6 instances which are not a -mapped address, it will return nothing in this case. +This function has no effect on IPv4 instances, MAC address instances or IPv6 +instances which are not a mapped address, it will return nothing in this case. @@ -985,6 +1132,74 @@ Return a new CIDR instance representing the IPv4 address if this +<dt><a name="cidr.tomac"></a><strong>cidr:tomac</strong> ()</dt> +<dd> + + +Derive MAC address of IPv6 link local CIDR instance. + +Constructs a CIDR instance representing the MAC address contained in the IPv6 +link local address of this instance. + +This function has no effect on IPv4 instances, MAC address instances or IPv6 +instances which are not a link local address, it will return nothing in this +case. + + + + + + +<h3>Usage:</h3> +<pre>local addr = luci.ip.new("fe80::6666:b3ff:fe47:e1b9") +print(addr:tomac()) -- "64:66:B3:47:E1:B9"</pre> + + + +<h3>Return value:</h3> +Return a new CIDR instance representing the MAC address if this + instance is an IPv6 link local address, else return nothing. + + + +</dd> + + + + +<dt><a name="cidr.tolinklocal"></a><strong>cidr:tolinklocal</strong> ()</dt> +<dd> + + +Derive IPv6 link local address from MAC address CIDR instance. + +Constructs a CIDR instance representing the IPv6 link local address of the +MAC address represented by this instance. + +This function has no effect on IPv4 instances or IPv6 instances, it will return +nothing in this case. + + + + + + +<h3>Usage:</h3> +<pre>local mac = luci.ip.new("64:66:B3:47:E1:B9") +print(mac:tolinklocal()) -- "fe80::6666:b3ff:fe47:e1b9"</pre> + + + +<h3>Return value:</h3> +Return a new CIDR instance representing the IPv6 link local address. + + + +</dd> + + + + <dt><a name="cidr.contains"></a><strong>cidr:contains</strong> (addr)</dt> <dd> @@ -1014,7 +1229,11 @@ print(range:contains("10.0.0.0/8")) -- false local range6 = luci.ip.new("fe80::/10") print(range6:contains("fe80::221:63f:fe75:aa17/64")) -- true -print(range6:contains("fd9b:6b3:c5:0:221:63f:fe75:aa17/64")) -- false</pre> +print(range6:contains("fd9b:6b3:c5:0:221:63f:fe75:aa17/64")) -- false + +local intel_macs = luci.ip.MAC("C0:B6:F9:00:00:00/24") +print(intel_macs:contains("C0:B6:F9:A3:C:11")) -- true +print(intel_macs:contains("64:66:B3:47:E1:B9")) -- false</pre> @@ -1059,30 +1278,40 @@ address space, the result is set to the highest possible address. <h3>Usage:</h3> <pre>local addr = luci.ip.new("192.168.1.1/24") -print(addr:add(250)) -- "192.168.1.251/24" -print(addr:add("0.0.99.0")) -- "192.168.100.1/24" +print(addr:add(250)) -- "192.168.1.251/24" +print(addr:add("0.0.99.0")) -- "192.168.100.1/24" -addr:add(256, true) -- true -print(addr) -- "192.168.2.1/24 +addr:add(256, true) -- true +print(addr) -- "192.168.2.1/24 -addr:add("255.0.0.0", true) -- false (overflow) -print(addr) -- "255.255.255.255/24 +addr:add("255.0.0.0", true) -- false (overflow) +print(addr) -- "255.255.255.255/24 local addr6 = luci.ip.new("fe80::221:63f:fe75:aa17/64") -print(addr6:add(256)) -- "fe80::221:63f:fe75:ab17/64" -print(addr6:add("::ffff:0")) -- "fe80::221:640:fe74:aa17/64" +print(addr6:add(256)) -- "fe80::221:63f:fe75:ab17/64" +print(addr6:add("::ffff:0")) -- "fe80::221:640:fe74:aa17/64" + +addr6:add(256, true) -- true +print(addr6) -- "fe80::221:63f:fe75:ab17/64 + +addr6:add("ffff::", true) -- false (overflow) +print(addr6) -- "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/64" + +local mac = luci.ip.new("00:14:22:01:23:45") +print(mac:add(256)) -- "00:14:22:01:24:45" +print(mac:add("0:0:0:0:FF:0") -- "00:14:22:02:22:45" -addr:add(256, true) -- true -print(addr) -- "fe80::221:63f:fe75:ab17/64 +mac:add(256, true) -- true +print(mac) -- "00:14:22:01:24:45" -addr:add("ffff::", true) -- false (overflow) -print(addr) -- "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/64"</pre> +mac:add("FF:FF:0:0:0:0", true) -- false (overflow) +print(mac) -- "FF:FF:FF:FF:FF:FF"</pre> <h3>Return value:</h3> <ul> - <li>When adding inplace: Return <code>true</code> if the addition succeeded + <li>When adding inplace: Return <code>true</code> if the addition succeded or <code>false</code> when the addition overflowed.</li> <li>When deriving new CIDR: Return new instance representing the value of this instance plus the added amount or the highest possible address if @@ -1099,7 +1328,7 @@ print(addr) -- "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/64"</pr <dd> -Subtract given amount from CIDR instance. If the result would under, the lowest +Subtract given amount from CIDR instance. If the result would under, the lowest possible address is returned. @@ -1142,16 +1371,26 @@ addr:sub(256, true) -- true print(addr) -- "fe80::221:63f:fe75:a917/64" addr:sub("ffff::", true) -- false (underflow) -print(addr) -- "::/64"</pre> +print(addr) -- "::/64" + +local mac = luci.ip.new("00:14:22:01:23:45") +print(mac:sub(256)) -- "00:14:22:01:22:45" +print(mac:sub("0:0:0:0:FF:0") -- "00:14:22:00:24:45" + +mac:sub(256, true) -- true +print(mac) -- "00:14:22:01:22:45" + +mac:sub("FF:FF:0:0:0:0", true) -- false (overflow) +print(mac) -- "00:00:00:00:00:00"</pre> <h3>Return value:</h3> <ul> - <li>When subtracting inplace: Return <code>true</code> if the subtraction - succeeded or <code>false</code> when the subtraction underflowed.</li> + <li>When subtracting inplace: Return <code>true</code> if the subtraction + succeeded or <code>false</code> when the subtraction underflowed.</li> <li>When deriving new CIDR: Return new instance representing the value of - this instance minus the subtracted amount or the lowest address if + this instance minus the subtracted amount or the lowest address if the subtraction underflowed.</li></ul> @@ -1177,7 +1416,10 @@ Calculate the lowest possible host address within this CIDR instance. print(addr:minhost()) -- "192.168.123.1" local addr6 = luci.ip.new("fd9b:62b3:9cc5:0:221:63ff:fe75:aa17/64") -print(addr6:minhost()) -- "fd9b:62b3:9cc5::1"</pre> +print(addr6:minhost()) -- "fd9b:62b3:9cc5::1" + +local mac = luci.ip.new("00:14:22:01:22:45/32") +print(mac:minhost()) -- "00:14:22:01:00:01"</pre> @@ -1208,7 +1450,10 @@ Calculate the highest possible host address within this CIDR instance. print(addr:maxhost()) -- "192.168.123.254" (.255 is broadcast) local addr6 = luci.ip.new("fd9b:62b3:9cc5:0:221:63ff:fe75:aa17/64") -print(addr6:maxhost()) -- "fd9b:62b3:9cc5:0:ffff:ffff:ffff:ffff"</pre> +print(addr6:maxhost()) -- "fd9b:62b3:9cc5:0:ffff:ffff:ffff:ffff" + +local mac = luci.ip.new("00:14:22:01:22:45/32") +print(mac:maxhost()) -- "00:14:22:01:FF:FF"</pre> @@ -1229,8 +1474,9 @@ Returns a new CIDR instance representing the highest host address Convert CIDR instance into string representation. -If the prefix size of instance is less than 32 for IPv4 or 128 for IPv6, the -address is returned in the form "address/prefix" otherwise just "address". +If the prefix size of instance is less than 32 for IPv4, 128 for IPv6 or 48 for +MACs, the address is returned in the form "address/prefix" otherwise just +"address". It is usually not required to call this function directly as CIDR objects define it as __tostring function in the associated metatable. diff --git a/documentation/api/modules/luci.ip.html b/documentation/api/modules/luci.ip.html index 549a55307e..1f89626faa 100644 --- a/documentation/api/modules/luci.ip.html +++ b/documentation/api/modules/luci.ip.html @@ -232,6 +232,34 @@ Construct a new IPv6 luci.ip.cidr instance.</td> </tr> <tr> + <td class="name" nowrap><a href="#MAC">MAC</a> (address, netmask)</td> + <td class="summary"> + +Construct a new MAC luci.ip.cidr instance.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#checkip4">checkip4</a> (address)</td> + <td class="summary"> + +Verify an IPv4 address.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#checkip6">checkip6</a> (address)</td> + <td class="summary"> + +Verify an IPv6 address.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#checkmac">checkmac</a> (address)</td> + <td class="summary"> + +Verify an ethernet MAC address.</td> + </tr> + + <tr> <td class="name" nowrap><a href="#route">route</a> (address)</td> <td class="summary"> @@ -334,6 +362,10 @@ address/mask range. IPv6 </a> + <li><a href="#MAC"> + MAC + </a> + </ul> </dd> @@ -389,6 +421,10 @@ A <code>luci.ip.cidr</code> object representing the given IPv4 range. IPv6 </a> + <li><a href="#MAC"> + MAC + </a> + </ul> </dd> @@ -444,6 +480,252 @@ A <code>luci.ip.cidr</code> object representing the given IPv6 range. IPv4 </a> + <li><a href="#MAC"> + MAC + </a> + +</ul> + +</dd> + + + + +<dt><a name="MAC"></a><strong>MAC</strong> (address, netmask)</dt> +<dd> + + +Construct a new MAC luci.ip.cidr instance. +Throws an error if the given string does not represent a valid ethernet MAC +address or if the given optional mask is of a different family. + + +<h3>Parameters</h3> +<ul> + + <li> + address: String containing a valid ethernet MAC address, optionally with +prefix size (CIDR notation) or mask separated by slash. + </li> + + <li> + netmask: String containing a valid MAC address mask or number +containing a prefix size between <code>0</code> and <code>48</code> bit. +Overrides mask embedded in the first argument if specified. (optional) + </li> + +</ul> + + + + +<h3>Usage:</h3> +<pre>intel_macs = luci.ip.MAC("C0:B6:F9:00:00:00/24") +intel_macs = luci.ip.MAC("C0:B6:F9:00:00:00/FF:FF:FF:0:0:0") +intel_macs = luci.ip.MAC("C0:B6:F9:00:00:00", "FF:FF:FF:0:0:0") +intel_macs = luci.ip.MAC("C0:B6:F9:00:00:00/24", 48) -- override mask</pre> + + + +<h3>Return value:</h3> +A <code>luci.ip.cidr</code> object representing the given MAC address range. + + + +<h3>See also:</h3> +<ul> + + <li><a href="#IPv4"> + IPv4 + </a> + + <li><a href="#IPv6"> + IPv6 + </a> + +</ul> + +</dd> + + + + +<dt><a name="checkip4"></a><strong>checkip4</strong> (address)</dt> +<dd> + + +Verify an IPv4 address. + +Checks whether given argument is a preexisting luci.ip.cidr IPv4 address +instance or a string literal convertible to an IPv4 address and returns a +plain Lua string containing the canonical representation of the address. + +If the argument is not a valid address, returns nothing. This function is +intended to aid in safely verifying address literals without having to deal +with exceptions. + + +<h3>Parameters</h3> +<ul> + + <li> + address: String containing a valid IPv4 address or existing +luci.ip.cidr IPv4 instance. + </li> + +</ul> + + + + +<h3>Usage:</h3> +<pre>ipv4 = luci.ip.checkip4(luci.ip.new("127.0.0.1")) -- "127.0.0.1" +ipv4 = luci.ip.checkip4("127.0.0.1") -- "127.0.0.1" +ipv4 = luci.ip.checkip4("nonesense") -- nothing +ipv4 = luci.ip.checkip4(123) -- nothing +ipv4 = luci.ip.checkip4(nil) -- nothing +ipv4 = luci.ip.checkip4() -- nothing</pre> + + + +<h3>Return value:</h3> +A string representing the given IPv4 address. + + + +<h3>See also:</h3> +<ul> + + <li><a href="#checkip6"> + checkip6 + </a> + + <li><a href="#checkmac"> + checkmac + </a> + +</ul> + +</dd> + + + + +<dt><a name="checkip6"></a><strong>checkip6</strong> (address)</dt> +<dd> + + +Verify an IPv6 address. + +Checks whether given argument is a preexisting luci.ip.cidr IPv6 address +instance or a string literal convertible to an IPv6 address and returns a +plain Lua string containing the canonical representation of the address. + +If the argument is not a valid address, returns nothing. This function is +intended to aid in safely verifying address literals without having to deal +with exceptions. + + +<h3>Parameters</h3> +<ul> + + <li> + address: String containing a valid IPv6 address or existing +luci.ip.cidr IPv6 instance. + </li> + +</ul> + + + + +<h3>Usage:</h3> +<pre>ipv6 = luci.ip.checkip6(luci.ip.new("0:0:0:0:0:0:0:1")) -- "::1" +ipv6 = luci.ip.checkip6("0:0:0:0:0:0:0:1") -- "::1" +ipv6 = luci.ip.checkip6("nonesense") -- nothing +ipv6 = luci.ip.checkip6(123) -- nothing +ipv6 = luci.ip.checkip6(nil) -- nothing +ipv6 = luci.ip.checkip6() -- nothing</pre> + + + +<h3>Return value:</h3> +A string representing the given IPv6 address. + + + +<h3>See also:</h3> +<ul> + + <li><a href="#checkip4"> + checkip4 + </a> + + <li><a href="#checkmac"> + checkmac + </a> + +</ul> + +</dd> + + + + +<dt><a name="checkmac"></a><strong>checkmac</strong> (address)</dt> +<dd> + + +Verify an ethernet MAC address. + +Checks whether given argument is a preexisting luci.ip.cidr MAC address +instance or a string literal convertible to an ethernet MAC and returns a +plain Lua string containing the canonical representation of the address. + +If the argument is not a valid address, returns nothing. This function is +intended to aid in safely verifying address literals without having to deal +with exceptions. + + +<h3>Parameters</h3> +<ul> + + <li> + address: String containing a valid MAC address or existing luci.ip.cidr +MAC address instance. + </li> + +</ul> + + + + +<h3>Usage:</h3> +<pre>mac = luci.ip.checkmac(luci.ip.new("00-11-22-cc-dd-ee")) -- "00:11:22:CC:DD:EE" +mac = luci.ip.checkmac("00:11:22:cc:dd:ee") -- "00:11:22:CC:DD:EE" +mac = luci.ip.checkmac("nonesense") -- nothing +mac = luci.ip.checkmac(123) -- nothing +mac = luci.ip.checkmac(nil) -- nothing +mac = luci.ip.checkmac() -- nothing</pre> + + + +<h3>Return value:</h3> +A string representing the given MAC address. + + + +<h3>See also:</h3> +<ul> + + <li><a href="#checkip4"> + checkip4 + </a> + + <li><a href="#checkip6"> + checkip6 + </a> + </ul> </dd> @@ -787,7 +1069,7 @@ A neighbour entry is a table containing the following fields: </tr> <tr> <td><code>mac</code></td> - <td>String containing the associated MAC address</td> + <td>MAC address <code>luci.ip.cidr</code> instance</td> </tr> <tr> <td><code>router</code></td> @@ -905,8 +1187,8 @@ described below is returned, else an empty table. </tr> <tr> <td><code>mac</code></td> - <td>String containing the link local address of the device in - dotted hex notation</td> + <td>MAC address <code>luci.ip.cidr</code> instance representing the device ethernet + address</td> </tr> </table> diff --git a/documentation/api/modules/luci.util.html b/documentation/api/modules/luci.util.html index 847230bbbd..70d27d3312 100644 --- a/documentation/api/modules/luci.util.html +++ b/documentation/api/modules/luci.util.html @@ -629,7 +629,7 @@ Cloned table value <dd> -Count the occurrences of given substring in given string. +Count the occurrences of given substring in given string. diff --git a/documentation/api/modules/nixio.README.html b/documentation/api/modules/nixio.README.html index d8a17f78b4..99e036b828 100644 --- a/documentation/api/modules/nixio.README.html +++ b/documentation/api/modules/nixio.README.html @@ -288,7 +288,7 @@ <br />In general all functions are namend and behave like their POSIX API counterparts - where applicable - applying the following rules: <ul> - <li>Functions should be named like the underlying POSIX API function omitting + <li>Functions should be named like the underlying POSIX API function omitting prefixes or suffixes - especially when placed in an object-context ( lockf -> File:lock, fsync -> File:sync, dup2 -> dup, ...)</li> <li>If you are unclear about the behaviour of a function you should consult @@ -296,10 +296,10 @@ <li>If the name is significantly different from the POSIX-function, the underlying function(s) are stated in the documentation.</li> <li>Parameters should reflect those of the C-API, buffer length arguments and - by-reference parameters should be omitted for pratical purposes.</li> + by-reference parameters should be omitted for practical purposes.</li> <li>If a C function accepts a bitfield as parameter, it should be translated into lower case string flags representing the flags if the bitfield is the - last parameter and also omitting prefixes or suffixes. (e.g. waitpid + last parameter and also omitting prefixes or suffixes. (e.g. waitpid (pid, &s, WNOHANG | WUNTRACED) -> waitpid(pid, "nohang", "untraced"), getsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt)) -> Socket:getopt("socket", "reuseaddr"), etc.) </li> diff --git a/documentation/api/modules/nixio.UnifiedIO.html b/documentation/api/modules/nixio.UnifiedIO.html index 1717980841..700485dbe4 100644 --- a/documentation/api/modules/nixio.UnifiedIO.html +++ b/documentation/api/modules/nixio.UnifiedIO.html @@ -326,7 +326,7 @@ <li>The blocksize given is only advisory and to be seen as an upper limit, if an underlying read returns less bytes the chunk is nevertheless returned. - <li>If the limit parameter is omitted, the iterator returns data + <li>If the limit parameter is omitted, the iterator returns data until an end-of-file, end-of-stream, connection shutdown or similar happens. <li>The iterator will not buffer so it is safe to mix with calls to read. @@ -402,7 +402,7 @@ true <li>This function uses the blocksource function of the source descriptor and the sink function of the target descriptor. - <li>If the limit parameter is omitted, data is copied + <li>If the limit parameter is omitted, data is copied until an end-of-file, end-of-stream, connection shutdown or similar happens. <li>If the descriptor is non-blocking the function may fail with EAGAIN. @@ -461,7 +461,7 @@ true blocksource function of the source descriptor and the sink function of the target descriptor as a fallback mechanism. - <li>If the limit parameter is omitted, data is copied + <li>If the limit parameter is omitted, data is copied until an end-of-file, end-of-stream, connection shutdown or similar happens. <li>If the descriptor is non-blocking the function may fail with EAGAIN. @@ -584,7 +584,7 @@ boolean you can pass "true" to the iterator which will flush the buffer and return the bufferd data. - <li>If the limit parameter is omitted, this function uses the nixio + <li>If the limit parameter is omitted, this function uses the nixio buffersize (8192B by default). <li>If the descriptor is non-blocking the iterator may fail with EAGAIN. @@ -628,7 +628,7 @@ Line-based Iterator <li>This function uses the low-level read function of the descriptor. - <li>If the length parameter is omitted, this function returns all data + <li>If the length parameter is omitted, this function returns all data that can be read before an end-of-file, end-of-stream, connection shutdown or similar happens. |