From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/megaco/doc/src/megaco.xml | 102 +++++++++++++------------- lib/megaco/doc/src/megaco_codec_meas.xml | 6 +- lib/megaco/doc/src/megaco_codec_mstone1.xml | 26 +++---- lib/megaco/doc/src/megaco_codec_mstone2.xml | 6 +- lib/megaco/doc/src/megaco_codec_transform.xml | 6 +- lib/megaco/doc/src/megaco_edist_compress.xml | 6 +- lib/megaco/doc/src/megaco_encoder.xml | 14 ++-- lib/megaco/doc/src/megaco_flex_scanner.xml | 12 +-- lib/megaco/doc/src/megaco_tcp.xml | 30 ++++---- lib/megaco/doc/src/megaco_transport.xml | 8 +- lib/megaco/doc/src/megaco_udp.xml | 30 ++++---- lib/megaco/doc/src/megaco_user.xml | 48 ++++++------ 12 files changed, 147 insertions(+), 147 deletions(-) (limited to 'lib/megaco/doc/src') diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml index d4a7451bfc..c7bcdfcd6f 100644 --- a/lib/megaco/doc/src/megaco.xml +++ b/lib/megaco/doc/src/megaco.xml @@ -32,7 +32,7 @@ %VSN% megaco.xml - megaco + megaco Main API of the Megaco application

Interface module for the Megaco application

