Refresh example code

Which hasn't received any attention for some time. Clean it up, rename
the poorly named peer.erl (it's Diameter *nodes* that are implemented),
and make the it possible to specify arbitrary transport configuration.

8 files changed, 225 insertions, 214 deletions

diff --git a/lib/diameter/examples/code/GNUmakefile b/lib/diameter/examples/code/GNUmakefile
index 98e36a99e3..81f1da5a39 100644
--- a/lib/diameter/examples/code/GNUmakefile
+++ b/lib/diameter/examples/code/GNUmakefile
@@ -1,7 +1,7 @@
 #
 # %CopyrightBegin%
 #
-# Copyright Ericsson AB 2010-2012. All Rights Reserved.
+# Copyright Ericsson AB 2010-2015. All Rights Reserved.
 #
 # The contents of this file are subject to the Erlang Public License,
 # Version 1.1, (the "License"); you may not use this file except in
@@ -20,7 +20,7 @@
 EXAMPLES  = client server relay # redirect proxy
 
 CALLBACKS = $(EXAMPLES:%=%_cb)
-MODULES   = peer $(EXAMPLES) $(EXAMPLES:%=%_cb)
+MODULES   = node $(EXAMPLES) $(EXAMPLES:%=%_cb)
 
 BEAM = $(MODULES:%=%.beam)
 
diff --git a/lib/diameter/examples/code/client.erl b/lib/diameter/examples/code/client.erl
index 46eb4a55db..be5b4cbba5 100644
--- a/lib/diameter/examples/code/client.erl
+++ b/lib/diameter/examples/code/client.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2010-2014. All Rights Reserved.
+%% Copyright Ericsson AB 2010-2015. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -38,7 +38,7 @@
 -module(client).
 
 -include_lib("diameter/include/diameter.hrl").
--include_lib("diameter/include/diameter_gen_base_rfc3588.hrl").
+-include_lib("diameter/include/diameter_gen_base_rfc6733.hrl").
 
 -export([start/1,     %% start a service
          connect/2,   %% add a connecting transport
@@ -50,17 +50,14 @@
 %% both the record and list encoding here, one detached and one not,
 %% is just for demonstration purposes.
 
-%% Convenience functions using the default service name, ?SVC_NAME.
+%% Convenience functions using the default service name.
 -export([start/0,
          connect/1,
          stop/0,
          call/0,
          cast/0]).
 
--define(SVC_NAME,     ?MODULE).
--define(APP_ALIAS,    ?MODULE).
--define(CALLBACK_MOD, client_cb).
-
+-define(DEF_SVC_NAME, ?MODULE).
 -define(L, atom_to_list).
 
 %% The service configuration. As in the server example, a client
@@ -70,27 +67,27 @@
                         {'Origin-Realm', "example.com"},
                         {'Vendor-Id', 0},
                         {'Product-Name', "Client"},
-                        {'Auth-Application-Id', [?DIAMETER_APP_ID_COMMON]},
-                        {application, [{alias, ?APP_ALIAS},
-                                       {dictionary, ?DIAMETER_DICT_COMMON},
-                                       {module, ?CALLBACK_MOD}]}]).
+                        {'Auth-Application-Id', [0]},
+                        {application, [{alias, common},
+                                       {dictionary, diameter_gen_base_rfc6733},
+                                       {module, client_cb}]}]).
 
 %% start/1
 
 start(Name)
   when is_atom(Name) ->
-    peer:start(Name, ?SERVICE(Name)).
+    node:start(Name, ?SERVICE(Name)).
 
 start() ->
-    start(?SVC_NAME).
+    start(?DEF_SVC_NAME).
 
 %% connect/2
 
 connect(Name, T) ->
-    peer:connect(Name, T).
+    node:connect(Name, T).
 
 connect(T) ->
-    connect(?SVC_NAME, T).
+    connect(?DEF_SVC_NAME, T).
 
 %% call/1
 
@@ -99,10 +96,10 @@ call(Name) ->
     RAR = #diameter_base_RAR{'Session-Id' = SId,
                              'Auth-Application-Id' = 0,
                              'Re-Auth-Request-Type' = 0},
-    diameter:call(Name, ?APP_ALIAS, RAR, []).
+    diameter:call(Name, common, RAR, []).
 
 call() ->
-    call(?SVC_NAME).
+    call(?DEF_SVC_NAME).
 
 %% cast/1
 
