diff options
author | Anders Svensson <[email protected]> | 2017-09-03 13:32:20 +0200 |
---|---|---|
committer | Anders Svensson <[email protected]> | 2017-09-03 13:32:20 +0200 |
commit | aa71291f765e901d7816e2399a3f3d55d41d06c9 (patch) | |
tree | cc6aed4ad3ad6558ebc61c7288e1d5b5d404e593 /lib/diameter/doc/src/diameter_codec.xml | |
parent | a2518cf009a2c2f7c156bbfe8ff65ceb8dc09a6a (diff) | |
parent | 70b228f55a34a29f0019ab22affa9f0b70acdabf (diff) | |
download | otp-aa71291f765e901d7816e2399a3f3d55d41d06c9.tar.gz otp-aa71291f765e901d7816e2399a3f3d55d41d06c9.tar.bz2 otp-aa71291f765e901d7816e2399a3f3d55d41d06c9.zip |
Merge branch 'anders/diameter/decode_format/OTP-14511' into maint
* anders/diameter/decode_format/OTP-14511:
Map less in traffic suite
Fix decode_format doc oversights
Rename decode_format false to none
Tweak {decode_format, false} semantics
Fix dialyzer spec
Diffstat (limited to 'lib/diameter/doc/src/diameter_codec.xml')
-rw-r--r-- | lib/diameter/doc/src/diameter_codec.xml | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml index 0846334d23..5124b49484 100644 --- a/lib/diameter/doc/src/diameter_codec.xml +++ b/lib/diameter/doc/src/diameter_codec.xml @@ -4,7 +4,10 @@ '<seealso marker="diameter_dict#MESSAGE_RECORDS">diameter_dict(4)</seealso>'> <!ENTITY types '<seealso marker="diameter_dict#DATA_TYPES">diameter_dict(4)</seealso>'> - <!ENTITY % also SYSTEM "seealso.ent" > + <!ENTITY decode_format + '<seealso marker="diameter#decode_format">decode format</seealso>'> + +<!ENTITY % also SYSTEM "seealso.ent" > <!ENTITY % here SYSTEM "seehere.ent" > %also; %here; @@ -145,7 +148,8 @@ question.</p> <p> The decoded value of an AVP. Will be <c>undefined</c> on decode if the data bytes could -not be decoded or the AVP is unknown. +not be decoded, the AVP is unknown, or if the &decode_format; is +<c>none</c>. The type of a decoded value is as document in &types;.</p> </item> @@ -243,8 +247,7 @@ Equivalently, a message can also be encoded as a list whose head is the atom-valued message name (as specified in the relevant dictionary file) and whose tail is either a list of AVP name/values pairs or a map with values keyed on AVP names. -The format at decode is determined by &mod_service_opt; -<c>decode_format</c>. +The format at decode is determined by &mod_decode_format;. Any of the formats is accepted at encode.</p> <p> @@ -288,15 +291,16 @@ value other than <c>undefined</c>.</p> <item> <p> The incoming/outgoing message. -For an incoming message, a record if the message can be -decoded in a non-relay application, <c>undefined</c> otherwise. +For an incoming message, a term corresponding to the configured +&decode_format; if the message can be decoded in a non-relay +application, <c>undefined</c> otherwise. For an outgoing message, setting a <c>[&header; | &avp;]</c> list is equivalent to setting the <c>header</c> and <c>avps</c> fields to the corresponding values.</p> <warning> <p> -A record-valued <c>msg</c> field does <em>not</em> imply an absence of +A value in the <c>msg</c> field does <em>not</em> imply an absence of decode errors. The <c>errors</c> field should also be examined.</p> </warning> |