@@ -135,7 +135,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - start() -> ok | {error, Reason} + start() -> ok | {error, Reason} Starts the Megaco application Reason = term() @@ -153,7 +153,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - stop() -> ok | {error, Reason} + stop() -> ok | {error, Reason} Stops the Megaco application Reason = term() @@ -166,7 +166,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - start_user(UserMid, Config) -> ok | {error, Reason} + start_user(UserMid, Config) -> ok | {error, Reason} Initial configuration of a user UserMid = megaco_mid() @@ -188,7 +188,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - stop_user(UserMid) -> ok | {error, Reason} + stop_user(UserMid) -> ok | {error, Reason} Delete the configuration of a user UserMid = megaco_mid() @@ -203,8 +203,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - user_info(UserMid) -> [{Item, Value}] - user_info(UserMid, Item) -> Value | exit(Reason) + user_info(UserMid) -> [{Item, Value}] + user_info(UserMid, Item) -> Value | exit(Reason) Lookup user information Handle = user_info_handle() @@ -703,7 +703,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - update_user_info(UserMid, Item, Value) -> ok | {error, Reason} + update_user_info(UserMid, Item, Value) -> ok | {error, Reason} Update information about a user UserMid = megaco_mid() @@ -721,8 +721,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - conn_info(ConnHandle) -> [{Item, Value}] - conn_info(ConnHandle, Item) -> Value | exit(Reason) + conn_info(ConnHandle) -> [{Item, Value}] + conn_info(ConnHandle, Item) -> Value | exit(Reason) Lookup information about an active connection ConnHandle = #megaco_conn_handle{} @@ -1222,7 +1222,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - update_conn_info(ConnHandle, Item, Value) -> ok | {error, Reason} + update_conn_info(ConnHandle, Item, Value) -> ok | {error, Reason} Update information about an active connection ConnHandle = #megaco_conn_handle{} @@ -1241,8 +1241,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - system_info() -> [{Item, Value}] | exit(Reason) - system_info(Item) -> Value | exit(Reason) + system_info() -> [{Item, Value}] | exit(Reason) + system_info(Item) -> Value | exit(Reason) Lookup system information Item = system_info_item() @@ -1289,7 +1289,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - info() -> Info + info() -> Info All the information of the application Info = [{Key, Value}] @@ -1311,8 +1311,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid) -> {ok, ConnHandle} | {error, Reason} - connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid, Extra) -> {ok, ConnHandle} | {error, Reason} + connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid) -> {ok, ConnHandle} | {error, Reason} + connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid, Extra) -> {ok, ConnHandle} | {error, Reason} Establish a "virtual" connection ReceiveHandle = #megaco_receive_handle{} @@ -1436,7 +1436,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - disconnect(ConnHandle, DiscoReason) -> ok | {error, ErrReason} + disconnect(ConnHandle, DiscoReason) -> ok | {error, ErrReason} Tear down a "virtual" connection ConnHandle = conn_handle() @@ -1454,7 +1454,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - call(ConnHandle, Actions, Options) -> {ProtocolVersion, UserReply} + call(ConnHandle, Actions, Options) -> {ProtocolVersion, UserReply} Sends one or more transaction request(s) and waits for the reply ConnHandle = conn_handle() @@ -1545,7 +1545,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - cast(ConnHandle, Actions, Options) -> ok | {error, Reason} + cast(ConnHandle, Actions, Options) -> ok | {error, Reason} Sends one or more transaction request(s) but does NOT wait for a reply ConnHandle = conn_handle() @@ -1582,7 +1582,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - encode_actions(ConnHandle, Actions, Options) -> {ok, BinOrBins} | {error, Reason} + encode_actions(ConnHandle, Actions, Options) -> {ok, BinOrBins} | {error, Reason} Encode action requests for one or more transaction request(s) ConnHandle = conn_handle() @@ -1607,9 +1607,9 @@ megaco_incr_timer() = #megaco_incr_timer{} - token_tag2string(Tag) -> Result - token_tag2string(Tag, EncoderMod) -> Result - token_tag2string(Tag, EncoderMod, Version) -> Result + token_tag2string(Tag) -> Result + token_tag2string(Tag, EncoderMod) -> Result + token_tag2string(Tag, EncoderMod, Version) -> Result Convert a token tag to a string Tag = atom() @@ -1635,7 +1635,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - cancel(ConnHandle, CancelReason) -> ok | {error, ErrReason} + cancel(ConnHandle, CancelReason) -> ok | {error, ErrReason} Cancel all outstanding messages for this connection ConnHandle = conn_handle() @@ -1655,8 +1655,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok - process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok + process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok + process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok Process a received message ReceiveHandle = #megaco_receive_handle{} @@ -1755,8 +1755,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok - receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok + receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok + receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok Process a received message ReceiveHandle = #megaco_receive_handle{} @@ -1783,7 +1783,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - parse_digit_map(DigitMapBody) -> {ok, ParsedDigitMap} | {error, Reason} + parse_digit_map(DigitMapBody) -> {ok, ParsedDigitMap} | {error, Reason} Parses a digit map body DigitMapBody = string() @@ -1802,8 +1802,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - eval_digit_map(DigitMap) -> {ok, MatchResult} | {error, Reason} - eval_digit_map(DigitMap, Timers) -> {ok, MatchResult} | {error, Reason} + eval_digit_map(DigitMap) -> {ok, MatchResult} | {error, Reason} + eval_digit_map(DigitMap, Timers) -> {ok, MatchResult} | {error, Reason} Collect digit map letters according to the digit map DigitMap = #'DigitMapValue'{} | parsed_digit_map() @@ -1839,7 +1839,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - report_digit_event(DigitMapEvalPid, Events) -> ok | {error, Reason} + report_digit_event(DigitMapEvalPid, Events) -> ok | {error, Reason} Send one or more events to the event collector process DigitMapEvalPid = pid() @@ -1866,7 +1866,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - test_digit_event(DigitMap, Events) -> {ok, Kind, Letters} | {error, Reason} + test_digit_event(DigitMap, Events) -> {ok, Kind, Letters} | {error, Reason} Feed digit map collector with events and return the result DigitMap = #'DigitMapValue'{} | parsed_digit_map() @@ -1900,7 +1900,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - encode_sdp(SDP) -> {ok, PP} | {error, Reason} + encode_sdp(SDP) -> {ok, PP} | {error, Reason} Encode an SDP construct SDP = sdp_property_parm() | sdp_property_group() | sdp_property_groups() | asn1_NOVALUE @@ -1929,7 +1929,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - decode_sdp(PP) -> {ok, SDP} | {error, Reason} + decode_sdp(PP) -> {ok, SDP} | {error, Reason} Decode an property parameter construct PP = property_parm() | property_group() | property_groups() | asn1_NOVALUE @@ -1969,7 +1969,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - get_sdp_record_from_PropertGroup(Type, PG) -> [sdp()] + get_sdp_record_from_PropertGroup(Type, PG) -> [sdp()] Get all sdp records of a certain type from a property group Type = v | c | m | o | a | b | t | r | z | k | s | i | u | e | p @@ -1986,8 +1986,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - versions1() -> {ok, VersionInfo} | {error, Reason} - versions2() -> {ok, Info} | {error, Reason} + versions1() -> {ok, VersionInfo} | {error, Reason} + versions2() -> {ok, Info} | {error, Reason} Retreive various system and application info VersionInfo = [version_info()] @@ -2007,8 +2007,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - print_version_info() -> void() - print_version_info(VersionInfo) -> void() + print_version_info() -> void() + print_version_info(VersionInfo) -> void() Formated print of result of the versions functions VersionInfo = [version_info()] @@ -2029,7 +2029,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - enable_trace(Level, Destination) -> void() + enable_trace(Level, Destination) -> void() Start megaco tracing Level = max | min | 0 <= integer() <= 100 @@ -2057,7 +2057,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - disable_trace() -> void() + disable_trace() -> void() Stop megaco tracing

