From 2d540b95755a6f628b0cfc5a9bab4ff41046fe4b Mon Sep 17 00:00:00 2001
From: Anders Svensson
Date: Thu, 24 Aug 2017 11:51:44 +0200
Subject: Rename type evaluable -> eval
Export the old type as a synonym for backwards compatability. The name
evaluable is a bit too awkward.
---
lib/diameter/doc/src/diameter.xml | 30 +++++++++++++++---------------
lib/diameter/doc/src/diameter_app.xml | 9 +++++----
lib/diameter/doc/src/seealso.ent | 4 ++--
3 files changed, 22 insertions(+), 21 deletions(-)
(limited to 'lib/diameter/doc/src')
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 264dbf9152..6a4a7b9f7c 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -397,10 +397,10 @@ from the peer offers it.
Note that each tuple communicates one or more AVP values.
It is an error to specify duplicate tuples.
--
Matches only those peers for which the specified
-&evaluable; returns
+&eval; returns
true when applied to the connection's diameter_caps
record.
Any other return value or exception is equivalent to false.
@@ -650,7 +650,7 @@ Result = ResultCode | {capabilities_cb, CB, ResultCode|discard}
Caps = #diameter_caps{}
Pkt = #diameter_packet{}
ResultCode = integer()
-CB = &evaluable;
+CB = &eval;
@@ -843,7 +843,7 @@ Length field in a Diameter Header.
| node
| nodes
| [node()]
- | evaluable()}
+ | eval()}
-
The degree to which the service allows multiple transport
@@ -854,7 +854,7 @@ at capabilities exchange.
If [node()] then a connection is rejected if another already
exists on any of the specified nodes.
Types false, node, nodes and
-&evaluable; are equivalent to
+&eval; are equivalent to
[], [node()], [node()|nodes()] and the
evaluated value respectively, evaluation of each expression taking
place whenever a new connection is to be established.
@@ -869,7 +869,7 @@ by their own peer and watchdog state machines.
Defaults to nodes.
-{sequence, {H,N} | &evaluable;}
+{sequence, {H,N} | &eval;}
-
A constant value H for the topmost 32-N bits of
@@ -904,7 +904,7 @@ outgoing requests.
-{share_peers, boolean() | [node()] | evaluable()}
+{share_peers, boolean() | [node()] | eval()}
-
Nodes to which peer connections established on the local
@@ -917,7 +917,7 @@ configured to use them: see use_shared_peers below.
If false then peers are not shared.
If [node()] then peers are shared with the specified list of
nodes.
-If evaluable() then peers are shared with the nodes returned
+If eval() then peers are shared with the nodes returned
by the specified function, evaluated whenever a peer connection
becomes available or a remote service requests information about local
connections.
@@ -1073,7 +1073,7 @@ omitted counters are not returned by &service_info;.
-{use_shared_peers, boolean() | [node()] | evaluable()}
+{use_shared_peers, boolean() | [node()] | eval()}
-
Nodes from which communicated peers are made available in
@@ -1083,7 +1083,7 @@ the remote candidates list of &app_pick_peer; callbacks.
If false then remote peers are not used.
If [node()] then only peers from the specified list of nodes
are used.
-If evaluable() then only peers returned by the specified
+If eval() then only peers returned by the specified
function are used, evaluated whenever a remote service communicates
information about an available peer connection.
The value true is equivalent to fun &nodes;.
@@ -1155,7 +1155,7 @@ TLS is desired over TCP as implemented by &man_tcp;.
-{capabilities_cb, &evaluable;}
+{capabilities_cb, &eval;}
-
Callback invoked upon reception of CER/CEA during capabilities
@@ -1249,7 +1249,7 @@ transport.
-{disconnect_cb, &evaluable;}
+{disconnect_cb, &eval;}
-
Callback invoked prior to terminating the transport process of a
diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml
index dfcd00975b..aa334beb21 100644
--- a/lib/diameter/doc/src/diameter_app.xml
+++ b/lib/diameter/doc/src/diameter_app.xml
@@ -13,7 +13,8 @@
-20112016
+2011
+2017
Ericsson AB. All Rights Reserved.
@@ -319,7 +320,7 @@ or &peer_down; callback.
Action = Send | Discard | {eval_packet, Action, PostF}
Send = {send, &packet; | &message;}
Discard = {discard, Reason} | discard
-PostF = &mod_evaluable;}
+PostF = &mod_eval;}
@@ -371,7 +372,7 @@ discarded}.
Action = Send | Discard | {eval_packet, Action, PostF}
Send = {send, &packet; | &message;}
Discard = {discard, Reason} | discard
-PostF = &mod_evaluable;}
+PostF = &mod_eval;}
@@ -478,7 +479,7 @@ not selected.
| {answer_message, 3000..3999|5000..5999}
| {protocol_error, 3000..3999}
Opt = &mod_call_opt;
-PostF = &mod_evaluable;
+PostF = &mod_eval;
diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent
index e5c284c6e8..ef6af1a3d0 100644
--- a/lib/diameter/doc/src/seealso.ent
+++ b/lib/diameter/doc/src/seealso.ent
@@ -4,7 +4,7 @@
%CopyrightBegin%
-Copyright Ericsson AB 2012-2015. All Rights Reserved.
+Copyright Ericsson AB 2012-2017. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -53,7 +53,7 @@ significant.
diameter:application_opt()'>
diameter:call_opt()'>
diameter:capability()'>
-diameter:evaluable()'>
+diameter:eval()'>
diameter:peer_filter()'>
diameter:service_event()'>
diameter:service_event_info()'>
--
cgit v1.2.3