diff options
author | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2016-12-09 19:50:10 +0200 |
---|---|---|
committer | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2016-12-19 22:40:51 +0200 |
commit | cc8acc5fa708b9f24369d71b5e982a0314ca64d7 (patch) | |
tree | 4bbbe8eb323a8bf725f11c4081e9940779f2d43d /aconf/model/net.lua | |
parent | 88a2ee4783d15c74f735f26c48b621b5e848d334 (diff) | |
download | aconf-cc8acc5fa708b9f24369d71b5e982a0314ca64d7.tar.bz2 aconf-cc8acc5fa708b9f24369d71b5e982a0314ca64d7.tar.xz |
doc: describe functionality used in the network module
Diffstat (limited to 'aconf/model/net.lua')
-rw-r--r-- | aconf/model/net.lua | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/aconf/model/net.lua b/aconf/model/net.lua index 40ddd36..57eb3ea 100644 --- a/aconf/model/net.lua +++ b/aconf/model/net.lua @@ -74,6 +74,14 @@ function BaseIPAddress:encode(context, value) end +--- IPv4 address field, inherits @{String}. +-- @fclass net.IPv4Address +-- @tparam boolean cidr if set to true, the field accepts a network +-- address in CIDR notation +-- @tparam string mask_addr if set, the network address is decomposed +-- into address and netmask in the back-end. This parameter specifies +-- the back-end address where the netmask is stored in dotted-quad +-- format. M.IPv4Address = class(BaseIPAddress) function M.IPv4Address:init(params) @@ -122,6 +130,13 @@ function M.IPv4Address:cidr2mask(cidr) end +--- IPv6 address field, inherits @{String}. +-- @fclass net.IPv6Address +-- @tparam boolean cidr if set to true, the field accepts a network +-- address +-- @tparam string mask_addr if set, the network address is decomposed +-- into address and netmask parts in the back-end. This parameter +-- specifies the back-end address where the netmask length is stored. M.IPv6Address = class(BaseIPAddress) function M.IPv6Address:init(params) |