This function is used to stop megaco tracing.

@@ -2065,7 +2065,7 @@ megaco_incr_timer() = #megaco_incr_timer{}
- set_trace(Level) -> void() + set_trace(Level) -> void() Change megaco trace level Level = max | min | 0 <= integer() <= 100 @@ -2081,10 +2081,10 @@ megaco_incr_timer() = #megaco_incr_timer{} - get_stats() -> {ok, TotalStats} | {error, Reason} - get_stats(GlobalCounter) -> {ok, CounterStats} | {error, Reason} - get_stats(ConnHandle) -> {ok, ConnHandleStats} | {error, Reason} - get_stats(ConnHandle, Counter) -> {ok, integer()} | {error, Reason} + get_stats() -> {ok, TotalStats} | {error, Reason} + get_stats(GlobalCounter) -> {ok, CounterStats} | {error, Reason} + get_stats(ConnHandle) -> {ok, ConnHandleStats} | {error, Reason} + get_stats(ConnHandle, Counter) -> {ok, integer()} | {error, Reason} TotalStats = [total_stats()] @@ -2110,8 +2110,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - reset_stats() -> void() - reset_stats(ConnHandle) -> void() + reset_stats() -> void() + reset_stats(ConnHandle) -> void() ConnHandle = conn_handle() @@ -2123,7 +2123,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - test_request(ConnHandle, Version, EncodingMod, EncodingConfig, Actions) -> {MegaMsg, EncodeRes} + test_request(ConnHandle, Version, EncodingMod, EncodingConfig, Actions) -> {MegaMsg, EncodeRes} Tests if the Actions argument is correct ConnHandle = conn_handle() @@ -2150,7 +2150,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - test_reply(ConnHandle, Version, EncodingMod, EncodingConfig, Reply) -> {MegaMsg, EncodeRes} + test_reply(ConnHandle, Version, EncodingMod, EncodingConfig, Reply) -> {MegaMsg, EncodeRes} Tests if the Reply argument is correct ConnHandle = conn_handle() diff --git a/lib/megaco/doc/src/megaco_codec_meas.xml b/lib/megaco/doc/src/megaco_codec_meas.xml index 13cc3eb834..5184fe392e 100644 --- a/lib/megaco/doc/src/megaco_codec_meas.xml +++ b/lib/megaco/doc/src/megaco_codec_meas.xml @@ -32,7 +32,7 @@ %VSN% megaco_codec_meas.xml - megaco_codec_meas + megaco_codec_meas This module implements a simple megaco codec measurement tool.

This module implements a simple megaco codec measurement tool.

@@ -43,8 +43,8 @@ - start() -> void() - start(MessagePackage) -> void() + start() -> void() + start(MessagePackage) -> void() MessagePackageRaw = message_package() diff --git a/lib/megaco/doc/src/megaco_codec_mstone1.xml b/lib/megaco/doc/src/megaco_codec_mstone1.xml index 2ff959a648..507a790c71 100644 --- a/lib/megaco/doc/src/megaco_codec_mstone1.xml +++ b/lib/megaco/doc/src/megaco_codec_mstone1.xml @@ -32,7 +32,7 @@ %VSN% megaco_codec_mstone1.xml - megaco_codec_mstone1 + megaco_codec_mstone1 This module implements a simple megaco codec-based performance tool.

