From 722fa41564381dff0b7aa2b465193db30bb2f02f Mon Sep 17 00:00:00 2001
From: Anders Svensson <anders@erlang.org>
Date: Thu, 6 Jul 2017 09:58:07 +0200
Subject: Add service_opt() record_decode

To control whether or not messages and grouped AVPs are decoded to
records, in #diameter_packet.msg and #diameter_avp.value respectively.
The decode became unnecessary for diameter's needs in parent commit,
which decoupled it from the checking of AVP arities.
---
 lib/diameter/doc/src/diameter.xml | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 2cbe48ecce..663c9cc785 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -969,6 +969,29 @@ occur in the message in question.</p>
 
 </item>
 
+<tag>
+<marker id="record_decode"/><c>{record_decode, boolean()}</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.
+If <c>false</c> then the fields are set to the same value.</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>
-- 
cgit v1.2.3