@@ -111,15 +108,15 @@ cast(Name) ->
     RAR = ['RAR', {'Session-Id', SId},
                   {'Auth-Application-Id', 0},
                   {'Re-Auth-Request-Type', 1}],
-    diameter:call(Name, ?APP_ALIAS, RAR, [detach]).
+    diameter:call(Name, common, RAR, [detach]).
 
 cast() ->
-    cast(?SVC_NAME).
+    cast(?DEF_SVC_NAME).
 
 %% stop/1
 
 stop(Name) ->
-    peer:stop(Name).
+    node:stop(Name).
 
 stop() ->
-    stop(?SVC_NAME).
+    stop(?DEF_SVC_NAME).
diff --git a/lib/diameter/examples/code/node.erl b/lib/diameter/examples/code/node.erl
new file mode 100644
index 0000000000..4fe9007059
--- /dev/null
+++ b/lib/diameter/examples/code/node.erl
@@ -0,0 +1,174 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2010-2015. All Rights Reserved.
+%%
+%% The contents of this file are subject to the Erlang Public License,
+%% Version 1.1, (the "License"); you may not use this file except in
+%% compliance with the License. You should have received a copy of the
+%% Erlang Public License along with this software. If not, it can be
+%% retrieved online at http://www.erlang.org/.
+%%
+%% Software distributed under the License is distributed on an "AS IS"
+%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+%% the License for the specific language governing rights and limitations
+%% under the License.
+%%
+%% %CopyrightEnd%
+%%
+
+%%
+%% A library module used by the example Diameter nodes. Does little
+%% more than provide an alternate/simplified transport configuration.
+%%
+
+-module(node).
+
+-export([start/2,
+         listen/2,
+         connect/2,
+         stop/1]).
+
+-type protocol()
+   :: tcp | sctp.
+
+-type ip_address()
+   :: default
+    | inet:ip_address().
+
+-type server_transport()
+   :: protocol()
+    | {protocol(), ip_address(), non_neg_integer()}.
+
+-type server_opts()
+   :: server_transport()
+    | {server_transport(), [diameter:transport_opt()]}
+    | [diameter:transport_opt()].
+
+-type client_transport()
+   :: protocol() | any
+    | {protocol() | any, ip_address(), non_neg_integer()}
+    | {protocol() | any, ip_address(), ip_address(), non_neg_integer()}.
+
+-type client_opts()
+   :: client_transport()
+    | {client_transport(), [diameter:transport_opt()]}
+    | [diameter:transport_opt()].
+
+%% The server_transport() and client_transport() config is just
+%% convenience: arbitrary options can be specifed as a
+%% [diameter:transport_opt()].
+
+-define(DEFAULT_PORT, 3868).
+
+%% ---------------------------------------------------------------------------
+%% Interface functions
+%% ---------------------------------------------------------------------------
+
+%% start/2
+
+-spec start(diameter:service_name(), [diameter:service_opt()])
+   -> ok
+    | {error, term()}.
+
+start(Name, Opts)
+  when is_atom(Name), is_list(Opts) ->
+    diameter:start_service(Name, Opts).
+
+%% connect/2
+
+-spec connect(diameter:service_name(), client_opts())
+   -> {ok, diameter:transport_ref()}
+    | {error, term()}.
+
+connect(Name, Opts)
+  when is_list(Opts) ->
+    diameter:add_transport(Name, {connect, Opts});
+
+connect(Name, {T, Opts}) ->
+    connect(Name, Opts ++ client_opts(T));
+
+connect(Name, T) ->
+    connect(Name, [{connect_timer, 5000} | client_opts(T)]).
+
+%% listen/2
+
+-spec listen(diameter:service_name(), server_opts())
+   -> {ok, diameter:transport_ref()}
+    | {error, term()}.
+
+listen(Name, Opts)
+  when is_list(Opts) ->
+    diameter:add_transport(Name, {listen, Opts});
+
+listen(Name, {T, Opts}) ->
+    listen(Name, Opts ++ server_opts(T));
+
+listen(Name, T) ->
+    listen(Name, server_opts(T)).
+
+%% stop/1
+
+-spec stop(diameter:service_name())
+   -> ok
+    | {error, term()}.
+
+stop(Name) ->
+    diameter:stop_service(Name).
+
+%% ---------------------------------------------------------------------------
+%% Internal functions
+%% ---------------------------------------------------------------------------
+
+%% server_opts/1
+%%
+%% Return transport options for a listening transport.
+
+server_opts({T, Addr, Port}) ->
+    [{transport_module, tmod(T)},
+     {transport_config, [{reuseaddr, true},
+                         {ip, addr(Addr)},
+                         {port, Port}]}];
+
+server_opts(T) ->
+    server_opts({T, loopback, ?DEFAULT_PORT}).
+
+%% client_opts/1
+%%
+%% Return transport options for a connecting transport.
+
+client_opts({T, LA, RA, RP})
+  when T == all;   %% backwards compatibility
+       T == any ->
+    [[S, {C,Os}], T] = [client_opts({P, LA, RA, RP}) || P <- [sctp,tcp]],
+    [S, {C,Os,2000} | T];
+
+client_opts({T, LA, RA, RP}) ->
+    [{transport_module, tmod(T)},
+     {transport_config, [{raddr, addr(RA)},
+                         {rport, RP},
+                         {reuseaddr, true}
+                         | ip(LA)]}];
+
+client_opts({T, RA, RP}) ->
+    client_opts({T, default, RA, RP});
+
+client_opts(T) ->
+    client_opts({T, loopback, loopback, ?DEFAULT_PORT}).
+
+%% ---------------------------------------------------------------------------
+
+tmod(tcp)  -> diameter_tcp;
+tmod(sctp) -> diameter_sctp.
+
+ip(default) ->
+    [];
+ip(loopback) ->
+    [{ip, {127,0,0,1}}];
+ip(Addr) ->
+    [{ip, Addr}].
+
+addr(loopback) ->
+    {127,0,0,1};
+addr(A) ->
+    A.
diff --git a/lib/diameter/examples/code/peer.erl b/lib/diameter/examples/code/peer.erl
deleted file mode 100644
index 7519abfb2c..0000000000
--- a/lib/diameter/examples/code/peer.erl
+++ /dev/null
@@ -1,150 +0,0 @@
-%%
-%% %CopyrightBegin%
-%%
-%% Copyright Ericsson AB 2010-2013. All Rights Reserved.
-%%
-%% The contents of this file are subject to the Erlang Public License,
-%% Version 1.1, (the "License"); you may not use this file except in
-%% compliance with the License. You should have received a copy of the
-%% Erlang Public License along with this software. If not, it can be
-%% retrieved online at http://www.erlang.org/.
-%%
-%% Software distributed under the License is distributed on an "AS IS"
-%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-%% the License for the specific language governing rights and limitations
-%% under the License.
-%%
-%% %CopyrightEnd%
-%%
-
-%%
-%% A library module that factors out commonality in the example
-%% Diameter peers.
-%%
-
--module(peer).
-
--include_lib("diameter/include/diameter.hrl").
--include_lib("diameter/include/diameter_gen_base_rfc3588.hrl").
-
--export([start/2,
-         listen/2,
-         connect/2,
-         stop/1]).
-
--type service_name()
-   :: term().
-
--type protocol()
-   :: tcp | sctp.
-
--type ip_address()
-   :: default
-    | inet:ip_address().
-
--type server_config()
-   :: protocol()
-    | {protocol(), ip_address(), non_neg_integer()}.
-
--type client_config()
-   :: protocol()
-    | {protocol(), ip_address(), non_neg_integer()}
-    | {protocol(), ip_address(), ip_address(), non_neg_integer()}.
-
--define(DEFAULT_PORT, 3868).
-
-%% ---------------------------------------------------------------------------
-%% Interface functions
-%% ---------------------------------------------------------------------------
-
-%% start/2
-
--spec start(service_name(), list())
-   -> ok
-    | {error, term()}.
-
-start(Name, Opts)
-  when is_atom(Name), is_list(Opts) ->
-    diameter:start_service(Name, Opts).
-
-%% connect/2
-
--spec connect(service_name(), client_config())
-   -> {ok, reference()}
-    | {error, term()}.
-
-connect(Name, T) ->
-    diameter:add_transport(Name, {connect, [{connect_timer, 5000}
-                                            | client(T)]}).
-
-%% listen/2
-
--spec listen(service_name(), server_config())
-   -> {ok, reference()}
-    | {error, term()}.
-
-listen(Name, T) ->
-    diameter:add_transport(Name, {listen, server(T)}).
-
-%% stop/1
-
--spec stop(service_name())
-   -> ok
-    | {error, term()}.
-
-stop(Name) ->
-    diameter:stop_service(Name).
-
-%% ---------------------------------------------------------------------------
-%% Internal functions
-%% ---------------------------------------------------------------------------
-
-%% server/1
-%%
-%% Return config for a listening transport.
-
-server({T, Addr, Port}) ->
-    [{transport_module, tmod(T)},
-     {transport_config, [{reuseaddr, true},
-                         {ip, addr(Addr)},
-                         {port, Port}]}];
-
-server(T) ->
-    server({T, loopback, ?DEFAULT_PORT}).
-
-%% client/1
-%%
-%% Return config for a connecting transport.
-
-client({all, LA, RA, RP}) ->
-    [[M,{K,C}], T]
-        = [client({P, LA, RA, RP}) || P <- [sctp,tcp]],
-    [M, {K,C,2000} | T];
-
-client({T, LA, RA, RP}) ->
-    [{transport_module, tmod(T)},
-     {transport_config, [{raddr, addr(RA)},
-                         {rport, RP},
-                         {reuseaddr, true}
-                         | ip(LA)]}];
-
-client({T, RA, RP}) ->
-    client({T, default, RA, RP});
-
-client(T) ->
-    client({T, loopback, loopback, ?DEFAULT_PORT}).
-
-tmod(tcp)  -> diameter_tcp;
-tmod(sctp) -> diameter_sctp.
-
-ip(default) ->
-    [];
-ip(loopback) ->
-    [{ip, {127,0,0,1}}];
-ip(Addr) ->
-    [{ip, Addr}].
-
-addr(loopback) ->
-    {127,0,0,1};
-addr(A) ->
-    A.
diff --git a/lib/diameter/examples/code/relay.erl b/lib/diameter/examples/code/relay.erl
index d3438f83f3..0aa3cd06d3 100644
--- a/lib/diameter/examples/code/relay.erl
+++ b/lib/diameter/examples/code/relay.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2010-2012. All Rights Reserved.
+%% Copyright Ericsson AB 2010-2015. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -31,9 +31,6 @@
 
 -module(relay).
 
