aboutsummaryrefslogtreecommitdiffstats
path: root/lib/diameter/doc/src/diameter_dict.xml
diff options
context:
space:
mode:
authorAnders Svensson <[email protected]>2017-06-11 09:33:42 +0200
committerAnders Svensson <[email protected]>2017-06-13 13:50:07 +0200
commitcac106defc5060c5e485480e8003b992482d751d (patch)
tree42da7438f01f380ce899b81cac9d129d164f40d6 /lib/diameter/doc/src/diameter_dict.xml
parent7384de812f6399a841c8edf0503402e940fd17a4 (diff)
downloadotp-cac106defc5060c5e485480e8003b992482d751d.tar.gz
otp-cac106defc5060c5e485480e8003b992482d751d.tar.bz2
otp-cac106defc5060c5e485480e8003b992482d751d.zip
Change signature associated with dictionary @custom_type/@codecs
To pass the options map through the encode. This is not backwards compatible, and dictionaries supporting @custom_types or @codecs will need to be updated.
Diffstat (limited to 'lib/diameter/doc/src/diameter_dict.xml')
-rw-r--r--lib/diameter/doc/src/diameter_dict.xml13
1 files changed, 7 insertions, 6 deletions
diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index 9584d682c2..94016d9466 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -16,7 +16,8 @@
<header>
<copyright>
-<year>2011</year><year>2016</year>
+<year>2011</year>
+<year>2017</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -307,11 +308,11 @@ The P flag has been deprecated by &the_rfc;.</p>
<p>
Specifies AVPs for which module Mod provides encode/decode functions.
The section contents consists of AVP names.
-For each such name, <c>Mod:Name(encode|decode, Type, Data)</c> is
+For each such name, <c>Mod:Name(encode|decode, Type, Data, Opts)</c> is
expected to provide encode/decode for values of the AVP, where Name is
the name of the AVP, Type is it's type as declared in the
-<c>@avp_types</c> section of the dictionary and Data is the value to
-encode/decode.</p>
+<c>@avp_types</c> section of the dictionary, Data is the value to
+encode/decode, and Opts is a term that is passed through encode/decode.</p>
<p>
Example:</p>
@@ -328,8 +329,8 @@ Framed-IP-Address
<item>
<p>
Like <c>@custom_types</c> but requires the specified module to export
-<c>Mod:Type(encode|decode, Name, Data)</c> rather than
-<c>Mod:Name(encode|decode, Type, Data)</c>.</p>
+<c>Mod:Type(encode|decode, Name, Data, Opts)</c> rather than
+<c>Mod:Name(encode|decode, Type, Data, Opts)</c>.</p>
<p>
Example:</p>