aboutsummaryrefslogtreecommitdiffstats
path: root/lib/diameter/doc/src/diameter_dict.xml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/diameter/doc/src/diameter_dict.xml')
-rw-r--r--lib/diameter/doc/src/diameter_dict.xml28
1 files changed, 14 insertions, 14 deletions
diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index e7c530f1b8..01616f519d 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -44,9 +44,9 @@ A diameter service as configured with <seealso
marker="diameter#start_service">diameter:start_service/2</seealso>
specifies one or more supported Diameter applications.
Each Diameter application specifies a dictionary module that knows how
-to encode and decode its messages and AVP's.
+to encode and decode its messages and AVPs.
The dictionary module is in turn generated from a file that defines
-these messages and AVP's.
+these messages and AVPs.
The format of such a file is defined in
<seealso marker="#FILE_FORMAT">FILE FORMAT</seealso> below.
Users add support for their specific applications by creating
@@ -56,7 +56,7 @@ resulting dictionaries modules on a service.</p>
<p>
The codec generation also results in a hrl file that defines records
-for the messages and grouped AVP's defined for the application, these
+for the messages and grouped AVPs defined for the application, these
records being what a user of the diameter application sends and receives.
(Modulo other available formats as discussed in <seealso
marker="diameter_app">diameter_app(3)</seealso>.)
@@ -81,7 +81,7 @@ that diameter itself has any specific knowledge of.
The Common Message application is used for messages that diameter
itself handles: CER/CEA, DWR/DWA and DPR/DPA.
The Relay application is given special treatment with regard to
-encode/decode since the messages and AVP's it handles are not specifically
+encode/decode since the messages and AVPs it handles are not specifically
defined.</p>
<marker id="FILE_FORMAT"/>
@@ -167,7 +167,7 @@ Name must be of the same form as a @name.</p>
<p>
A prefix is optional but can
be used to disambiguate record and constant names
-resulting from similarly named messages and AVP's in different
+resulting from similarly named messages and AVPs in different
Diameter applications.</p>
<p>
@@ -182,7 +182,7 @@ Example:</p>
<tag><c>@vendor Number Name</c></tag>
<item>
<p>
-Defines the integer Number as the the default Vendor-ID of AVP's for
+Defines the integer Number as the the default Vendor-ID of AVPs for
which the V flag is set.
Name documents the owner of the application
but is otherwise unused.
@@ -200,7 +200,7 @@ Example:</p>
<tag><c>@avp_vendor_id Number</c></tag>
<item>
<p>
-Defines the integer Number as the Vendor-ID of the AVP's listed in the
+Defines the integer Number as the Vendor-ID of the AVPs listed in the
section content, overriding the <c>@vendor</c> default.
The section content consists of AVP names.
Can occur zero or more times (with different values of Number).</p>
@@ -254,7 +254,7 @@ set on an outgoing AVP or a single - (minus) character if none are to
be set.
Type identifies either an AVP Data Format as defined in <seealso
marker="#DATA_TYPES">DATA TYPES</seealso> below or a
-type as defined by a <c>@custom_types</c> tag.</p>
+type as defined by a <c>@custom_types</c> section.</p>
<p>
Example:</p>
@@ -277,11 +277,11 @@ to 0 as mandated by the current draft standard.</p>
<item>
<p>
Defines AVPs for which module Mod provides encode/decode.
-The section contents consists of type names.
-For each AVP Name defined with custom type Type, Mod should export the
-function Name/3 with arguments encode|decode, Type and Data,
-the latter being the term to be encoded/decoded.
-The function returns the encoded/decoded value.</p>
+The section contents consists of AVP names.
+For each AVP Name in the content, <c>Mod:Name(encode|decode, Type, Data)</c>
+is expected to provide encode/decode for values of the AVP, where Type
+is the type of the AVP as declared in the <c>@avp_types</c> section
+of the dictionary and Data is the value to encoded/decoded.</p>
<p>
Can occur 0 or more times (with different values of Mod).</p>
@@ -290,7 +290,7 @@ Can occur 0 or more times (with different values of Mod).</p>
Example:</p>
<code>
-@custom_types rfc4005_types
+@custom_types rfc4005_avps
Framed-IP-Address
</code>