Move type definitions into diameter.erl

7 files changed, 210 insertions, 203 deletions

diff --git a/lib/diameter/src/base/diameter.erl b/lib/diameter/src/base/diameter.erl
index 2f721421d8..ecd3d9542a 100644
--- a/lib/diameter/src/base/diameter.erl
+++ b/lib/diameter/src/base/diameter.erl
@@ -38,17 +38,46 @@
          service_info/2]).
 
 %% Start/stop the application. In a "real" application this should
-%% typically be a consequence of specifying diameter in a release file
-%% rather than by calling start/stop explicitly.
+%% typically be a consequence of a release file rather than by calling
+%% start/stop explicitly.
 -export([start/0,
          stop/0]).
 
+-export_type([evaluable/0,
+              app_alias/0,
+              service_name/0,
+              capability/0,
+              peer_filter/0,
+              service_opt/0,
+              application_opt/0,
+              app_module/0,
+              transport_ref/0,
+              transport_opt/0,
+              transport_pred/0,
+              call_opt/0]).
+
+-export_type(['OctetString'/0,
+              'Integer32'/0,
+              'Integer64'/0,
+              'Unsigned32'/0,
+              'Unsigned64'/0,
+              'Float32'/0,
+              'Float64'/0,
+              'Grouped'/0,
+              'Address'/0,
+              'Time'/0,
+              'UTF8String'/0,
+              'DiameterIdentity'/0,
+              'DiameterURI'/0,
+              'Enumerated'/0,
+              'IPFilterRule'/0,
+              'QoSFilterRule'/0]).
+
 -include("diameter_internal.hrl").
--include("diameter_types.hrl").
 
-%%% --------------------------------------------------------------------------
-%%% start/0
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% start/0
+%% ---------------------------------------------------------------------------
 
 -spec start()
    -> ok
@@ -57,9 +86,9 @@
 start() ->
     application:start(?APPLICATION).
 
-%%% --------------------------------------------------------------------------
-%%% stop/0
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% stop/0
+%% ---------------------------------------------------------------------------
 
 -spec stop()
    -> ok
@@ -68,9 +97,9 @@ start() ->
 stop() ->
     application:stop(?APPLICATION).
 
-%%% --------------------------------------------------------------------------
-%%% start_service/2
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% start_service/2
+%% ---------------------------------------------------------------------------
 
 -spec start_service(service_name(), [service_opt()])
    -> ok
@@ -80,9 +109,9 @@ start_service(SvcName, Opts)
   when is_list(Opts) ->
     diameter_config:start_service(SvcName, Opts).
 
-%%% --------------------------------------------------------------------------
-%%% stop_service/1
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% stop_service/1
+%% ---------------------------------------------------------------------------
 
 -spec stop_service(service_name())
    -> ok
@@ -91,9 +120,9 @@ start_service(SvcName, Opts)
 stop_service(SvcName) ->
     diameter_config:stop_service(SvcName).
 
-%%% --------------------------------------------------------------------------
-%%% services/0
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% services/0
+%% ---------------------------------------------------------------------------
 
 -spec services()
    -> [service_name()].
@@ -101,9 +130,9 @@ stop_service(SvcName) ->
 services() ->
     [Name || {Name, _} <- diameter_service:services()].
 
-%%% --------------------------------------------------------------------------
-%%% service_info/2
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% service_info/2
+%% ---------------------------------------------------------------------------
 
 -spec service_info(service_name(), atom() | [atom()])
    -> any().
@@ -111,9 +140,9 @@ services() ->
 service_info(SvcName, Option) ->
     diameter_service:info(SvcName, Option).
 
-%%% --------------------------------------------------------------------------
-%%% add_transport/3
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% add_transport/3
+%% ---------------------------------------------------------------------------
 
 -spec add_transport(service_name(), {listen|connect, [transport_opt()]})
    -> {ok, transport_ref()}
@@ -123,9 +152,9 @@ add_transport(SvcName, {T, Opts} = Cfg)
   when is_list(Opts), (T == connect orelse T == listen) ->
     diameter_config:add_transport(SvcName, Cfg).
 
-%%% --------------------------------------------------------------------------
-%%% remove_transport/2
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% remove_transport/2
+%% ---------------------------------------------------------------------------
 
 -spec remove_transport(service_name(), transport_pred())
    -> ok | {error, term()}.
@@ -133,12 +162,9 @@ add_transport(SvcName, {T, Opts} = Cfg)
 remove_transport(SvcName, Pred) ->
     diameter_config:remove_transport(SvcName, Pred).
 
