summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMicael Karlberg <bmk@erlang.org>2021-07-27 18:57:55 +0200
committerMicael Karlberg <bmk@erlang.org>2021-08-30 16:41:16 +0200
commit630a99722437e9f1b2e5c1eccb8a2d8f160c6edf (patch)
treec846f755cb2f8631776cde0991a5fd821872b7e0
parent615e07ed2dd793de9f61c16e652b38a133de673b (diff)
downloaderlang-630a99722437e9f1b2e5c1eccb8a2d8f160c6edf.tar.gz
[megaco|tcp-tranport|doc] Add description of the new backend option
Add description of the new 'inet_backend' (udp transport) option. OTP-17533
-rw-r--r--lib/megaco/doc/src/megaco_tcp.xml7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/megaco/doc/src/megaco_tcp.xml b/lib/megaco/doc/src/megaco_tcp.xml
index 74a16eefab..93db0728be 100644
--- a/lib/megaco/doc/src/megaco_tcp.xml
+++ b/lib/megaco/doc/src/megaco_tcp.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>2000</year><year>2020</year>
+ <year>2000</year><year>2021</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -56,7 +56,7 @@
<type>
<v>TransportRef = pid() | regname()</v>
<v>OptionListPerPort = [Option]</v>
- <v>Option = {port, integer()} |{options, list()} |{receive_handle, term()}</v>
+ <v>Option = {port, integer()} | {options, list()} | {receive_handle, term()} | {inet_backend, default | inet | socket}</v>
</type>
<desc>
<p>This function is used for starting new TPKT listening socket
@@ -64,13 +64,14 @@
definitions.</p>
</desc>
</func>
+
<func>
<name since="">connect(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason}</name>
<fsummary></fsummary>
<type>
<v>TransportRef = pid() | regname()</v>
<v>OptionList = [Option]</v>
- <v>Option = {host, Ipaddr} | {port, integer()} |{options, list()} |{receive_handle, term()} |{module, atom()}</v>
+ <v>Option = {host, Ipaddr} | {port, integer()} | {options, list()} | {receive_handle, term()} | {module, atom()} | {inet_backend, default | inet | socket}</v>
<v>Handle = socket_handle()</v>
<v>ControlPid = pid()</v>
<v>Reason = term()</v>