--include_lib("diameter/include/diameter.hrl").
--include_lib("diameter/include/diameter_gen_base_rfc3588.hrl").
-
 -export([start/1,
          listen/2,
          connect/2,
@@ -44,49 +41,47 @@
          connect/1,
          stop/0]).
 
--define(APP_ALIAS,    ?MODULE).
--define(SVC_NAME,     ?MODULE).
--define(CALLBACK_MOD, relay_cb).
+-define(DEF_SVC_NAME, ?MODULE).
 
 %% The service configuration.
 -define(SERVICE(Name), [{'Origin-Host', atom_to_list(Name) ++ ".example.com"},
                         {'Origin-Realm', "example.com"},
                         {'Vendor-Id', 193},
                         {'Product-Name', "RelayAgent"},
-                        {'Auth-Application-Id', [?DIAMETER_APP_ID_RELAY]},
-                        {application, [{alias, ?MODULE},
-                                       {dictionary, ?DIAMETER_DICT_RELAY},
-                                       {module, ?CALLBACK_MOD}]}]).
+                        {'Auth-Application-Id', [16#FFFFFFFF]},
+                        {application, [{alias, relay},
+                                       {dictionary, diameter_relay},
+                                       {module, relay_cb}]}]).
 
 %% start/1
 
 start(Name)
   when is_atom(Name) ->
