aboutsummaryrefslogtreecommitdiffstats
path: root/lib/diameter/doc/src/diameter.xml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/diameter/doc/src/diameter.xml')
-rw-r--r--lib/diameter/doc/src/diameter.xml57
1 files changed, 29 insertions, 28 deletions
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 0bfbf62cd3..38b3cdcba5 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -368,7 +368,8 @@ eval(F) ->
</code>
<p>
-Applying an evaluable() <c>E</c> to an argument list <c>A</c>
+Applying an <c><seealso marker="#evaluable">evaluable()</seealso></c>
+<c>E</c> to an argument list <c>A</c>
is meant in the sense of <c>eval([E|A])</c>.</p>
<warning>
@@ -436,8 +437,8 @@ specified value, or all peers if the atom <c>any</c>.</p>
<tag><c>{eval, <seealso marker="#evaluable">evaluable()</seealso>}</c></tag>
<item>
<p>
-Matches only those peers for which the specified <seealso
-marker="#evaluable">evaluable()</seealso> returns
+Matches only those peers for which the specified <c><seealso
+marker="#evaluable">evaluable()</seealso></c> returns
<c>true</c> on the connection's <c>diameter_caps</c> record.
Any other return value or exception is equivalent to <c>false</c>.</p>
</item>
@@ -471,9 +472,9 @@ that matches no peer.</p>
<p>
The <c>host</c> and <c>realm</c> filters examine the
outgoing request as passed to <seealso marker="#call">call/4</seealso>,
-assuming that this is a record- or list-valued <seealso
-marker="diameter_app#message">diameter_app:message()</seealso>, and that
-the message contains at most one of each AVP.
+assuming that this is a record- or list-valued <c><seealso
+marker="diameter_app#message">diameter_app:message()</seealso></c>,
+and that the message contains at most one of each AVP.
If this is not the case then the <c>{host|realm, <seealso
marker="diameter_dict#DATA_TYPES">DiameterIdentity()</seealso>}</c>
filters must be used to achieve the desired result.
@@ -675,7 +676,7 @@ that is somewhat unique.</p>
<p>
An option passed to <seealso
marker="#start_service">start_service/2</seealso>.
-Can be any <seealso marker="#capability">capability()</seealso> as
+Can be any <c><seealso marker="#capability">capability()</seealso></c> as
well as the following.</p>
<taglist>
@@ -688,8 +689,8 @@ Defines a Diameter application supported by the service.</p>
<p>
A service must configure one <c>application</c> for each Diameter
application it intends to support.
-For an outgoing Diameter request, the relevant <seealso
-marker="#application_alias">application_alias()</seealso> is
+For an outgoing Diameter request, the relevant <c><seealso
+marker="#application_alias">application_alias()</seealso></c> is
passed to <seealso marker="#call">call/4</seealso>, while for an
incoming request the application identifier in the message
header determines the application, the identifier being specified in
@@ -786,8 +787,8 @@ TLS is desired over TCP as implemented by
A callback invoked upon reception of CER/CEA during capabilities
exchange in order to ask whether or not the connection should
be accepted.
-Applied to the relevant <seealso
-marker="#transport_ref">transport_ref()</seealso> and the
+Applied to the relevant <c><seealso
+marker="#transport_ref">transport_ref()</seealso></c> and the
<c>#diameter_caps{}</c> record of the connection.
Returning <c>ok</c> accepts the connection.
Returning <c>integer()</c> causes an incoming
@@ -1075,7 +1076,7 @@ outgoing messages.</p>
<p>
The value returned is the number of seconds since 19680120T031408Z,
-the first value that can be encoded as a Diameter <seealso marker="diameter_dict#DATA_TYPES">Time()</seealso>,
+the first value that can be encoded as a Diameter <c><seealso marker="diameter_dict#DATA_TYPES">Time()</seealso></c>,
at the time the diameter application was started.</p>
<marker id="remove_transport"/>
@@ -1245,20 +1246,20 @@ An example return value with for a client service with Origin-Host
</code>
<p>
-Here <c>ref</c> is a <seealso
-marker="#transport_ref">transport_ref()</seealso> and <c>options</c>
-the corresponding <seealso
-marker="#transport_opt">transport_opt()</seealso> list passed to <seealso
+Here <c>ref</c> is a <c><seealso
+marker="#transport_ref">transport_ref()</seealso></c> and <c>options</c>
+the corresponding <c><seealso
+marker="#transport_opt">transport_opt()</seealso></c> list passed to <seealso
marker="#add_transport">add_transport/2</seealso>.
The <c>watchdog</c> entry shows the state of a connection's RFC 3539 watchdog
state machine.
-The <c>peer</c> entry identifies the <seealso
-marker="diameter_app#peer_ref">diameter_app:peer_ref()</seealso> for
+The <c>peer</c> entry identifies the <c><seealso
+marker="diameter_app#peer_ref">diameter_app:peer_ref()</seealso></c> for
which there will have been <seealso
marker="diameter_app#peer_up">peer_up</seealso> callbacks for the
Diameter applications identified by the <c>apps</c> entry,
-<c>common</c> being the <seealso
-marker="#application_alias">application_alias()</seealso>.
+<c>common</c> being the <c><seealso
+marker="#application_alias">application_alias()</seealso></c>.
The <c>caps</c> entry identifies the capabilities sent by the local
node and received from the peer during capabilities exchange.
The <c>port</c> entry displays socket-level information about the
@@ -1277,8 +1278,8 @@ during the lifetime of the transport configuration.</p>
<p>
A listening transport presents its information slightly differently
-since there may be multiple accepted connections for the same <seealso
-marker="#transport_ref">transport_ref()</seealso>.
+since there may be multiple accepted connections for the same <c><seealso
+marker="#transport_ref">transport_ref()</seealso></c>.
The <c>transport</c> info returned by a server with a single client
connection might look as follows.</p>
@@ -1405,10 +1406,10 @@ contrast to <c>transport</c> info.</p>
<item>
<p>
Return a <c>{{Counter, Ref}, non_neg_integer()}</c> list of counter values.
-<c>Ref</c> can be either a <seealso
-marker="#transport_ref">transport_ref()</seealso>
-or a <seealso
-marker="diameter_app#peer_ref">diameter_app:peer_ref()</seealso>.
+<c>Ref</c> can be either a <c><seealso
+marker="#transport_ref">transport_ref()</seealso></c>
+or a <c><seealso
+marker="diameter_app#peer_ref">diameter_app:peer_ref()</seealso></c>.
Entries for the latter are folded into corresponding entries for the
former as peer connections go down.
Entries for both are removed at <seealso
@@ -1569,8 +1570,8 @@ be called to remove transport configuration.</p>
</type>
<desc>
<p>
-Subscribe to <seealso
-marker="#service_event">service_event()</seealso> messages from
+Subscribe to <c><seealso
+marker="#service_event">service_event()</seealso></c> messages from
a service.</p>
<p>