This module implements the mstone1 tool, @@ -44,9 +44,9 @@ - start() -> void() - start(MessagePackage) -> void() - start(MessagePackage, Factor) -> void() + start() -> void() + start(MessagePackage) -> void() + start(MessagePackage, Factor) -> void() MessagePackage = message_package() @@ -63,9 +63,9 @@ - start_flex() -> void() - start_flex(MessagePackage) -> void() - start_flex(MessagePackage, Factor) -> void() + start_flex() -> void() + start_flex(MessagePackage) -> void() + start_flex(MessagePackage, Factor) -> void() MessagePackage = message_package() @@ -83,9 +83,9 @@ - start_only_drv() -> void() - start_only_drv(MessagePackage) -> void() - start_only_drv(MessagePackage, Factor) -> void() + start_only_drv() -> void() + start_only_drv(MessagePackage) -> void() + start_only_drv(MessagePackage, Factor) -> void() MessagePackage = message_package() @@ -105,9 +105,9 @@ - start_no_drv() -> void() - start_no_drv(MessagePackage) -> void() - start_no_drv(MessagePackage, Factor) -> void() + start_no_drv() -> void() + start_no_drv(MessagePackage) -> void() + start_no_drv(MessagePackage, Factor) -> void() MessagePackage = message_package() diff --git a/lib/megaco/doc/src/megaco_codec_mstone2.xml b/lib/megaco/doc/src/megaco_codec_mstone2.xml index 3da30d4f99..03990f5c3d 100644 --- a/lib/megaco/doc/src/megaco_codec_mstone2.xml +++ b/lib/megaco/doc/src/megaco_codec_mstone2.xml @@ -32,7 +32,7 @@ %VSN% megaco_codec_mstone2.xml - megaco_codec_mstone2 + megaco_codec_mstone2 This module implements a simple megaco codec-based performance tool.

This module implements the mstone2 tool, @@ -44,8 +44,8 @@ - start() -> void() - start(MessagePackage) -> void() + start() -> void() + start(MessagePackage) -> void() MessagePackage = message_package() diff --git a/lib/megaco/doc/src/megaco_codec_transform.xml b/lib/megaco/doc/src/megaco_codec_transform.xml index 26b83c3799..392868fdfa 100644 --- a/lib/megaco/doc/src/megaco_codec_transform.xml +++ b/lib/megaco/doc/src/megaco_codec_transform.xml @@ -32,7 +32,7 @@ %VSN% megaco_codec_transform.xml - megaco_codec_transform + megaco_codec_transform Megaco message transformation utility. @@ -45,8 +45,8 @@ - export_messages() -> void() - export_messages(MessagePackage) -> void() + export_messages() -> void() + export_messages(MessagePackage) -> void() MessagePackage = atom() diff --git a/lib/megaco/doc/src/megaco_edist_compress.xml b/lib/megaco/doc/src/megaco_edist_compress.xml index d5c7c7224d..16443e469c 100644 --- a/lib/megaco/doc/src/megaco_edist_compress.xml +++ b/lib/megaco/doc/src/megaco_edist_compress.xml @@ -32,7 +32,7 @@ %VSN% megaco_edist_compress.xml - megaco_edist_compress + megaco_edist_compress Megaco erlang dist compress behaviour.

The following functions should be exported from a @@ -40,7 +40,7 @@ - Module:encode(R, Version) -> T + Module:encode(R, Version) -> T Encode (compress) a megaco component. R = megaco_message() | transaction() | action_reply() | action_request() | command_request() @@ -53,7 +53,7 @@ - Module:decode(T, Version) -> R + Module:decode(T, Version) -> R Decode (decompress) a megaco component. T = term() diff --git a/lib/megaco/doc/src/megaco_encoder.xml b/lib/megaco/doc/src/megaco_encoder.xml index 13c6ed324b..cc8270440b 100644 --- a/lib/megaco/doc/src/megaco_encoder.xml +++ b/lib/megaco/doc/src/megaco_encoder.xml @@ -32,7 +32,7 @@ %VSN% megaco_encoder.xml - megaco_encoder + megaco_encoder Megaco encoder behaviour.