-    peer:start(Name, ?SERVICE(Name)).
+    node:start(Name, ?SERVICE(Name)).
 
 start() ->
-    start(?SVC_NAME).
+    start(?DEF_SVC_NAME).
 
 %% listen/2
 
 listen(Name, T) ->
-    peer:listen(Name, T).
+    node:listen(Name, T).
 
 listen(T) ->
-    listen(?SVC_NAME, T).
+    listen(?DEF_SVC_NAME, T).
 
 %% connect/2
 
 connect(Name, T) ->
-    peer:connect(Name, T).
+    node:connect(Name, T).
 
 connect(T) ->
-    connect(?SVC_NAME, T).
+    connect(?DEF_SVC_NAME, T).
 
 %% stop/1
 
 stop(Name) ->
-    peer:stop(Name).
+    node:stop(Name).
 
 stop() ->
-    stop(?SVC_NAME).
+    stop(?DEF_SVC_NAME).
diff --git a/lib/diameter/examples/code/server.erl b/lib/diameter/examples/code/server.erl
index 3959461cec..8c91e68895 100644
--- a/lib/diameter/examples/code/server.erl
+++ b/lib/diameter/examples/code/server.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2010-2012. All Rights Reserved.
+%% Copyright Ericsson AB 2010-2015. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -34,21 +34,16 @@
 
 -module(server).
 