-%%% --------------------------------------------------------------------------
-%%% # subscribe(SvcName)
-%%%
-%%% Description: Subscribe to #diameter_event{} messages for the specified
-%%%              service.
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% subscribe/1
+%% ---------------------------------------------------------------------------
 
 -spec subscribe(service_name())
    -> true.
@@ -146,9 +172,9 @@ remove_transport(SvcName, Pred) ->
 subscribe(SvcName) ->
     diameter_service:subscribe(SvcName).
 
-%%% --------------------------------------------------------------------------
-%%% # unsubscribe(SvcName)
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% unsubscribe/1
+%% ---------------------------------------------------------------------------
 
 -spec unsubscribe(service_name())
    -> true.
@@ -156,9 +182,9 @@ subscribe(SvcName) ->
 unsubscribe(SvcName) ->
     diameter_service:unsubscribe(SvcName).
 
-%%% ----------------------------------------------------------
-%%% # session_id/1
-%%% ----------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% session_id/1
+%% ---------------------------------------------------------------------------
 
 -spec session_id('DiameterIdentity'())
    -> 'OctetString'().
@@ -166,9 +192,9 @@ unsubscribe(SvcName) ->
 session_id(Ident) ->
     diameter_session:session_id(Ident).
 
-%%% ----------------------------------------------------------
-%%% # origin_state_id/0
-%%% ----------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% origin_state_id/0
+%% ---------------------------------------------------------------------------
 
 -spec origin_state_id()
    -> 'Unsigned32'().
@@ -176,9 +202,9 @@ session_id(Ident) ->
 origin_state_id() ->
     diameter_session:origin_state_id().
 
-%%% --------------------------------------------------------------------------
-%%% # call/[34]
-%%% --------------------------------------------------------------------------
+%% ---------------------------------------------------------------------------
+%% call/3,4
+%% ---------------------------------------------------------------------------
 
 -spec call(service_name(), app_alias(), any(), [call_opt()])
    -> any().
@@ -188,3 +214,124 @@ call(SvcName, App, Message, Options) ->
 
 call(SvcName, App, Message) ->
     call(SvcName, App, Message, []).
+
+%% ===========================================================================
+
+%% Diameter basic types
+
+-type 'OctetString'() :: iolist().
+-type 'Integer32'()   :: -2147483647..2147483647.
+-type 'Integer64'()   :: -9223372036854775807..9223372036854775807.
+-type 'Unsigned32'()  :: 0..4294967295.
+-type 'Unsigned64'()  :: 0..18446744073709551615.
+-type 'Float32'()     :: '-infinity' | float() | infinity.
+-type 'Float64'()     :: '-infinity' | float() | infinity.
+-type 'Grouped'()     :: list() | tuple().
+
+%% Diameter derived types
+
+-type 'Address'()
+   :: inet:ip_address()
+    | string().
+
+-type 'Time'()             :: {{integer(), 1..12, 1..31},
+                               {0..23, 0..59, 0..59}}.
+-type 'UTF8String'()       :: iolist().
+-type 'DiameterIdentity'() :: 'OctetString'().
+-type 'DiameterURI'()      :: 'OctetString'().
+-type 'Enumerated'()       :: 'Integer32'().
+-type 'IPFilterRule'()     :: 'OctetString'().
+-type 'QoSFilterRule'()    :: 'OctetString'().
+
+%% The handle to a service.
+
+-type service_name()
+   :: any().
+
+%% Capabilities options/avps on start_service/2 and/or add_transport/2
+
+-type capability()
+   :: {'Origin-Host',                    'DiameterIdentity'()}
+    | {'Origin-Realm',                   'DiameterIdentity'()}
+    | {'Host-IP-Address',                ['Address'()]}
+    | {'Vendor-Id',                      'Unsigned32'()}
+    | {'Product-Name',                   'UTF8String'()}
+    | {'Supported-Vendor-Id',            ['Unsigned32'()]}
+    | {'Auth-Application-Id',            ['Unsigned32'()]}
+    | {'Vendor-Specific-Application-Id', ['Grouped'()]}
+    | {'Firmware-Revision',              'Unsigned32'()}.
+
+%% Filters for call/4
+
+-type peer_filter()
+   :: none
+    | host
+    | realm
+    | {host,  any|'DiameterIdentity'()}
+    | {realm, any|'DiameterIdentity'()}
+    | {eval, evaluable()}
+    | {neg, peer_filter()}
+    | {all, [peer_filter()]}
+    | {any, [peer_filter()]}.
+
+-type evaluable()
+   :: {module(), atom(), list()}
+    | fun()
+    | maybe_improper_list(evaluable(), list()).
+
+%% Options passed to start_service/2
+
+-type service_opt()
+   :: capability()
+    | {application, [application_opt()]}.
+
+-type application_opt()
+   :: {alias, app_alias()}
+    | {dictionary, module()}
+    | {module, app_module()}
+    | {state, any()}
+    | {call_mutates_state, boolean()}
+    | {answer_errors, callback|report|discard}.
+
+-type app_alias()
+   :: any().
+
+-type app_module()
+   :: module()
+    | maybe_improper_list(module(), list()).
+
+%% Identifier returned by add_transport/2
+
+-type transport_ref()
+   :: reference().
+
+%% Options passed to add_transport/2
+
+-type transport_opt()
+   :: {transport_module, atom()}
+    | {transport_config, any()}
+    | {applications, [app_alias()]}
+    | {capabilities, [capability()]}
+    | {capabilities_cb, evaluable()}
+    | {watchdog_timer, 'Unsigned32'() | {module(), atom(), list()}}
+    | {reconnect_timer, 'Unsigned32'()}
+    | {private, any()}.
+
+%% Predicate passed to remove_transport/2
+
+-type transport_pred()
+   :: fun((reference(), connect|listen, list()) -> boolean())
+    | fun((reference(), list()) -> boolean())
+    | fun((list()) -> boolean())
+    | reference()
+    | list()
+    | {connect|listen, transport_pred()}
+    | {atom(), atom(), list()}.
+
+%% Options passed to call/4
+
+-type call_opt()
+   :: {extra, list()}
+    | {filter, peer_filter()}
+    | {timeout, 'Unsigned32'()}
+    | detach.
diff --git a/lib/diameter/src/base/diameter_capx.erl b/lib/diameter/src/base/diameter_capx.erl
index 842a9e6103..6c4d60ee9b 100644
--- a/lib/diameter/src/base/diameter_capx.erl
+++ b/lib/diameter/src/base/diameter_capx.erl
@@ -54,7 +54,6 @@
 
 -include_lib("diameter/include/diameter.hrl").
 -include("diameter_internal.hrl").