The following functions should be exported from a @@ -64,7 +64,7 @@ action_reply() = #'ActionReply'{} - Module:encode_message(EncodingConfig, Version, Message) -> {ok, Bin} | Error + Module:encode_message(EncodingConfig, Version, Message) -> {ok, Bin} | Error Encode a megaco message. EncodingConfig = list() @@ -81,7 +81,7 @@ action_reply() = #'ActionReply'{} - Module:decode_message(EncodingConfig, Version, Bin) -> {ok, Message} | Error + Module:decode_message(EncodingConfig, Version, Bin) -> {ok, Message} | Error Decode a megaco message. EncodingConfig = list() @@ -104,7 +104,7 @@ action_reply() = #'ActionReply'{} - Module:decode_mini_message(EncodingConfig, Version, Bin) -> {ok, Message} | Error + Module:decode_mini_message(EncodingConfig, Version, Bin) -> {ok, Message} | Error Perform a minimal decode of a megaco message. EncodingConfig = list() @@ -129,7 +129,7 @@ action_reply() = #'ActionReply'{} - Module:encode_transaction(EncodingConfig, Version, Transaction) -> OK | Error + Module:encode_transaction(EncodingConfig, Version, Transaction) -> OK | Error Encode a megaco transaction. EncodingConfig = list() @@ -155,7 +155,7 @@ action_reply() = #'ActionReply'{} - Module:encode_action_requests(EncodingConfig, Version, ARs) -> OK | Error + Module:encode_action_requests(EncodingConfig, Version, ARs) -> OK | Error Encode megaco action requests. EncodingConfig = list() @@ -181,7 +181,7 @@ action_reply() = #'ActionReply'{} - Module:encode_action_reply(EncodingConfig, Version, AR) -> OK | Error + Module:encode_action_reply(EncodingConfig, Version, AR) -> OK | Error Encode a megaco action reply. EncodingConfig = list() diff --git a/lib/megaco/doc/src/megaco_flex_scanner.xml b/lib/megaco/doc/src/megaco_flex_scanner.xml index 0856f3f429..121a7fbcff 100644 --- a/lib/megaco/doc/src/megaco_flex_scanner.xml +++ b/lib/megaco/doc/src/megaco_flex_scanner.xml @@ -32,7 +32,7 @@ %VSN% megaco_flex_scanner.xml - megaco_flex_scanner + megaco_flex_scanner Interface module to the flex scanner linked in driver.

This module contains the public interface to the flex scanner @@ -72,7 +72,7 @@ megaco_version() = integer() >= 1 - start() -> {ok, PortOrPorts} | {error, Reason} + start() -> {ok, PortOrPorts} | {error, Reason} PortOrPorts = megaco_ports() @@ -94,7 +94,7 @@ megaco_version() = integer() >= 1 - stop(PortOrPorts) -> stopped + stop(PortOrPorts) -> stopped PortOrPorts = megaco_ports() @@ -108,7 +108,7 @@ megaco_version() = integer() >= 1 - is_reentrant_enabled() -> Boolean + is_reentrant_enabled() -> Boolean Boolean = boolean() @@ -121,7 +121,7 @@ megaco_version() = integer() >= 1 - is_scanner_port(Port, PortOrPorts) -> Boolean + is_scanner_port(Port, PortOrPorts) -> Boolean Port = port() @@ -137,7 +137,7 @@ megaco_version() = integer() >= 1 - scan(Binary, PortOrPorts) -> {ok, Tokens, Version, LatestLine} | {error, Reason, LatestLine} + scan(Binary, PortOrPorts) -> {ok, Tokens, Version, LatestLine} | {error, Reason, LatestLine} Binary = binary() diff --git a/lib/megaco/doc/src/megaco_tcp.xml b/lib/megaco/doc/src/megaco_tcp.xml index 77aee32f6c..63713b2c56 100644 --- a/lib/megaco/doc/src/megaco_tcp.xml +++ b/lib/megaco/doc/src/megaco_tcp.xml @@ -32,7 +32,7 @@ %VSN% megaco_tcp.xml - megaco_tcp + megaco_tcp Interface module to TPKT transport protocol for Megaco/H.248.

