diff options
author | Anders Svensson <[email protected]> | 2017-07-08 00:48:07 +0200 |
---|---|---|
committer | Anders Svensson <[email protected]> | 2017-08-03 17:14:28 +0200 |
commit | 55e65b262cdf0b794ab443928676720a323cf6b0 (patch) | |
tree | fe4214afece02c79c2f48b2a10e11bdf20c364f4 /lib/diameter/doc | |
parent | df12f634bec4b784f4c8d16846f2c24297b0e1ac (diff) | |
download | otp-55e65b262cdf0b794ab443928676720a323cf6b0.tar.gz otp-55e65b262cdf0b794ab443928676720a323cf6b0.tar.bz2 otp-55e65b262cdf0b794ab443928676720a323cf6b0.zip |
Rename record_decode -> decode_format
{record_decode, map} is a bit too quirky.
Diffstat (limited to 'lib/diameter/doc')
-rw-r--r-- | lib/diameter/doc/src/diameter.xml | 48 | ||||
-rw-r--r-- | lib/diameter/doc/src/diameter_codec.xml | 2 |
2 files changed, 24 insertions, 26 deletions
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index e525ab3345..a7f001e096 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -798,6 +798,29 @@ be matched by corresponding &capability; configuration, of </item> <tag> +<marker id="decode_format"/> +<c>{decode_format, record | list | map | false}</c></tag> +<item> +<p> +The type of decoded messages and grouped AVPs in the <c>msg</c> field +of diameter_packet records and <c>value</c> field of diameter_avp +records respectively. +If <c>false</c> then the fields are set this value. +See also &codec_message;.</p> + +<p> +Defaults to <c>record</c>.</p> + +<note> +<p> +AVPs are decoded into a list of diameter_avp records in <c>avps</c> +field of diameter_packet records independently of +<c>decode_format</c>.</p> +</note> + +</item> + +<tag> <marker id="incoming_maxlen"/><c>{incoming_maxlen, 0..16777215}</c></tag> <item> <p> @@ -970,31 +993,6 @@ occur in the message in question.</p> </item> <tag> -<marker id="record_decode"/> -<c>{record_decode, boolean() | list | map}</c></tag> -<item> -<p> -Whether or not to decode message and grouped AVPs to records in the -<c>msg</c> field of diameter_packet records and <c>value</c> field of -diameter_avp records respectively, or to an alternate format. -If false then the fields are set to the same value. -See also &codec_message;.</p> - -<p> -Defaults to <c>true</c>.</p> - -<note> -<p> -Disabling the record is useful for applications in which the records -aren't used/needed. -AVP values are available in the <c>avps</c> field of -diameter_packet records regardless of whether or not there is a record -decode.</p> -</note> - -</item> - -<tag> <marker id="string_decode"/><c>{string_decode, boolean()}</c></tag> <item> <p> diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml index 6262dbf00d..4df8e788b7 100644 --- a/lib/diameter/doc/src/diameter_codec.xml +++ b/lib/diameter/doc/src/diameter_codec.xml @@ -244,7 +244,7 @@ file) and whose tail is a list of <c>{AvpName, AvpValues}</c> pairs, or as a map with values keyed on AVP names and the message name in key <c>:name</c>. The format at decode is determined by &mod_service_opt; -<c>record_decode</c>. +<c>decode_format</c>. Any of the formats is accepted at encode.</p> <p> |