summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAlexandru Scvortov <alexandru@rabbitmq.com>2010-07-01 16:48:32 +0100
committerAlexandru Scvortov <alexandru@rabbitmq.com>2010-07-01 16:48:32 +0100
commit68bd4feb290065793f179e4c66bda898f2f95acb (patch)
tree57268b2a6499b8ecc259b9f0594239a63ee8c8fd /src
parent2680d3dc56845b4fa6a6c72a06f324f119827586 (diff)
downloadrabbitmq-server-git-68bd4feb290065793f179e4c66bda898f2f95acb.tar.gz
partially moved types out of rabbit.hrl
Diffstat (limited to 'src')
-rw-r--r--src/rabbit.erl69
-rw-r--r--src/rabbit_access_control.erl30
-rw-r--r--src/rabbit_amqqueue.erl54
-rw-r--r--src/rabbit_basic.erl37
-rw-r--r--src/rabbit_binary_generator.erl15
-rw-r--r--src/rabbit_binary_parser.erl11
-rw-r--r--src/rabbit_channel.erl23
-rw-r--r--src/rabbit_control.erl2
-rw-r--r--src/rabbit_exchange.erl68
-rw-r--r--src/rabbit_exchange_type_headers.erl3
-rw-r--r--src/rabbit_guid.erl4
-rw-r--r--src/rabbit_invariable_queue.erl4
-rw-r--r--src/rabbit_misc.erl49
-rw-r--r--src/rabbit_mnesia.erl9
-rw-r--r--src/rabbit_net.erl2
-rw-r--r--src/rabbit_networking.erl22
-rw-r--r--src/rabbit_persister.erl16
-rw-r--r--src/rabbit_reader.erl8
-rw-r--r--src/rabbit_reader_queue_collector.erl2
-rw-r--r--src/rabbit_router.erl5
-rw-r--r--src/rabbit_writer.erl28
21 files changed, 307 insertions, 154 deletions
diff --git a/src/rabbit.erl b/src/rabbit.erl
index 7ae0b160bc..9d826760f9 100644
--- a/src/rabbit.erl
+++ b/src/rabbit.erl
@@ -39,6 +39,12 @@
-export([log_location/1]).
+-export_type([regexp/0, vhost/0, txn/0, resource_name/0, thunk/1,
+ maybe/1,
+ msg_id/0, ctag/0, erlang_node/0, message/0, basic_message/0,
+ delivery/0, content/0, decoded_content/0, encoded_content/0,
+ unencoded_content/0]).
+
%%---------------------------------------------------------------------------
%% Boot steps.
-export([maybe_insert_default_data/0]).
@@ -183,6 +189,67 @@
-ifdef(use_specs).
+-include("rabbit_framing_spec.hrl").
+
+-type(maybe(T) :: T | 'none').
+-type(erlang_node() :: atom()).
+-type(thunk(T) :: fun(() -> T)).
+-type(regexp() :: binary()).
+
+%% TODO: make this more precise by tying specific class_ids to
+%% specific properties
+-type(undecoded_content() ::
+ #content{class_id :: rabbit_framing:amqp_class_id(),
+ properties :: 'none',
+ properties_bin :: binary(),
+ payload_fragments_rev :: [binary()]} |
+ #content{class_id :: rabbit_framing:amqp_class_id(),
+ properties :: amqp_properties(),
+ properties_bin :: 'none',
+ payload_fragments_rev :: [binary()]}).
+-type(unencoded_content() :: undecoded_content()).
+-type(decoded_content() ::
+ #content{class_id :: rabbit_framing:amqp_class_id(),
+ properties :: amqp_properties(),
+ properties_bin :: rabbit:maybe(binary()),
+ payload_fragments_rev :: [binary()]}).
+-type(encoded_content() ::
+ #content{class_id :: rabbit_framing:amqp_class_id(),
+ properties :: rabbit:maybe(amqp_properties()),
+ properties_bin :: binary(),
+ payload_fragments_rev :: [binary()]}).
+-type(content() :: undecoded_content() | decoded_content()).
+-type(basic_message() ::
+ #basic_message{exchange_name :: rabbit_exchange:name(),
+ routing_key :: rabbit_router:routing_key(),
+ content :: content(),
+ guid :: rabbit_guid:guid(),
+ is_persistent :: boolean()}).
+-type(message() :: basic_message()).
+-type(delivery() ::
+ #delivery{mandatory :: boolean(),
+ immediate :: boolean(),
+ txn :: rabbit:maybe(rabbit:txn()),
+ sender :: pid(),
+ message :: message()}).
+
+%% this is really an abstract type, but dialyzer does not support them
+-type(txn() :: rabbit_guid:guid()).
+-type(permission() ::
+ #permission{configure :: regexp(),
+ write :: regexp(),
+ read :: regexp()}).
+-type(binding() ::
+ #binding{exchange_name :: rabbit_exchange:name(),
+ queue_name :: rabbit_amqqueue:name(),
+ key :: binding_key()}).
+%% this really should be an abstract type
+-type(msg_id() :: non_neg_integer()).
+-type(listener() ::
+ #listener{node :: erlang_node(),
+ protocol :: atom(),
+ host :: inet:hostname(),
+ port :: inet:ip_port()}).
-type(log_location() :: 'tty' | 'undefined' | file:filename()).
-type(file_suffix() :: binary()).
@@ -193,7 +260,7 @@
-spec(rotate_logs/1 :: (file_suffix()) -> 'ok' | {'error', any()}).
-spec(status/0 :: () ->
[{running_applications, [{atom(), string(), string()}]} |
- {nodes, [{node_type(), [erlang_node()]}]} |
+ {nodes, [{rabbit_mnesia:node_type(), [erlang_node()]}]} |
{running_nodes, [erlang_node()]}]).
-spec(log_location/1 :: ('sasl' | 'kernel') -> log_location()).
diff --git a/src/rabbit_access_control.erl b/src/rabbit_access_control.erl
index a445f44197..1658b5c57c 100644
--- a/src/rabbit_access_control.erl
+++ b/src/rabbit_access_control.erl
@@ -46,27 +46,37 @@
-ifdef(use_specs).
-type(permission_atom() :: 'configure' | 'read' | 'write').
+-type(username() :: binary()).
+-type(password() :: binary()).
+-type(user() ::
+ #user{username :: username(),
+ password :: password()}).
-spec(check_login/2 :: (binary(), binary()) -> user()).
-spec(user_pass_login/2 :: (username(), password()) -> user()).
--spec(check_vhost_access/2 :: (user(), vhost()) -> 'ok').
+-spec(check_vhost_access/2 :: (user(), rabbit:vhost()) -> 'ok').
-spec(check_resource_access/3 ::
- (username(), r(atom()), permission_atom()) -> 'ok').
+ (username(), rabbit:r(atom()), permission_atom()) -> 'ok').
-spec(add_user/2 :: (username(), password()) -> 'ok').
-spec(delete_user/1 :: (username()) -> 'ok').
-spec(change_password/2 :: (username(), password()) -> 'ok').
-spec(list_users/0 :: () -> [username()]).
--spec(lookup_user/1 :: (username()) -> {'ok', user()} | not_found()).
--spec(add_vhost/1 :: (vhost()) -> 'ok').
--spec(delete_vhost/1 :: (vhost()) -> 'ok').
--spec(list_vhosts/0 :: () -> [vhost()]).
+-spec(lookup_user/1 :: (username()) ->
+ {'ok', user()} | rabbit:not_found()).
+-spec(add_vhost/1 :: (rabbit:vhost()) -> 'ok').
+-spec(delete_vhost/1 :: (rabbit:vhost()) -> 'ok').
+-spec(list_vhosts/0 :: () -> [rabbit:vhost()]).
-spec(set_permissions/5 ::
- (username(), vhost(), regexp(), regexp(), regexp()) -> 'ok').
--spec(clear_permissions/2 :: (username(), vhost()) -> 'ok').
+ (username(), rabbit:vhost(), rabbit:regexp(),
+ rabbit:regexp(), rabbit:regexp()
+ ) -> 'ok').
+-spec(clear_permissions/2 :: (username(), rabbit:vhost()) -> 'ok').
-spec(list_vhost_permissions/1 ::
- (vhost()) -> [{username(), regexp(), regexp(), regexp()}]).
+ (rabbit:vhost()) -> [{username(), rabbit:regexp(),
+ rabbit:regexp(), rabbit:regexp()}]).
-spec(list_user_permissions/1 ::
- (username()) -> [{vhost(), regexp(), regexp(), regexp()}]).
+ (username()) -> [{rabbit:vhost(), rabbit:regexp(),
+ rabbit:regexp(), rabbit:regexp()}]).
-endif.
diff --git a/src/rabbit_amqqueue.erl b/src/rabbit_amqqueue.erl
index f0e536b5ee..eef3a39b9d 100644
--- a/src/rabbit_amqqueue.erl
+++ b/src/rabbit_amqqueue.erl
@@ -58,27 +58,41 @@
-ifdef(use_specs).
--type(qstats() :: {'ok', queue_name(), non_neg_integer(), non_neg_integer()}).
+
+-type(info_key() :: atom()).
+-type(info() :: {info_key(), any()}).
+
+-type(name() :: rabbit:r('queue')).
+-type(amqqueue() ::
+ #amqqueue{name :: name(),
+ durable :: boolean(),
+ auto_delete :: boolean(),
+ exclusive_owner :: rabbit:maybe(pid()),
+ arguments :: rabbit_framing:amqp_table(),
+ pid :: rabbit:maybe(pid())}).
+
+-type(qstats() :: {'ok', name(), non_neg_integer(), non_neg_integer()}).
-type(qlen() :: {'ok', non_neg_integer()}).
-type(qfun(A) :: fun ((amqqueue()) -> A)).
+-type(qmsg() :: {name(), pid(), rabbit:msg_id(), boolean(), rabbit:message()}).
-type(ok_or_errors() ::
'ok' | {'error', [{'error' | 'exit' | 'throw', any()}]}).
-spec(start/0 :: () -> 'ok').
--spec(declare/5 :: (queue_name(), boolean(), boolean(), amqp_table(),
- maybe(pid())) -> {'new' | 'existing', amqqueue()}).
--spec(lookup/1 :: (queue_name()) -> {'ok', amqqueue()} | not_found()).
--spec(with/2 :: (queue_name(), qfun(A)) -> A | not_found()).
--spec(with_or_die/2 :: (queue_name(), qfun(A)) -> A).
--spec(list/1 :: (vhost()) -> [amqqueue()]).
+-spec(declare/5 :: (name(), boolean(), boolean(), rabbit_framing:amqp_table(),
+ rabbit:maybe(pid())) -> {'new' | 'existing', amqqueue()}).
+-spec(lookup/1 :: (name()) -> {'ok', amqqueue()} | rabbit:not_found()).
+-spec(with/2 :: (name(), qfun(A)) -> A | rabbit:not_found()).
+-spec(with_or_die/2 :: (name(), qfun(A)) -> A).
+-spec(list/1 :: (rabbit:vhost()) -> [amqqueue()]).
-spec(info_keys/0 :: () -> [info_key()]).
-spec(info/1 :: (amqqueue()) -> [info()]).
-spec(info/2 :: (amqqueue(), [info_key()]) -> [info()]).
--spec(info_all/1 :: (vhost()) -> [[info()]]).
--spec(info_all/2 :: (vhost(), [info_key()]) -> [[info()]]).
--spec(consumers/1 :: (amqqueue()) -> [{pid(), ctag(), boolean()}]).
+-spec(info_all/1 :: (rabbit:vhost()) -> [[info()]]).
+-spec(info_all/2 :: (rabbit:vhost(), [info_key()]) -> [[info()]]).
+-spec(consumers/1 :: (amqqueue()) -> [{pid(), rabbit:ctag(), boolean()}]).
-spec(consumers_all/1 ::
- (vhost()) -> [{queue_name(), pid(), ctag(), boolean()}]).
+ (rabbit:vhost()) -> [{name(), pid(), rabbit:ctag(), boolean()}]).
-spec(stat/1 :: (amqqueue()) -> qstats()).
-spec(stat_all/0 :: () -> [qstats()]).
-spec(delete/3 ::
@@ -89,30 +103,30 @@
{'error', 'in_use'} |
{'error', 'not_empty'}).
-spec(purge/1 :: (amqqueue()) -> qlen()).
--spec(deliver/2 :: (pid(), delivery()) -> boolean()).
--spec(requeue/3 :: (pid(), [msg_id()], pid()) -> 'ok').
--spec(ack/4 :: (pid(), maybe(txn()), [msg_id()], pid()) -> 'ok').
--spec(commit_all/3 :: ([pid()], txn(), pid()) -> ok_or_errors()).
--spec(rollback_all/3 :: ([pid()], txn(), pid()) -> 'ok').
+-spec(deliver/2 :: (pid(), rabbit:delivery()) -> boolean()).
+-spec(requeue/3 :: (pid(), [rabbit:msg_id()], pid()) -> 'ok').
+-spec(ack/4 :: (pid(), rabbit:maybe(rabbit:txn()), [rabbit:msg_id()], pid()) -> 'ok').
+-spec(commit_all/3 :: ([pid()], rabbit:txn(), pid()) -> ok_or_errors()).
+-spec(rollback_all/3 :: ([pid()], rabbit:txn(), pid()) -> 'ok').
-spec(notify_down_all/2 :: ([pid()], pid()) -> ok_or_errors()).
-spec(limit_all/3 :: ([pid()], pid(), pid() | 'undefined') -> ok_or_errors()).
-spec(basic_get/3 :: (amqqueue(), pid(), boolean()) ->
{'ok', non_neg_integer(), qmsg()} | 'empty').
-spec(basic_consume/7 ::
- (amqqueue(), boolean(), pid(), pid() | 'undefined', ctag(),
+ (amqqueue(), boolean(), pid(), pid() | 'undefined', rabbit:ctag(),
boolean(), any()) ->
'ok' | {'error', 'exclusive_consume_unavailable'}).
--spec(basic_cancel/4 :: (amqqueue(), pid(), ctag(), any()) -> 'ok').
+-spec(basic_cancel/4 :: (amqqueue(), pid(), rabbit:ctag(), any()) -> 'ok').
-spec(notify_sent/2 :: (pid(), pid()) -> 'ok').
-spec(unblock/2 :: (pid(), pid()) -> 'ok').
-spec(flush_all/2 :: ([pid()], pid()) -> 'ok').
-spec(internal_declare/2 :: (amqqueue(), boolean()) -> amqqueue() | 'not_found').
--spec(internal_delete/1 :: (queue_name()) -> 'ok' | not_found()).
+-spec(internal_delete/1 :: (name()) -> 'ok' | rabbit:not_found()).
-spec(maybe_run_queue_via_backing_queue/2 :: (pid(), (fun ((A) -> A))) -> 'ok').
-spec(update_ram_duration/1 :: (pid()) -> 'ok').
-spec(set_ram_duration_target/2 :: (pid(), number() | 'infinity') -> 'ok').
-spec(set_maximum_since_use/2 :: (pid(), non_neg_integer()) -> 'ok').
--spec(on_node_down/1 :: (erlang_node()) -> 'ok').
+-spec(on_node_down/1 :: (rabbit:erlang_node()) -> 'ok').
-spec(pseudo_queue/2 :: (binary(), pid()) -> amqqueue()).
-endif.
diff --git a/src/rabbit_basic.erl b/src/rabbit_basic.erl
index 4ab7a2a0b1..cec392cf48 100644
--- a/src/rabbit_basic.erl
+++ b/src/rabbit_basic.erl
@@ -42,24 +42,27 @@
-ifdef(use_specs).
--type(properties_input() :: (amqp_properties() | [{atom(), any()}])).
--type(publish_result() :: ({ok, routing_result(), [pid()]} | not_found())).
-
--spec(publish/1 :: (delivery()) -> publish_result()).
--spec(delivery/4 :: (boolean(), boolean(), maybe(txn()), message()) ->
- delivery()).
--spec(message/4 :: (exchange_name(), routing_key(), properties_input(),
- binary()) -> (message() | {'error', any()})).
--spec(properties/1 :: (properties_input()) -> amqp_properties()).
--spec(publish/4 :: (exchange_name(), routing_key(), properties_input(),
- binary()) -> publish_result()).
--spec(publish/7 :: (exchange_name(), routing_key(), boolean(), boolean(),
- maybe(txn()), properties_input(), binary()) ->
- publish_result()).
--spec(build_content/2 :: (amqp_properties(), binary()) -> content()).
--spec(from_content/1 :: (content()) -> {amqp_properties(), binary()}).
+-type(properties_input() :: (rabbit:amqp_properties() | [{atom(), any()}])).
+-type(publish_result() :: ({ok, rabbit_router:routing_result(), [pid()]}
+ | rabbit:not_found())).
+
+-spec(publish/1 :: (rabbit:delivery()) -> publish_result()).
+-spec(delivery/4 :: (boolean(), boolean(), rabbit:maybe(rabbit:txn()),
+ rabbit:message()) -> rabbit:delivery()).
+-spec(message/4 :: (rabbit:exchange_name(), rabbit_router:routing_key(),
+ properties_input(), binary())
+ -> (rabbit:message() | {'error', any()})).
+-spec(properties/1 :: (properties_input()) -> rabbit:amqp_properties()).
+-spec(publish/4 :: (rabbit:exchange_name(), rabbit_router:routing_key(),
+ properties_input(), binary()) -> publish_result()).
+-spec(publish/7 :: (rabbit:exchange_name(), rabbit_router:routing_key(), boolean(), boolean(),
+ rabbit:maybe(rabbit:txn()), properties_input(), binary()) ->
+ publish_result()).
+-spec(build_content/2 :: (rabbit_framing:amqp_properties(), binary())
+ -> rabbit:content()).
+-spec(from_content/1 :: (rabbit:content()) -> {rabbit_framing:amqp_properties(), binary()}).
-spec(is_message_persistent/1 ::
- (decoded_content()) -> (boolean() | {'invalid', non_neg_integer()})).
+ (rabbit:decoded_content()) -> (boolean() | {'invalid', non_neg_integer()})).
-endif.
diff --git a/src/rabbit_binary_generator.erl b/src/rabbit_binary_generator.erl
index 81cf3ceec7..655dfe5c65 100644
--- a/src/rabbit_binary_generator.erl
+++ b/src/rabbit_binary_generator.erl
@@ -57,15 +57,18 @@
-type(frame() :: [binary()]).
-spec(build_simple_method_frame/2 ::
- (channel_number(), amqp_method_record()) -> frame()).
+ (rabbit_channel:channel_number(), rabbit_framing:amqp_method_record())
+ -> frame()).
-spec(build_simple_content_frames/3 ::
- (channel_number(), content(), non_neg_integer()) -> [frame()]).
+ (rabbit_channel:channel_number(), rabbit:content(), non_neg_integer())
+ -> [frame()]).
-spec(build_heartbeat_frame/0 :: () -> frame()).
--spec(generate_table/1 :: (amqp_table()) -> binary()).
--spec(encode_properties/2 :: ([amqp_property_type()], [any()]) -> binary()).
+-spec(generate_table/1 :: (rabbit:amqp_table()) -> binary()).
+-spec(encode_properties/2 :: ([rabbit_framing:amqp_property_type()], [any()])
+ -> binary()).
-spec(check_empty_content_body_frame_size/0 :: () -> 'ok').
--spec(ensure_content_encoded/1 :: (content()) -> encoded_content()).
--spec(clear_encoded_content/1 :: (content()) -> unencoded_content()).
+-spec(ensure_content_encoded/1 :: (rabbit:content()) -> rabbit:encoded_content()).
+-spec(clear_encoded_content/1 :: (rabbit:content()) -> rabbit:unencoded_content()).
-endif.
diff --git a/src/rabbit_binary_parser.erl b/src/rabbit_binary_parser.erl
index e022a1fafe..a8879bea41 100644
--- a/src/rabbit_binary_parser.erl
+++ b/src/rabbit_binary_parser.erl
@@ -42,10 +42,13 @@
-ifdef(use_specs).
--spec(parse_table/1 :: (binary()) -> amqp_table()).
--spec(parse_properties/2 :: ([amqp_property_type()], binary()) -> [any()]).
--spec(ensure_content_decoded/1 :: (content()) -> decoded_content()).
--spec(clear_decoded_content/1 :: (content()) -> undecoded_content()).
+-spec(parse_table/1 :: (binary()) -> rabbit_framing:amqp_table()).
+-spec(parse_properties/2 ::
+ ([rabbit_framing:amqp_property_type()], binary()) -> [any()]).
+-spec(ensure_content_decoded/1 ::
+ (rabbit:content()) -> rabbit:decoded_content()).
+-spec(clear_decoded_content/1 ::
+ (rabbit:content()) -> rabbit:undecoded_content()).
-endif.
diff --git a/src/rabbit_channel.erl b/src/rabbit_channel.erl
index 179a9a9de6..93970fe97d 100644
--- a/src/rabbit_channel.erl
+++ b/src/rabbit_channel.erl
@@ -72,23 +72,26 @@
-ifdef(use_specs).
-type(ref() :: any()).
+-type(channel_number() :: non_neg_integer()).
-spec(start_link/6 ::
- (channel_number(), pid(), pid(), username(), vhost(), pid()) -> pid()).
--spec(do/2 :: (pid(), amqp_method_record()) -> 'ok').
--spec(do/3 :: (pid(), amqp_method_record(), maybe(content())) -> 'ok').
+ (channel_number(), pid(), pid(), rabbit_access_control:username(),
+ rabbit:vhost(), pid()) -> pid()).
+-spec(do/2 :: (pid(), rabbit_framing:amqp_method_record()) -> 'ok').
+-spec(do/3 :: (pid(), rabbit_framing:amqp_method_record(),
+ rabbit:maybe(rabbit:content())) -> 'ok').
-spec(shutdown/1 :: (pid()) -> 'ok').
--spec(send_command/2 :: (pid(), amqp_method()) -> 'ok').
--spec(deliver/4 :: (pid(), ctag(), boolean(), qmsg()) -> 'ok').
+-spec(send_command/2 :: (pid(), rabbit_framing:amqp_method()) -> 'ok').
+-spec(deliver/4 :: (pid(), rabbit:ctag(), boolean(), rabbit_queue:qmsg()) -> 'ok').
-spec(conserve_memory/2 :: (pid(), boolean()) -> 'ok').
-spec(flushed/2 :: (pid(), pid()) -> 'ok').
-spec(flow_timeout/2 :: (pid(), ref()) -> 'ok').
-spec(list/0 :: () -> [pid()]).
--spec(info_keys/0 :: () -> [info_key()]).
--spec(info/1 :: (pid()) -> [info()]).
--spec(info/2 :: (pid(), [info_key()]) -> [info()]).
--spec(info_all/0 :: () -> [[info()]]).
--spec(info_all/1 :: ([info_key()]) -> [[info()]]).
+-spec(info_keys/0 :: () -> [rabbit:info_key()]).
+-spec(info/1 :: (pid()) -> [rabbit:info()]).
+-spec(info/2 :: (pid(), [rabbit:info_key()]) -> [rabbit:info()]).
+-spec(info_all/0 :: () -> [[rabbit:info()]]).
+-spec(info_all/1 :: ([rabbit:info_key()]) -> [[rabbit:info()]]).
-endif.
diff --git a/src/rabbit_control.erl b/src/rabbit_control.erl
index 323d4d2fd1..4aab0dceca 100644
--- a/src/rabbit_control.erl
+++ b/src/rabbit_control.erl
@@ -44,7 +44,7 @@
-spec(start/0 :: () -> no_return()).
-spec(stop/0 :: () -> 'ok').
--spec(action/4 :: (atom(), erlang_node(), [string()],
+-spec(action/4 :: (atom(), rabbit:erlang_node(), [string()],
fun ((string(), [any()]) -> 'ok')) -> 'ok').
-spec(usage/0 :: () -> no_return()).
diff --git a/src/rabbit_exchange.erl b/src/rabbit_exchange.erl
index d77bf833ea..5a721982c9 100644
--- a/src/rabbit_exchange.erl
+++ b/src/rabbit_exchange.erl
@@ -43,6 +43,8 @@
-export([assert_args_equivalence/2]).
-export([check_type/1]).
+-export_type([name/0]).
+
%% EXTENDED API
-export([list_exchange_bindings/1]).
-export([list_queue_bindings/1]).
@@ -56,6 +58,15 @@
-ifdef(use_specs).
+-type(name() :: rabbit:r('exchange')).
+-type(exchange() ::
+ #exchange{name :: name(),
+ type :: type(),
+ durable :: boolean(),
+ auto_delete :: boolean(),
+ arguments :: rabbit_framing:amqp_table()}).
+-type(type() :: atom()).
+
-type(bind_res() :: 'ok' | {'error',
'queue_not_found' |
'exchange_not_found' |
@@ -63,38 +74,37 @@
-type(inner_fun() :: fun((exchange(), queue()) -> any())).
-spec(recover/0 :: () -> 'ok').
--spec(declare/5 :: (exchange_name(), exchange_type(), boolean(), boolean(),
- amqp_table()) -> exchange()).
+-spec(declare/5 :: (name(), type(), boolean(), boolean(),
+ rabbit_framing:amqp_table()) -> exchange()).
-spec(check_type/1 :: (binary()) -> atom()).
-spec(assert_equivalence/5 :: (exchange(), atom(), boolean(), boolean(),
- amqp_table()) -> 'ok').
--spec(assert_args_equivalence/2 :: (exchange(), amqp_table()) -> 'ok').
--spec(lookup/1 :: (exchange_name()) -> {'ok', exchange()} | not_found()).
--spec(lookup_or_die/1 :: (exchange_name()) -> exchange()).
--spec(list/1 :: (vhost()) -> [exchange()]).
--spec(info_keys/0 :: () -> [info_key()]).
--spec(info/1 :: (exchange()) -> [info()]).
--spec(info/2 :: (exchange(), [info_key()]) -> [info()]).
--spec(info_all/1 :: (vhost()) -> [[info()]]).
--spec(info_all/2 :: (vhost(), [info_key()]) -> [[info()]]).
--spec(publish/2 :: (exchange(), delivery()) -> {routing_result(), [pid()]}).
--spec(add_binding/5 ::
- (exchange_name(), queue_name(), routing_key(), amqp_table(), inner_fun()) ->
- bind_res()).
--spec(delete_binding/5 ::
- (exchange_name(), queue_name(), routing_key(), amqp_table(), inner_fun()) ->
- bind_res() | {'error', 'binding_not_found'}).
--spec(list_bindings/1 :: (vhost()) ->
- [{exchange_name(), queue_name(), routing_key(), amqp_table()}]).
--spec(delete_queue_bindings/1 :: (queue_name()) -> fun (() -> none())).
--spec(delete_transient_queue_bindings/1 :: (queue_name()) ->
+ rabbit_framing:amqp_table()) -> 'ok').
+-spec(assert_args_equivalence/2 :: (exchange(), rabbit_framing:amqp_table()) -> 'ok').
+-spec(lookup/1 :: (name()) -> {'ok', exchange()} | rabbit:not_found()).
+-spec(lookup_or_die/1 :: (name()) -> exchange()).
+-spec(list/1 :: (rabbit:vhost()) -> [exchange()]).
+-spec(info_keys/0 :: () -> [rabbit:info_key()]).
+-spec(info/1 :: (exchange()) -> [rabbit:info()]).
+-spec(info/2 :: (exchange(), [rabbit:info_key()]) -> [rabbit:info()]).
+-spec(info_all/1 :: (rabbit:vhost()) -> [[rabbit:info()]]).
+-spec(info_all/2 :: (rabbit:vhost(), [rabbit:info_key()]) -> [[rabbit:info()]]).
+-spec(publish/2 :: (exchange(), rabbit:delivery()) -> {rabbit_router:routing_result(), [pid()]}).
+-spec(add_binding/5 :: (name(), rabbit_amqqueue:name(), rabbit_router:routing_key(),
+ rabbit_framing:amqp_table(), inner_fun()) -> bind_res()).
+-spec(delete_binding/5 :: (name(), rabbit_amqqueue:name(), rabbit_router:routing_key(),
+ rabbit_framing:amqp_table(), inner_fun()) ->
+ bind_res() | {'error', 'binding_not_found'}).
+-spec(list_bindings/1 :: (rabbit:vhost()) ->
+ [{name(), rabbit_amqqueue:name(), rabbit_router:routing_key(), rabbit_framing:amqp_table()}]).
+-spec(delete_queue_bindings/1 :: (rabbit_amqqueue:name()) -> fun (() -> none())).
+-spec(delete_transient_queue_bindings/1 :: (rabbit_amqqueue:name()) ->
fun (() -> none())).
--spec(delete/2 :: (exchange_name(), boolean()) ->
- 'ok' | not_found() | {'error', 'in_use'}).
--spec(list_queue_bindings/1 :: (queue_name()) ->
- [{exchange_name(), routing_key(), amqp_table()}]).
--spec(list_exchange_bindings/1 :: (exchange_name()) ->
- [{queue_name(), routing_key(), amqp_table()}]).
+-spec(delete/2 :: (name(), boolean()) ->
+ 'ok' | rabbit:not_found() | {'error', 'in_use'}).
+-spec(list_queue_bindings/1 :: (rabbit_amqqueue:name()) ->
+ [{name(), rabbit_router:routing_key(), rabbit_framing:amqp_table()}]).
+-spec(list_exchange_bindings/1 :: (name()) ->
+ [{rabbit_amqqueue:name(), rabbit_router:routing_key(), rabbit_framing:amqp_table()}]).
-endif.
diff --git a/src/rabbit_exchange_type_headers.erl b/src/rabbit_exchange_type_headers.erl
index 315e800021..c748c36402 100644
--- a/src/rabbit_exchange_type_headers.erl
+++ b/src/rabbit_exchange_type_headers.erl
@@ -48,7 +48,8 @@
{enables, kernel_ready}]}).
-ifdef(use_specs).
--spec(headers_match/2 :: (amqp_table(), amqp_table()) -> boolean()).
+-spec(headers_match/2 :: (rabbit_framing:amqp_table(),
+ rabbit_framing:amqp_table()) -> boolean()).
-endif.
description() ->
diff --git a/src/rabbit_guid.erl b/src/rabbit_guid.erl
index 1ae8f7dac4..a44e0f5840 100644
--- a/src/rabbit_guid.erl
+++ b/src/rabbit_guid.erl
@@ -41,6 +41,8 @@
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
terminate/2, code_change/3]).
+-export_type([guid/0]).
+
-define(SERVER, ?MODULE).
-define(SERIAL_FILENAME, "rabbit_serial").
@@ -50,6 +52,8 @@
-ifdef(use_specs).
+-type(guid() :: binary()).
+
-spec(start_link/0 :: () -> {'ok', pid()} | 'ignore' | {'error', any()}).
-spec(guid/0 :: () -> guid()).
-spec(string_guid/1 :: (any()) -> string()).
diff --git a/src/rabbit_invariable_queue.erl b/src/rabbit_invariable_queue.erl
index a7ca20c80b..d3f89ab96f 100644
--- a/src/rabbit_invariable_queue.erl
+++ b/src/rabbit_invariable_queue.erl
@@ -48,9 +48,9 @@
-ifdef(use_specs).
--type(ack() :: guid() | 'blank_ack').
+-type(ack() :: rabbit_guid:guid() | 'blank_ack').
-type(state() :: #iv_state { queue :: queue(),
- qname :: queue_name(),
+ qname :: rabbit_amqqueue:name(),
len :: non_neg_integer(),
pending_ack :: dict()
}).
diff --git a/src/rabbit_misc.erl b/src/rabbit_misc.erl
index 331a919318..ee83e23760 100644
--- a/src/rabbit_misc.erl
+++ b/src/rabbit_misc.erl
@@ -32,6 +32,7 @@
-module(rabbit_misc).
-include("rabbit.hrl").
-include("rabbit_framing.hrl").
+
-include_lib("kernel/include/file.hrl").
-export([method_record_type/1, polite_pause/0, polite_pause/1]).
@@ -72,13 +73,22 @@
-ifdef(use_specs).
-type(ok_or_error() :: 'ok' | {'error', any()}).
+-type(amqp_error() ::
+ #amqp_error{name :: atom(),
+ explanation :: string(),
+ method :: atom()}).
+-type(not_found() :: {'error', 'not_found'}).
+-type(r(Kind) ::
+ #resource{virtual_host :: rabbit:vhost(),
+ kind :: Kind,
+ name :: rabbit:resource_name()}).
-spec(method_record_type/1 :: (tuple()) -> atom()).
-spec(polite_pause/0 :: () -> 'done').
-spec(polite_pause/1 :: (non_neg_integer()) -> 'done').
-spec(die/1 :: (atom()) -> no_return()).
-spec(frame_error/2 :: (atom(), binary()) -> no_return()).
--spec(amqp_error/4 :: (atom(), string(), [any()], atom()) -> amqp_error()).
+-spec(amqp_error/4 :: (atom(), string(), [any()], atom()) -> rabbit_misc:amqp_error()).
-spec(protocol_error/3 :: (atom(), string(), [any()]) -> no_return()).
-spec(protocol_error/4 :: (atom(), string(), [any()], atom()) -> no_return()).
-spec(not_found/1 :: (r(atom())) -> no_return()).
@@ -86,31 +96,32 @@
-spec(get_config/2 :: (atom(), A) -> A).
-spec(set_config/2 :: (atom(), any()) -> 'ok').
-spec(dirty_read/1 :: ({atom(), any()}) -> {'ok', any()} | not_found()).
--spec(r/3 :: (vhost() | r(atom()), K, resource_name()) ->
- r(K) when is_subtype(K, atom())).
--spec(r/2 :: (vhost(), K) -> #resource{virtual_host :: vhost(),
- kind :: K,
- name :: '_'}
- when is_subtype(K, atom())).
--spec(r_arg/4 :: (vhost() | r(atom()), K, amqp_table(), binary()) ->
- undefined | r(K) when is_subtype(K, atom())).
--spec(rs/1 :: (r(atom())) -> string()).
+-spec(r/3 :: (rabbit:vhost() | rabbit:r(atom()), K, rabbit:resource_name()) ->
+ rabbit:r(K) when is_subtype(K, atom())).
+-spec(r/2 :: (rabbit:vhost(), K) -> #resource{virtual_host :: rabbit:vhost(),
+ kind :: K,
+ name :: '_'}
+ when is_subtype(K, atom())).
+-spec(r_arg/4 :: (rabbit:vhost() | rabbit:r(atom()), K, rabbit_framing:amqp_table(), binary()) ->
+ undefined | rabbit:r(K) when is_subtype(K, atom())).
+-spec(rs/1 :: (rabbit:r(atom())) -> string()).
-spec(enable_cover/0 :: () -> ok_or_error()).
-spec(start_cover/1 :: ([{string(), string()} | string()]) -> 'ok').
-spec(report_cover/0 :: () -> 'ok').
-spec(enable_cover/1 :: (file:filename()) -> ok_or_error()).
-spec(report_cover/1 :: (file:filename()) -> 'ok').
-spec(throw_on_error/2 ::
- (atom(), thunk({error, any()} | {ok, A} | A)) -> A).
--spec(with_exit_handler/2 :: (thunk(A), thunk(A)) -> A).
+ (atom(), rabbit:thunk({error, any()} | {ok, A} | A)) -> A).
+-spec(with_exit_handler/2 :: (rabbit:thunk(A), rabbit:thunk(A)) -> A).
-spec(filter_exit_map/2 :: (fun ((A) -> B), [A]) -> [B]).
--spec(with_user/2 :: (username(), thunk(A)) -> A).
--spec(with_vhost/2 :: (vhost(), thunk(A)) -> A).
--spec(with_user_and_vhost/3 :: (username(), vhost(), thunk(A)) -> A).
--spec(execute_mnesia_transaction/1 :: (thunk(A)) -> A).
+-spec(with_user/2 :: (rabbit_access_control:username(), rabbit:thunk(A)) -> A).
+-spec(with_vhost/2 :: (rabbit:vhost(), rabbit:thunk(A)) -> A).
+-spec(with_user_and_vhost/3 :: (rabbit_access_control:username(),
+ rabbit:vhost(), rabbit:thunk(A)) -> A).
+-spec(execute_mnesia_transaction/1 :: (rabbit:thunk(A)) -> A).
-spec(ensure_ok/2 :: (ok_or_error(), atom()) -> 'ok').
--spec(makenode/1 :: ({string(), string()} | string()) -> erlang_node()).
--spec(nodeparts/1 :: (erlang_node() | string()) -> {string(), string()}).
+-spec(makenode/1 :: ({string(), string()} | string()) -> rabbit:erlang_node()).
+-spec(nodeparts/1 :: (rabbit:erlang_node() | string()) -> {string(), string()}).
-spec(cookie_hash/0 :: () -> string()).
-spec(tcp_name/3 :: (atom(), inet:ip_address(), inet:ip_port()) -> atom()).
-spec(intersperse/2 :: (A, [A]) -> [A]).
@@ -131,7 +142,7 @@
-spec(unfold/2 :: (fun ((A) -> ({'true', B, A} | 'false')), A) -> {[B], A}).
-spec(ceil/1 :: (number()) -> integer()).
-spec(queue_fold/3 :: (fun ((any(), B) -> B), B, queue()) -> B).
--spec(sort_field_table/1 :: (amqp_table()) -> amqp_table()).
+-spec(sort_field_table/1 :: (rabbit_framing:amqp_table()) -> rabbit_framing:amqp_table()).
-spec(pid_to_string/1 :: (pid()) -> string()).
-spec(string_to_pid/1 :: (string()) -> pid()).
-spec(version_compare/2 :: (string(), string()) -> 'lt' | 'eq' | 'gt').
diff --git a/src/rabbit_mnesia.erl b/src/rabbit_mnesia.erl
index ba3019bed2..a3cac45c77 100644
--- a/src/rabbit_mnesia.erl
+++ b/src/rabbit_mnesia.erl
@@ -42,19 +42,22 @@
%% other mnesia-using Erlang applications, such as ejabberd
-export([create_tables/0]).
+-export_type([node_type/0]).
+
-include("rabbit.hrl").
%%----------------------------------------------------------------------------
-ifdef(use_specs).
--spec(status/0 :: () -> [{'nodes', [{node_type(), [erlang_node()]}]} |
- {'running_nodes', [erlang_node()]}]).
+-type(node_type() :: disc_only | disc | ram | unknown).
+-spec(status/0 :: () -> [{'nodes', [{node_type(), [rabbit:erlang_node()]}]} |
+ {'running_nodes', [rabbit:erlang_node()]}]).
-spec(dir/0 :: () -> file:filename()).
-spec(ensure_mnesia_dir/0 :: () -> 'ok').
-spec(init/0 :: () -> 'ok').
-spec(is_db_empty/0 :: () -> boolean()).
--spec(cluster/1 :: ([erlang_node()]) -> 'ok').
+-spec(cluster/1 :: ([rabbit:erlang_node()]) -> 'ok').
-spec(reset/0 :: () -> 'ok').
-spec(force_reset/0 :: () -> 'ok').
-spec(is_clustered/0 :: () -> boolean()).
diff --git a/src/rabbit_net.erl b/src/rabbit_net.erl
index 9abd3ddb5d..b04adc22ed 100644
--- a/src/rabbit_net.erl
+++ b/src/rabbit_net.erl
@@ -43,6 +43,8 @@
'recv_cnt' | 'recv_max' | 'recv_avg' | 'recv_oct' | 'recv_dvi' |
'send_cnt' | 'send_max' | 'send_avg' | 'send_oct' | 'send_pend').
-type(error() :: {'error', any()}).
+-type(ssl_socket() :: #ssl_socket{}).
+-type(socket() :: inet:ip_port() | ssl_socket()).
-spec(async_recv/3 :: (socket(), integer(), timeout()) -> {'ok', any()}).
-spec(close/1 :: (socket()) -> 'ok' | error()).
diff --git a/src/rabbit_networking.erl b/src/rabbit_networking.erl
index d00b6062d2..ed39664727 100644
--- a/src/rabbit_networking.erl
+++ b/src/rabbit_networking.erl
@@ -65,20 +65,26 @@
-type(connection() :: pid()).
+-type(listener() ::
+ #listener{node :: rabbit:erlang_node(),
+ protocol :: atom(),
+ host :: inet:hostname(),
+ port :: inet:ip_port()}).
+
-spec(start/0 :: () -> 'ok').
-spec(start_tcp_listener/2 :: (inet:hostname(), inet:ip_port()) -> 'ok').
--spec(start_ssl_listener/3 :: (inet:hostname(), inet:ip_port(), [info()]) -> 'ok').
+-spec(start_ssl_listener/3 :: (inet:hostname(), inet:ip_port(), [rabbit:info()]) -> 'ok').
-spec(stop_tcp_listener/2 :: (inet:hostname(), inet:ip_port()) -> 'ok').
-spec(active_listeners/0 :: () -> [listener()]).
--spec(node_listeners/1 :: (erlang_node()) -> [listener()]).
+-spec(node_listeners/1 :: (rabbit:erlang_node()) -> [listener()]).
-spec(connections/0 :: () -> [connection()]).
--spec(connection_info_keys/0 :: () -> [info_key()]).
--spec(connection_info/1 :: (connection()) -> [info()]).
--spec(connection_info/2 :: (connection(), [info_key()]) -> [info()]).
--spec(connection_info_all/0 :: () -> [[info()]]).
--spec(connection_info_all/1 :: ([info_key()]) -> [[info()]]).
+-spec(connection_info_keys/0 :: () -> [rabbit:info_key()]).
+-spec(connection_info/1 :: (connection()) -> [rabbit:info()]).
+-spec(connection_info/2 :: (connection(), [rabbit:info_key()]) -> [rabbit:info()]).
+-spec(connection_info_all/0 :: () -> [[rabbit:info()]]).
+-spec(connection_info_all/1 :: ([rabbit:info_key()]) -> [[rabbit:info()]]).
-spec(close_connection/2 :: (pid(), string()) -> 'ok').
--spec(on_node_down/1 :: (erlang_node()) -> 'ok').
+-spec(on_node_down/1 :: (rabbit:erlang_node()) -> 'ok').
-spec(check_tcp_listener_address/3 :: (atom(), inet:hostname(), inet:ip_port()) ->
{inet:ip_address(), atom()}).
diff --git a/src/rabbit_persister.erl b/src/rabbit_persister.erl
index 8d3c2dc082..727fcd1b2c 100644
--- a/src/rabbit_persister.erl
+++ b/src/rabbit_persister.erl
@@ -65,21 +65,23 @@
-ifdef(use_specs).
--type(pmsg() :: {queue_name(), pkey()}).
+-type(pkey() :: rabbit_guid:guid()).
+-type(pmsg() :: {rabbit_amqqueue:name(), pkey()}).
+
-type(work_item() ::
- {publish, message(), pmsg()} |
+ {publish, rabbit:message(), pmsg()} |
{deliver, pmsg()} |
{ack, pmsg()}).
--spec(start_link/1 :: ([queue_name()]) ->
+-spec(start_link/1 :: ([rabbit_amqqueue:name()]) ->
{'ok', pid()} | 'ignore' | {'error', any()}).
-spec(transaction/1 :: ([work_item()]) -> 'ok').
--spec(extend_transaction/2 :: ({txn(), queue_name()}, [work_item()]) -> 'ok').
+-spec(extend_transaction/2 :: ({rabbit:txn(), rabbit_amqqueue:name()}, [work_item()]) -> 'ok').
-spec(dirty_work/1 :: ([work_item()]) -> 'ok').
--spec(commit_transaction/1 :: ({txn(), queue_name()}) -> 'ok').
--spec(rollback_transaction/1 :: ({txn(), queue_name()}) -> 'ok').
+-spec(commit_transaction/1 :: ({rabbit:txn(), rabbit_amqqueue:name()}) -> 'ok').
+-spec(rollback_transaction/1 :: ({rabbit:txn(), rabbit_amqqueue:name()}) -> 'ok').
-spec(force_snapshot/0 :: () -> 'ok').
--spec(queue_content/1 :: (queue_name()) -> [{message(), boolean()}]).
+-spec(queue_content/1 :: (rabbit_amqqueue:name()) -> [{rabbit:message(), boolean()}]).
-endif.
diff --git a/src/rabbit_reader.erl b/src/rabbit_reader.erl
index f2a903dcca..a83adcd45e 100644
--- a/src/rabbit_reader.erl
+++ b/src/rabbit_reader.erl
@@ -138,11 +138,11 @@
-ifdef(use_specs).
--spec(info_keys/0 :: () -> [info_key()]).
--spec(info/1 :: (pid()) -> [info()]).
--spec(info/2 :: (pid(), [info_key()]) -> [info()]).
+-spec(info_keys/0 :: () -> [rabbit:info_key()]).
+-spec(info/1 :: (pid()) -> [rabbit:info()]).
+-spec(info/2 :: (pid(), [rabbit:info_key()]) -> [rabbit:info()]).
-spec(shutdown/2 :: (pid(), string()) -> 'ok').
--spec(server_properties/0 :: () -> amqp_table()).
+-spec(server_properties/0 :: () -> rabbit_framing:amqp_table()).
-endif.
diff --git a/src/rabbit_reader_queue_collector.erl b/src/rabbit_reader_queue_collector.erl
index 8d4e8fdb42..01eae523d3 100644
--- a/src/rabbit_reader_queue_collector.erl
+++ b/src/rabbit_reader_queue_collector.erl
@@ -47,7 +47,7 @@
-ifdef(use_specs).
-spec(start_link/0 :: () -> {'ok', pid()}).
--spec(register_exclusive_queue/2 :: (pid(), amqqueue()) -> 'ok').
+-spec(register_exclusive_queue/2 :: (pid(), rabbit_amqqueue:amqqueue()) -> 'ok').
-spec(delete_all/1 :: (pid()) -> 'ok').
-endif.
diff --git a/src/rabbit_router.erl b/src/rabbit_router.erl
index 75196bc0d4..8144d4a9d1 100644
--- a/src/rabbit_router.erl
+++ b/src/rabbit_router.erl
@@ -41,7 +41,10 @@
-ifdef(use_specs).
--spec(deliver/2 :: ([pid()], delivery()) -> {routing_result(), [pid()]}).
+-type(routing_key() :: binary()).
+-type(routing_result() :: 'routed' | 'unroutable' | 'not_delivered').
+
+-spec(deliver/2 :: ([pid()], rabbit:delivery()) -> {routing_result(), [pid()]}).
-endif.
diff --git a/src/rabbit_writer.erl b/src/rabbit_writer.erl
index 3d10dc121e..7c826d9891 100644
--- a/src/rabbit_writer.erl
+++ b/src/rabbit_writer.erl
@@ -48,20 +48,28 @@
-ifdef(use_specs).
--spec(start/3 :: (socket(), channel_number(), non_neg_integer()) -> pid()).
--spec(start_link/3 :: (socket(), channel_number(), non_neg_integer()) -> pid()).
--spec(send_command/2 :: (pid(), amqp_method_record()) -> 'ok').
--spec(send_command/3 :: (pid(), amqp_method_record(), content()) -> 'ok').
--spec(send_command_and_signal_back/3 :: (pid(), amqp_method(), pid()) -> 'ok').
+-spec(start/3 ::
+ (rabbit_net:socket(), rabbit_channel:channel_number(), non_neg_integer())
+ -> pid()).
+-spec(start_link/3 ::
+ (rabbit_net:socket(), rabbit_channel:channel_number(), non_neg_integer())
+ -> pid()).
+-spec(send_command/2 :: (pid(), rabbit_framing:amqp_method_record()) -> 'ok').
+-spec(send_command/3 ::
+ (pid(), rabbit_framing:amqp_method_record(), rabbit:content()) -> 'ok').
+-spec(send_command_and_signal_back/3 ::
+ (pid(), rabbit_framing:amqp_method(), pid()) -> 'ok').
-spec(send_command_and_signal_back/4 ::
- (pid(), amqp_method(), content(), pid()) -> 'ok').
+ (pid(), rabbit_framing:amqp_method(), rabbit:content(), pid()) -> 'ok').
-spec(send_command_and_notify/5 ::
- (pid(), pid(), pid(), amqp_method_record(), content()) -> 'ok').
+ (pid(), pid(), pid(), rabbit_framing:amqp_method_record(), rabbit:content())
+ -> 'ok').
-spec(internal_send_command/3 ::
- (socket(), channel_number(), amqp_method_record()) -> 'ok').
+ (rabbit_net:socket(), rabbit_channel:channel_number(), rabbit_framing:amqp_method_record())
+ -> 'ok').
-spec(internal_send_command/5 ::
- (socket(), channel_number(), amqp_method_record(),
- content(), non_neg_integer()) -> 'ok').
+ (rabbit_net:socket(), rabbit_channel:channel_number(), rabbit_framing:amqp_method_record(),
+ rabbit:content(), non_neg_integer()) -> 'ok').
-endif.