This module contains the public interface to the TPKT (TCP/IP) version @@ -40,7 +40,7 @@ - start_transport() -> {ok, TransportRef} + start_transport() -> {ok, TransportRef} TransportRef = pid() @@ -51,7 +51,7 @@ - listen(TransportRef, ListenPortSpecList) -> ok + listen(TransportRef, ListenPortSpecList) -> ok TransportRef = pid() | regname() @@ -65,7 +65,7 @@ - connect(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason} + connect(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason} TransportRef = pid() | regname() @@ -86,7 +86,7 @@ - close(Handle) -> ok + close(Handle) -> ok Handle = socket_handle() @@ -96,7 +96,7 @@ - socket(Handle) -> Socket + socket(Handle) -> Socket Handle = socket_handle() @@ -109,7 +109,7 @@ - send_message(Handle, Message) -> ok + send_message(Handle, Message) -> ok Handle = socket_handle() @@ -120,7 +120,7 @@ - block(Handle) -> ok + block(Handle) -> ok Handle = socket_handle() @@ -130,7 +130,7 @@ - unblock(Handle) -> ok + unblock(Handle) -> ok Handle = socket_handle() @@ -141,7 +141,7 @@ - upgrade_receive_handle(ControlPid) -> ok + upgrade_receive_handle(ControlPid) -> ok ControlPid = pid() @@ -153,9 +153,9 @@ - get_stats() -> {ok, TotalStats} | {error, Reason} - get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason} - get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason} + get_stats() -> {ok, TotalStats} | {error, Reason} + get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason} + get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason} TotalStats = [send_handle_stats()] @@ -173,8 +173,8 @@ - reset_stats() -> void() - reset_stats(SendHandle) -> void() + reset_stats() -> void() + reset_stats(SendHandle) -> void() SendHandle = send_handle() diff --git a/lib/megaco/doc/src/megaco_transport.xml b/lib/megaco/doc/src/megaco_transport.xml index 3002e9b74e..ba8c794750 100644 --- a/lib/megaco/doc/src/megaco_transport.xml +++ b/lib/megaco/doc/src/megaco_transport.xml @@ -32,7 +32,7 @@ %VSN% megaco_transport.xml - megaco_transport + megaco_transport Megaco transport behaviour.

The following functions should be exported from a @@ -54,8 +54,8 @@ - Module:send_message(Handle, Msg) -> ok | {cancel, Reason} | Error - Module:send_message(Handle, Msg, Resend) -> ok | {cancel, Reason} | Error + Module:send_message(Handle, Msg) -> ok | {cancel, Reason} | Error + Module:send_message(Handle, Msg, Resend) -> ok | {cancel, Reason} | Error Send a megaco message. Handle = term() @@ -99,7 +99,7 @@ - Module:resend_message(Handle, Msg) -> ok | {cancel, Reason} | Error + Module:resend_message(Handle, Msg) -> ok | {cancel, Reason} | Error Re-send a megaco message. Handle = term() diff --git a/lib/megaco/doc/src/megaco_udp.xml b/lib/megaco/doc/src/megaco_udp.xml index b2559c77d5..3d776c19b6 100644 --- a/lib/megaco/doc/src/megaco_udp.xml +++ b/lib/megaco/doc/src/megaco_udp.xml @@ -32,7 +32,7 @@ %VSN% megaco_udp.xml - megaco_udp + megaco_udp Interface module to UDP transport protocol for Megaco/H.248.

This module contains the public interface to the UDP/IP version @@ -40,7 +40,7 @@ - start_transport() -> {ok, TransportRef} + start_transport() -> {ok, TransportRef} TransportRef = pid() @@ -51,7 +51,7 @@ - open(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason} + open(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason} TransportRef = pid() | regname() @@ -73,7 +73,7 @@ - close(Handle, Msg) -> ok + close(Handle, Msg) -> ok Handle = socket_handle() @@ -84,7 +84,7 @@ - socket(Handle) -> Socket + socket(Handle) -> Socket Handle = socket_handle() @@ -97,7 +97,7 @@ - create_send_handle(Handle, Host, Port) -> send_handle() + create_send_handle(Handle, Host, Port) -> send_handle() Handle = socket_handle() @@ -110,7 +110,7 @@ - send_message(SendHandle, Msg) -> ok + send_message(SendHandle, Msg) -> ok SendHandle = send_handle() @@ -125,7 +125,7 @@ - block(Handle) -> ok + block(Handle) -> ok Handle = socket_handle() @@ -135,7 +135,7 @@ - unblock(Handle) -> ok + unblock(Handle) -> ok Handle = socket_handle() @@ -146,7 +146,7 @@ - upgrade_receive_handle(ControlPid, NewHandle) -> ok + upgrade_receive_handle(ControlPid, NewHandle) -> ok ControlPid = pid() @@ -160,9 +160,9 @@ - get_stats() -> {ok, TotalStats} | {error, Reason} - get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason} - get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason} + get_stats() -> {ok, TotalStats} | {error, Reason} + get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason} + get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason} TotalStats = [total_stats()] @@ -180,8 +180,8 @@ - reset_stats() -> void() - reset_stats(SendHandle) -> void() + reset_stats() -> void() + reset_stats(SendHandle) -> void() SendHandle = send_handle() diff --git a/lib/megaco/doc/src/megaco_user.xml b/lib/megaco/doc/src/megaco_user.xml index 067be15fe0..198f2aa24c 100644 --- a/lib/megaco/doc/src/megaco_user.xml +++ b/lib/megaco/doc/src/megaco_user.xml @@ -32,7 +32,7 @@ %VSN% megaco_user.xml - megaco_user + megaco_user Callback module for users of the Megaco application

