From c59325f2a24e6ca3217c660fa328a00cf440e58d Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Sun, 30 Apr 2017 10:08:54 +0200 Subject: Restore diameter_codec:decode/2, update diameter_codec(3) The documentation has been out of date since the string_decode option was added in commit 1590920c. The optionless decode/2 was removed in the commit that removed the use of the process dictionary in decode. --- lib/diameter/doc/src/diameter_codec.xml | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'lib/diameter/doc') diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml index 91e96058dd..0117c1c88a 100644 --- a/lib/diameter/doc/src/diameter_codec.xml +++ b/lib/diameter/doc/src/diameter_codec.xml @@ -13,7 +13,8 @@
-20122016 +2012 +2017 Ericsson AB. All Rights Reserved. @@ -53,17 +54,17 @@ communicated to &man_app; callbacks. Similarly, outgoing Diameter messages are encoded into binary() before being passed to the appropriate &man_transport; module for transmission. -The functions in this module implement this encode/decode.

+The functions documented here implement the default encode/decode.

- +

-Calls to this module are made by diameter itself as a consequence of -configuration passed to &mod_start_service;. -The encode/decode functions may also be useful for other purposes (eg. -test) but the diameter user does not need to call them explicitly when +The diameter user does not need to call functions here explicitly when sending and receiving messages using &mod_call; and the callback -interface documented in &man_app;.

- +interface documented in &man_app;: diameter itself provides encode/decode +as a consequence of configuration passed to &mod_start_service;, and +the results may differ from those returned by the functions documented +here, depending on configuration.

+

The &header; and &packet; records below -- cgit v1.2.3 From cac106defc5060c5e485480e8003b992482d751d Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Sun, 11 Jun 2017 09:33:42 +0200 Subject: 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. --- lib/diameter/doc/src/diameter_dict.xml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'lib/diameter/doc') 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 @@

-20112016 +2011 +2017 Ericsson AB. All Rights Reserved. @@ -307,11 +308,11 @@ The P flag has been deprecated by &the_rfc;.

Specifies AVPs for which module Mod provides encode/decode functions. The section contents consists of AVP names. -For each such name, Mod:Name(encode|decode, Type, Data) is +For each such name, Mod:Name(encode|decode, Type, Data, Opts) 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 -@avp_types section of the dictionary and Data is the value to -encode/decode.

+@avp_types section of the dictionary, Data is the value to +encode/decode, and Opts is a term that is passed through encode/decode.

Example:

@@ -328,8 +329,8 @@ Framed-IP-Address

Like @custom_types but requires the specified module to export -Mod:Type(encode|decode, Name, Data) rather than -Mod:Name(encode|decode, Type, Data).

+Mod:Type(encode|decode, Name, Data, Opts) rather than +Mod:Name(encode|decode, Type, Data, Opts).

Example:

-- cgit v1.2.3