diff options
| author | Micael Karlberg <bmk@erlang.org> | 2021-07-23 10:20:29 +0200 |
|---|---|---|
| committer | Micael Karlberg <bmk@erlang.org> | 2021-08-30 16:41:16 +0200 |
| commit | 869535711400ebb6239ef83b2c6c0f9da97a7c17 (patch) | |
| tree | 9a041038233d18f2317cdc2cacf10fc9b061e820 | |
| parent | 15d2b365f363dc118cc290b1640cc18f85f25ca7 (diff) | |
| download | erlang-869535711400ebb6239ef83b2c6c0f9da97a7c17.tar.gz | |
[megaco|udp-transport|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_udp.xml | 25 |
1 files changed, 16 insertions, 9 deletions
diff --git a/lib/megaco/doc/src/megaco_udp.xml b/lib/megaco/doc/src/megaco_udp.xml index 2809bc8ce9..3add131fa8 100644 --- a/lib/megaco/doc/src/megaco_udp.xml +++ b/lib/megaco/doc/src/megaco_udp.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,20 +56,27 @@ <type> <v>TransportRef = pid() | regname()</v> <v>OptionList = [option()]</v> - <v>option() = {port, integer()} |{options, list()} |{receive_handle, receive_handle()} |{module, atom()}</v> + <v>option() = {port, integer()} | {options, list()} | {receive_handle, receive_handle()} | {module, atom()} | {inet_backend, default | inet | socket}</v> <v>Handle = socket_handle()</v> <v>receive_handle() = term()</v> <v>ControlPid = pid()</v> <v>Reason = term()</v> </type> <desc> - <p>This function is used to open an UDP/IP socket.</p> - <p>The <c><![CDATA[module]]></c> option makes it possible for the user to provide - their own callback module. The functions <c><![CDATA[receive_message/4]]></c> or - <c><![CDATA[process_received_message/4]]></c> of this module is called when a new - message is received (which one depends on the size of the message; - small - receive_message, large - process_received_message). - Default value is <em>megaco</em>.</p> + <p>This function is used to open an UDP/IP socket.</p> + <p>The <c><![CDATA[module]]></c> option makes it possible for the user + to provide their own callback module. + The functions <c><![CDATA[receive_message/4]]></c> or + <c><![CDATA[process_received_message/4]]></c> of this module is called + when a new message is received (which one depends on the size of the + message: </p> + <taglist> + <tag><c><![CDATA[small]]></c></tag> + <item><p>receive_message</p></item> + <tag><c><![CDATA[large]]></c></tag> + <item><p>process_received_message)</p></item> + </taglist> + <p>Default value is (the module) <em>megaco</em>.</p> </desc> </func> <func> |