This module defines the callback behaviour of Megaco users. A @@ -164,8 +164,8 @@ protocol_version() = integer() ]]> - handle_connect(ConnHandle, ProtocolVersion) -> ok | error | {error,ErrorDescr} - handle_connect(ConnHandle, ProtocolVersion, Extra]) -> ok | error | {error,ErrorDescr} + handle_connect(ConnHandle, ProtocolVersion) -> ok | error | {error,ErrorDescr} + handle_connect(ConnHandle, ProtocolVersion, Extra]) -> ok | error | {error,ErrorDescr} Invoked when a new connection is established ConnHandle = conn_handle() @@ -202,7 +202,7 @@ protocol_version() = integer() ]]> - handle_disconnect(ConnHandle, ProtocolVersion, Reason) -> ok + handle_disconnect(ConnHandle, ProtocolVersion, Reason) -> ok Invoked when a connection is teared down ConnHandle = conn_handle() @@ -220,8 +220,8 @@ protocol_version() = integer() ]]> - handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED) -> reply | {reply, ED} | no_reply | {no_reply, ED} - handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED, Extra) -> reply | {reply, ED} | no_reply | {no_reply, ED} + handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED) -> reply | {reply, ED} | no_reply | {no_reply, ED} + handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED, Extra) -> reply | {reply, ED} | no_reply | {no_reply, ED} Invoked when a received message had syntax errors ReceiveHandle = receive_handle() @@ -258,8 +258,8 @@ protocol_version() = integer() ]]> - handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr) -> ok - handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr, Extra) -> ok + handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr) -> ok + handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr, Extra) -> ok Invoked when a received message just contains an error ConnHandle = conn_handle() @@ -291,8 +291,8 @@ protocol_version() = integer() ]]> - handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests) -> pending() | reply() | ignore_trans_request - handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests, Extra) -> pending() | reply() | ignore_trans_request + handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests) -> pending() | reply() | ignore_trans_request + handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests, Extra) -> pending() | reply() | ignore_trans_request Invoked for each transaction request ConnHandle = conn_handle() @@ -420,8 +420,8 @@ protocol_version() = integer() ]]> - handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData) -> reply() - handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData, Extra) -> reply() + handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData) -> reply() + handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData, Extra) -> reply() Optionally invoked for a time consuming transaction request ConnHandle = conn_handle() @@ -460,8 +460,8 @@ protocol_version() = integer() ]]> - handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData) -> ok - handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData, Extra) -> ok + handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData) -> ok + handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData, Extra) -> ok Optionally invoked for a transaction reply ConnHandle = conn_handle() @@ -593,8 +593,8 @@ protocol_version() = integer() ]]> - handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData) -> ok - handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData, Extra) -> ok + handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData) -> ok + handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData, Extra) -> ok Optionally invoked for a transaction acknowledgement ConnHandle = conn_handle() @@ -658,8 +658,8 @@ protocol_version() = integer() ]]> - handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans) -> ok - handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans, Extra) -> ok + handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans) -> ok + handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans, Extra) -> ok Invoked when an unexpected message is received ConnHandle = conn_handle() @@ -685,8 +685,8 @@ protocol_version() = integer() ]]> - handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid) -> ok - handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid, Extra) -> ok + handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid) -> ok + handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid, Extra) -> ok Invoked when an transaction request has been aborted ConnHandle = conn_handle() @@ -710,8 +710,8 @@ protocol_version() = integer() ]]> - handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl) -> ok - handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl, Extra) -> ok + handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl) -> ok + handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl, Extra) -> ok Segment Reply Indication ConnHandle = conn_handle() -- cgit v1.2.3