diff options
| author | Micael Karlberg <bmk@erlang.org> | 2019-11-22 14:56:23 +0100 |
|---|---|---|
| committer | Micael Karlberg <bmk@erlang.org> | 2019-11-25 18:30:40 +0100 |
| commit | b414d33ec808ae23eecd49230b45b4cbf37883e8 (patch) | |
| tree | 4df093fdf74365b4870992d88df1eadf7a6a41c4 | |
| parent | a90c99cb18bb82ea8531f43a65cdae3f175e5d86 (diff) | |
| download | erlang-b414d33ec808ae23eecd49230b45b4cbf37883e8.tar.gz | |
[enet|doc] Add documentation for the new getifaddrs functions
OTP-16212
| -rw-r--r-- | lib/kernel/doc/src/net.xml | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/net.xml b/lib/kernel/doc/src/net.xml index 6fbc37076c..4559df11a9 100644 --- a/lib/kernel/doc/src/net.xml +++ b/lib/kernel/doc/src/net.xml @@ -43,6 +43,24 @@ <name name="address_info"/> </datatype> <datatype> + <desc> + <p>Not all fields of this map has to be present. + The flags field can be used to test this for some of the fields. + For example <c>broadaddr</c> will only be present if the + <c>broadcast</c> flag is present in flags. </p> + </desc> + <name name="ifaddrs"/> + </datatype> + <datatype> + <name name="ifaddrs_flags"/> + </datatype> + <datatype> + <name name="ifaddrs_flag"/> + </datatype> + <datatype> + <name name="ifaddrs_filter_map"/> + </datatype> + <datatype> <name name="name_info"/> </datatype> <datatype> @@ -100,6 +118,23 @@ </func> <func> + <name name="getifaddrs" arity="0" since="@OTP-16212@"/> + <name name="getifaddrs" arity="1" clause_i="1" since="@OTP-16212@"/> + <name name="getifaddrs" arity="1" clause_i="2" since="@OTP-16212@"/> + <name name="getifaddrs" arity="2" since="@OTP-16212@"/> + <fsummary>Get interface addresses.</fsummary> + <desc> + <p>Get interface addresses.</p> + <p>This function is used to get the machines interface addresses, + possibly filtered with the <c>FilterMap</c>. </p> + <p>By default, a filter with the content: + <c>#{family => default, flags => any}</c> is used. This will allow all + interfaces with addresses of the <c>inet</c> and <c>inet6</c> families + to be listed.</p> + </desc> + </func> + + <func> <name name="if_name2index" arity="1" since="OTP 22.0"/> <fsummary>Mappings between network interface names and indexes.</fsummary> <desc> |