diff options
author | Micael Karlberg <[email protected]> | 2019-06-12 17:45:11 +0200 |
---|---|---|
committer | Micael Karlberg <[email protected]> | 2019-06-27 17:34:46 +0200 |
commit | 360d9255043202e4295abb445f608aa6f8885f43 (patch) | |
tree | 7c940ab4a7fa09f8bac2c86f6d3ce7f85ed70b47 /lib/megaco/doc/src | |
parent | e5fa19b1355ea98dc634650086d2990b4240240e (diff) | |
download | otp-360d9255043202e4295abb445f608aa6f8885f43.tar.gz otp-360d9255043202e4295abb445f608aa6f8885f43.tar.bz2 otp-360d9255043202e4295abb445f608aa6f8885f43.zip |
[megaco] Update the app file and some docs
OTP-15882
Diffstat (limited to 'lib/megaco/doc/src')
-rw-r--r-- | lib/megaco/doc/src/megaco_edist_compress.xml | 8 | ||||
-rw-r--r-- | lib/megaco/doc/src/megaco_encoder.xml | 11 |
2 files changed, 15 insertions, 4 deletions
diff --git a/lib/megaco/doc/src/megaco_edist_compress.xml b/lib/megaco/doc/src/megaco_edist_compress.xml index 16443e469c..8461c59a00 100644 --- a/lib/megaco/doc/src/megaco_edist_compress.xml +++ b/lib/megaco/doc/src/megaco_edist_compress.xml @@ -43,8 +43,8 @@ <name since="">Module:encode(R, Version) -> T</name> <fsummary>Encode (compress) a megaco component.</fsummary> <type> - <v>R = megaco_message() | transaction() | action_reply() | action_request() | command_request()</v> - <v>Version = integer()</v> + <v>R = megaco_encoder:megaco_message() | megaco_encoder:transaction() | megaco_encoder:action_reply() | megaco_encoder:action_request() | megaco_encoder:command_request()</v> + <v>Version = megaco_encoder:protocol_version()</v> <v>T = term()</v> </type> <desc> @@ -57,8 +57,8 @@ <fsummary>Decode (decompress) a megaco component.</fsummary> <type> <v>T = term()</v> - <v>Version = integer()</v> - <v>R = megaco_message() | transaction() | action_reply() | action_request() | command_request()</v> + <v>Version = megaco_encoder:protocol_version()</v> + <v>R = megaco_encoder:megaco_message() | megaco_encoder:transaction() | megaco_encoder:action_reply() | megaco_encoder:action_request() | megaco_encoder:command_request()</v> </type> <desc> <p>Decompress a megaco component. </p> diff --git a/lib/megaco/doc/src/megaco_encoder.xml b/lib/megaco/doc/src/megaco_encoder.xml index cc8270440b..af1baa6661 100644 --- a/lib/megaco/doc/src/megaco_encoder.xml +++ b/lib/megaco/doc/src/megaco_encoder.xml @@ -42,7 +42,16 @@ <section> <title>DATA TYPES</title> + <description> + <p>Note that the actual definition of (some of) these records depend on + the megaco protocol version used. For instance, the + <c>'TransactionReply'</c> record + has two more fields in version 3, so a simple erlang type definition + cannot be made here. </p> + </description> <code type="none"><![CDATA[ +protocol_version() = integer() +segment_no() = integer() megaco_message() = #'MegacoMessage{}' transaction() = {transactionRequest, transaction_request()} | {transactionPending, transaction_reply()} | @@ -57,6 +66,8 @@ transaction_ack() = #'TransactionAck'{} segment_reply() = #'SegmentReply'{} action_request() = #'ActionRequest'{} action_reply() = #'ActionReply'{} +command_request() = #'CommandRequest'{} +error_desc() = #'ErrorDescriptor'{} ]]></code> <marker id="encode_message"></marker> |