--include_lib("diameter/include/diameter.hrl").
--include_lib("diameter/include/diameter_gen_base_rfc3588.hrl").
-
 -export([start/1,    %% start a service
          listen/2,   %% add a listening transport
          stop/1]).   %% stop a service
 
-%% Convenience functions using the default service name, ?SVC_NAME.
+%% Convenience functions using the default service name.
 -export([start/0,
          listen/1,
          stop/0]).
 
--define(SVC_NAME,     ?MODULE).
--define(APP_ALIAS,    ?MODULE).
--define(CALLBACK_MOD, server_cb).
+-define(DEF_SVC_NAME, ?MODULE).
 
 %% The service configuration. In a server supporting multiple Diameter
 %% applications each application may have its own, although they could all
@@ -57,32 +52,32 @@
                         {'Origin-Realm', "example.com"},
                         {'Vendor-Id', 193},
                         {'Product-Name', "Server"},
-                        {'Auth-Application-Id', [?DIAMETER_APP_ID_COMMON]},
-                        {application, [{alias, ?APP_ALIAS},
-                                       {dictionary, ?DIAMETER_DICT_COMMON},
-                                       {module, ?CALLBACK_MOD}]}]).
+                        {'Auth-Application-Id', [0]},
+                        {application, [{alias, common},
+                                       {dictionary, diameter_gen_base_rfc6733},
+                                       {module, server_cb}]}]).
 
 %% start/1
 
 start(Name)
   when is_atom(Name) ->
-    peer:start(Name, ?SERVICE(Name)).
+    node:start(Name, ?SERVICE(Name)).
 
 start() ->
-    start(?SVC_NAME).
+    start(?DEF_SVC_NAME).
 
 %% listen/2
 
 listen(Name, T) ->
-    peer:listen(Name, T).
+    node:listen(Name, T).
 
 listen(T) ->
-    listen(?SVC_NAME, T).
+    listen(?DEF_SVC_NAME, T).
 
 %% stop/1
 
 stop(Name) ->
-    peer:stop(Name).
+    node:stop(Name).
 
 stop() ->
-    stop(?SVC_NAME).
+    stop(?DEF_SVC_NAME).
diff --git a/lib/diameter/examples/code/server_cb.erl b/lib/diameter/examples/code/server_cb.erl
index 9d8d395d06..071e152493 100644
--- a/lib/diameter/examples/code/server_cb.erl
+++ b/lib/diameter/examples/code/server_cb.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2010-2014. All Rights Reserved.
+%% Copyright Ericsson AB 2010-2015. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -24,7 +24,7 @@
 -module(server_cb).
 
 -include_lib("diameter/include/diameter.hrl").
--include_lib("diameter/include/diameter_gen_base_rfc3588.hrl").
+-include_lib("diameter/include/diameter_gen_base_rfc6733.hrl").
 
 %% diameter callbacks
 -export([peer_up/3,
diff --git a/lib/diameter/src/modules.mk b/lib/diameter/src/modules.mk
index a2a7a51892..c9dd4e683a 100644
--- a/lib/diameter/src/modules.mk
+++ b/lib/diameter/src/modules.mk
@@ -1,7 +1,7 @@
 
 # %CopyrightBegin%
 #
-# Copyright Ericsson AB 2010-2014. All Rights Reserved.
+# Copyright Ericsson AB 2010-2015. All Rights Reserved.
 #
 # The contents of this file are subject to the Erlang Public License,
 # Version 1.1, (the "License"); you may not use this file except in
@@ -94,7 +94,7 @@ BINS = \
 # Released files relative to ../examples.
 EXAMPLES = \
 	code/GNUmakefile \
-	code/peer.erl \
+	code/node.erl \
 	code/client.erl \
 	code/client_cb.erl \
 	code/server.erl \