--include("diameter_types.hrl").
 -include("diameter_gen_base_rfc3588.hrl").
 
 -define(SUCCESS,    2001).  %% DIAMETER_SUCCESS
@@ -75,13 +74,17 @@ build_CER(Caps) ->
     try_it([fun bCER/1, Caps]).
 
 -spec recv_CER(#diameter_base_CER{}, #diameter_service{})
-   -> tried({['Unsigned32'()], #diameter_caps{}, #diameter_base_CEA{}}).
+   -> tried({[diameter:'Unsigned32'()],
+             #diameter_caps{},
+             #diameter_base_CEA{}}).
 
 recv_CER(CER, Svc) ->
     try_it([fun rCER/2, CER, Svc]).
 
 -spec recv_CEA(#diameter_base_CEA{}, #diameter_service{})
-   -> tried({['Unsigned32'()], ['Unsigned32'()], #diameter_caps{}}).
+   -> tried({[diameter:'Unsigned32'()],
+             [diameter:'Unsigned32'()],
+             #diameter_caps{}}).
 
 recv_CEA(CEA, Svc) ->
     try_it([fun rCEA/2, CEA, Svc]).
diff --git a/lib/diameter/src/base/diameter_peer_fsm.erl b/lib/diameter/src/base/diameter_peer_fsm.erl
index fae5d763dc..99644814d2 100644
--- a/lib/diameter/src/base/diameter_peer_fsm.erl
+++ b/lib/diameter/src/base/diameter_peer_fsm.erl
@@ -46,7 +46,6 @@
 
 -include_lib("diameter/include/diameter.hrl").
 -include("diameter_internal.hrl").
--include("diameter_types.hrl").
 -include("diameter_gen_base_rfc3588.hrl").
 
 -define(GOAWAY, ?'DIAMETER_BASE_DISCONNECT-CAUSE_DO_NOT_WANT_TO_TALK_TO_YOU').
@@ -78,7 +77,8 @@
          parent       :: pid(),
          transport    :: pid(),
          service      :: #diameter_service{},
-         dpr = false  :: false | {'Unsigned32'(), 'Unsigned32'()}}).
+         dpr = false  :: false | {diameter:'Unsigned32'(),
+                                  diameter:'Unsigned32'()}}).
                             %% | hop by hop and end to end identifiers
 
 %% There are non-3588 states possible as a consequence of 5.6.1 of the
diff --git a/lib/diameter/src/base/diameter_service.erl b/lib/diameter/src/base/diameter_service.erl
index 8b9314ad1c..b36160148b 100644
--- a/lib/diameter/src/base/diameter_service.erl
+++ b/lib/diameter/src/base/diameter_service.erl
@@ -64,7 +64,6 @@
 
 -include_lib("diameter/include/diameter.hrl").
 -include("diameter_internal.hrl").
--include("diameter_types.hrl").
 
 -define(STATE_UP,   up).
 -define(STATE_DOWN, down).
@@ -117,7 +116,7 @@
         {pid  :: match(pid()),
          type :: match(connect | accept),
          ref  :: match(reference()),  %% key into diameter_config
-         options :: match([transport_opt()]), %% as passed to start_transport
+         options :: match([diameter:transport_opt()]),%% from start_transport
          op_state = ?STATE_DOWN :: match(?STATE_DOWN | ?STATE_UP),
          started = now(),      %% at process start
          conn = false :: match(boolean() | pid())}).
@@ -126,7 +125,7 @@
 %% Record representing a peer_fsm process.
 -record(conn,
         {pid   :: pid(),
-         apps  :: [{0..16#FFFFFFFF, app_alias()}], %% {Id, Alias}
+         apps  :: [{0..16#FFFFFFFF, diameter:app_alias()}], %% {Id, Alias}
          caps  :: #diameter_caps{},
          started = now(),  %% at process start
          peer  :: pid()}). %% key into peerT
@@ -137,16 +136,16 @@
          handler    :: match(pid()), %% request process
          transport  :: match(pid()), %% peer process
          caps       :: match(#diameter_caps{}),
-         app        :: match(app_alias()),  %% #diameter_app.alias
+         app        :: match(diameter:app_alias()),  %% #diameter_app.alias
          dictionary :: match(module()),     %% #diameter_app.dictionary
-         module     :: match(nonempty_improper_list(module(), list())),
+         module     :: match([module() | list()]),
                     %% #diameter_app.module
-         filter     :: match(peer_filter()),
+         filter     :: match(diameter:peer_filter()),
          packet     :: match(#diameter_packet{})}).
 
 %% Record call/4 options are parsed into.
 -record(options,
-        {filter = none  :: peer_filter(),
+        {filter = none  :: diameter:peer_filter(),
          extra = []     :: list(),
          timeout = ?DEFAULT_TIMEOUT :: 0..16#FFFFFFFF,
          detach = false :: boolean()}).
diff --git a/lib/diameter/src/base/diameter_session.erl b/lib/diameter/src/base/diameter_session.erl
index bb91e97f39..4c468f207c 100644
--- a/lib/diameter/src/base/diameter_session.erl
+++ b/lib/diameter/src/base/diameter_session.erl
@@ -26,8 +26,6 @@
 %% towards diameter_sup
 -export([init/0]).
 
--include("diameter_types.hrl").
-
 -define(INT64, 16#FFFFFFFFFFFFFFFF).
 -define(INT32, 16#FFFFFFFF).
 
@@ -73,7 +71,7 @@
 %%       consumed (see Section 6.2) SHOULD be silently discarded.
 
 -spec sequence()
-   -> 'Unsigned32'().
+   -> diameter:'Unsigned32'().
 
 sequence() ->
     Instr = {_Pos = 2, _Incr = 1, _Threshold = ?INT32, _SetVal = 0},
@@ -97,7 +95,7 @@ sequence() ->
 %%    counter retained in non-volatile memory across restarts.
 
 -spec origin_state_id()
-   -> 'Unsigned32'().
+   -> diameter:'Unsigned32'().
 
 origin_state_id() ->
     ets:lookup_element(diameter_sequence, origin_state_id, 2).
@@ -130,8 +128,8 @@ origin_state_id() ->
 %%    <optional value> is implementation specific but may include a modem's
 %%    device Id, a layer 2 address, timestamp, etc.
 
--spec session_id('DiameterIdentity'())
-   -> 'OctetString'().
+-spec session_id(diameter:'DiameterIdentity'())
+   -> diameter:'OctetString'().
 %% Note that Session-Id has type UTF8String and that any OctetString
 %% is a UTF8String.
 
diff --git a/lib/diameter/src/base/diameter_types.hrl b/lib/diameter/src/base/diameter_types.hrl
deleted file mode 100644
index 02bf8a74dd..0000000000
--- a/lib/diameter/src/base/diameter_types.hrl
+++ /dev/null
@@ -1,139 +0,0 @@
-%%
-%% %CopyrightBegin%
-%%
-%% Copyright Ericsson AB 2010-2011. 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%
-%%
-
-%%
-%% Types for function specifications, primarily in diameter.erl. This
-%% has nothing specifically to do with diameter_types.erl.
-%%
-
--type evaluable()
-   :: {module(), atom(), list()}
-    | fun()
-    | nonempty_improper_list(evaluable(), list()).   %% [evaluable() | Args]
-
--type app_alias()
-   :: any().
-
--type service_name()
-   :: any().
-
-%% Diameter basic types
-
--type 'OctetString'() :: iolist().
--type 'Integer32'()   :: -2147483647..2147483647.
--type 'Integer64'()   :: -9223372036854775807..9223372036854775807.
--type 'Unsigned32'()  :: 0..4294967295.
--type 'Unsigned64'()  :: 0..18446744073709551615.
--type 'Float32'()     :: '-infinity' | float() | infinity.
--type 'Float64'()     :: '-infinity' | float() | infinity.
--type 'Grouped'()     :: list() | tuple().
-
-%% Diameter derived types
-
--type 'Address'()
-   :: inet:ip_address()
-    | string().
-
--type 'Time'()             :: {{integer(), 1..12, 1..31},
-                               {0..23, 0..59, 0..59}}.
--type 'UTF8String'()       :: iolist().
--type 'DiameterIdentity'() :: 'OctetString'().
--type 'DiameterURI'()      :: 'OctetString'().
--type 'Enumerated'()       :: 'Integer32'().
--type 'IPFilterRule'()     :: 'OctetString'().
--type 'QoSFilterRule'()    :: 'OctetString'().
-
-%% Capabilities options/avps on start_service/2 and/or add_transport/2
-
--type capability()
-   :: {'Origin-Host',                    'DiameterIdentity'()}
-    | {'Origin-Realm',                   'DiameterIdentity'()}
-    | {'Host-IP-Address',                ['Address'()]}
-    | {'Vendor-Id',                      'Unsigned32'()}
-    | {'Product-Name',                   'UTF8String'()}
-    | {'Supported-Vendor-Id',            ['Unsigned32'()]}
-    | {'Auth-Application-Id',            ['Unsigned32'()]}
-    | {'Vendor-Specific-Application-Id', ['Grouped'()]}
-    | {'Firmware-Revision',              'Unsigned32'()}.
-
-%% Filters for call/4
-
--type peer_filter()
-   :: none
-    | host
-    | realm
-    | {host,  any|'DiameterIdentity'()}
-    | {realm, any|'DiameterIdentity'()}
-    | {eval, evaluable()}
-    | {neg, peer_filter()}
-    | {all, [peer_filter()]}
-    | {any, [peer_filter()]}.
-
-%% Options passed to start_service/2
-
--type service_opt()
-   :: capability()
-    | {application, [application_opt()]}.
-
--type application_opt()
-   :: {alias, app_alias()}
-    | {dictionary, module()}
-    | {module, app_module()}
-    | {state, any()}
-    | {call_mutates_state, boolean()}
-    | {answer_errors, callback|report|discard}.
-
--type app_module()
-   :: module()
-    | nonempty_improper_list(module(), list()).  %% list with module() head
-
-%% Identifier returned by add_transport/2
-
--type transport_ref()
-   :: reference().
-
-%% Options passed to add_transport/2
-
--type transport_opt()
-   :: {transport_module, atom()}
-    | {transport_config, any()}
-    | {applications, [app_alias()]}
-    | {capabilities, [capability()]}
-    | {watchdog_timer, 'Unsigned32'() | {module(), atom(), list()}}
-    | {reconnect_timer, 'Unsigned32'()}
-    | {private, any()}.
-
-%% Predicate passed to remove_transport/2
-
--type transport_pred()
-   :: fun((reference(), connect|listen, list()) -> boolean())
-    | fun((reference(), list()) -> boolean())
-    | fun((list()) -> boolean())
-    | reference()
-    | list()
-    | {connect|listen, transport_pred()}
-    | {atom(), atom(), list()}.
-
-%% Options passed to call/4
-
--type call_opt()
-   :: {extra, list()}
-    | {filter, peer_filter()}
-    | {timeout, 'Unsigned32'()}
-    | detach.
diff --git a/lib/diameter/src/modules.mk b/lib/diameter/src/modules.mk
index b86a32a4f7..d3125a7b57 100644
--- a/lib/diameter/src/modules.mk
+++ b/lib/diameter/src/modules.mk
@@ -78,7 +78,6 @@ EXTERNAL_HRLS = \
 # Released hrl files intended for private use.
 INTERNAL_HRLS = \
 	base/diameter_internal.hrl \
-	base/diameter_types.hrl \
 	compiler/diameter_forms.hrl \
 	compiler/diameter_vsn.hrl