summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexandru Scvortov <alexandru@rabbitmq.com>2010-07-06 11:46:40 +0100
committerAlexandru Scvortov <alexandru@rabbitmq.com>2010-07-06 11:46:40 +0100
commitf585792df291dd5566bbc6853309bdc9d299a895 (patch)
tree1f12b4a5a292ef8bc5699f3948b20b8b0acd9b28
parent12806334fb5123f8a2229cc28951cd51c9ba5e3c (diff)
downloadrabbitmq-server-f585792df291dd5566bbc6853309bdc9d299a895.tar.gz
{'ok', A} -> rabbit_types:ok(A)
-rw-r--r--src/delegate.erl2
-rw-r--r--src/delegate_sup.erl2
-rw-r--r--src/file_handle_cache.erl2
-rw-r--r--src/pg_local.erl4
-rw-r--r--src/rabbit_access_control.erl2
-rw-r--r--src/rabbit_amqqueue.erl4
-rw-r--r--src/rabbit_exchange.erl2
-rw-r--r--src/rabbit_exchange_type_registry.erl4
-rw-r--r--src/rabbit_guid.erl2
-rw-r--r--src/rabbit_log.erl2
-rw-r--r--src/rabbit_memory_monitor.erl2
-rw-r--r--src/rabbit_misc.erl4
-rw-r--r--src/rabbit_net.erl8
-rw-r--r--src/rabbit_persister.erl2
-rw-r--r--src/rabbit_reader_queue_collector.erl2
-rw-r--r--src/rabbit_types.erl3
-rw-r--r--src/vm_memory_monitor.erl2
-rw-r--r--src/worker_pool.erl2
-rw-r--r--src/worker_pool_sup.erl4
19 files changed, 28 insertions, 27 deletions
diff --git a/src/delegate.erl b/src/delegate.erl
index 8af28127..c2185e06 100644
--- a/src/delegate.erl
+++ b/src/delegate.erl
@@ -44,7 +44,7 @@
-ifdef(use_specs).
--spec(start_link/1 :: (non_neg_integer()) -> {'ok', pid()}).
+-spec(start_link/1 :: (non_neg_integer()) -> rabbit_types:ok(pid())).
-spec(invoke_no_result/2 :: (pid() | [pid()], fun ((pid()) -> any())) -> 'ok').
-spec(invoke/2 :: (pid() | [pid()], fun ((pid()) -> A)) -> A).
diff --git a/src/delegate_sup.erl b/src/delegate_sup.erl
index 78368090..9a308eb1 100644
--- a/src/delegate_sup.erl
+++ b/src/delegate_sup.erl
@@ -43,7 +43,7 @@
-ifdef(use_specs).
--spec(start_link/0 :: () -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())).
+-spec(start_link/0 :: () -> rabbit_types:ok(pid()) | 'ignore' | rabbit_types:error(any())).
-endif.
diff --git a/src/file_handle_cache.erl b/src/file_handle_cache.erl
index 99a4336d..790c1e08 100644
--- a/src/file_handle_cache.erl
+++ b/src/file_handle_cache.erl
@@ -183,7 +183,7 @@
-type(ref() :: any()).
-type(ok_or_error() :: rabbit_types:ok_or_error(any())).
--type(val_or_error(T) :: ({'ok', T} | rabbit_types:error(any()))).
+-type(val_or_error(T) :: (rabbit_types:ok(T) | rabbit_types:error(any()))).
-type(position() :: ('bof' | 'eof' | non_neg_integer() |
{('bof' |'eof'), non_neg_integer()} | {'cur', integer()})).
-type(offset() :: non_neg_integer()).
diff --git a/src/pg_local.erl b/src/pg_local.erl
index 4f22fb34..a316e1e0 100644
--- a/src/pg_local.erl
+++ b/src/pg_local.erl
@@ -45,8 +45,8 @@
-type(name() :: term()).
--spec(start_link/0 :: () -> {'ok', pid()} | rabbit_types:error(term())).
--spec(start/0 :: () -> {'ok', pid()} | rabbit_types:error(term())).
+-spec(start_link/0 :: () -> rabbit_types:ok(pid()) | rabbit_types:error(term())).
+-spec(start/0 :: () -> rabbit_types:ok(pid()) | rabbit_types:error(term())).
-spec(join/2 :: (name(), pid()) -> 'ok').
-spec(leave/2 :: (name(), pid()) -> 'ok').
-spec(get_members/1 :: (name()) -> [pid()]).
diff --git a/src/rabbit_access_control.erl b/src/rabbit_access_control.erl
index 20415fd0..4b068447 100644
--- a/src/rabbit_access_control.erl
+++ b/src/rabbit_access_control.erl
@@ -62,7 +62,7 @@
-spec(change_password/2 :: (username(), password()) -> 'ok').
-spec(list_users/0 :: () -> [username()]).
-spec(lookup_user/1 :: (username()) ->
- {'ok', rabbit_types:user()} | rabbit_types:error('not_found')).
+ rabbit_types:ok(rabbit_types:user()) | rabbit_types:error('not_found')).
-spec(add_vhost/1 :: (rabbit_types:vhost()) -> 'ok').
-spec(delete_vhost/1 :: (rabbit_types:vhost()) -> 'ok').
-spec(list_vhosts/0 :: () -> [rabbit_types:vhost()]).
diff --git a/src/rabbit_amqqueue.erl b/src/rabbit_amqqueue.erl
index c578c66b..169acd80 100644
--- a/src/rabbit_amqqueue.erl
+++ b/src/rabbit_amqqueue.erl
@@ -63,7 +63,7 @@
-type(name() :: rabbit_types:r('queue')).
--type(qlen() :: {'ok', non_neg_integer()}).
+-type(qlen() :: rabbit_types:ok(non_neg_integer())).
-type(qfun(A) :: fun ((rabbit_types:amqqueue()) -> A)).
-type(qmsg() :: {name(), pid(), msg_id(), boolean(), rabbit_types:message()}).
-type(msg_id() :: non_neg_integer()).
@@ -73,7 +73,7 @@
-spec(start/0 :: () -> 'ok').
-spec(declare/5 :: (name(), boolean(), boolean(), rabbit_framing:amqp_table(),
rabbit_types:maybe(pid())) -> {'new' | 'existing', rabbit_types:amqqueue()}).
--spec(lookup/1 :: (name()) -> {'ok', rabbit_types:amqqueue()} | rabbit_types:error('not_found')).
+-spec(lookup/1 :: (name()) -> rabbit_types:ok(rabbit_types:amqqueue()) | rabbit_types:error('not_found')).
-spec(with/2 :: (name(), qfun(A)) -> A | rabbit_types:error('not_found')).
-spec(with_or_die/2 :: (name(), qfun(A)) -> A).
-spec(assert_equivalence/5 :: (rabbit_types:amqqueue(), boolean(), boolean(),
diff --git a/src/rabbit_exchange.erl b/src/rabbit_exchange.erl
index a0f8ed91..024dccf0 100644
--- a/src/rabbit_exchange.erl
+++ b/src/rabbit_exchange.erl
@@ -76,7 +76,7 @@
-spec(assert_args_equivalence/2 ::
(rabbit_types:exchange(), rabbit_framing:amqp_table()) -> 'ok').
-spec(lookup/1 :: (name())
- -> {'ok', rabbit_types:exchange()} | rabbit_types:error('not_found')).
+ -> rabbit_types:ok(rabbit_types:exchange()) | rabbit_types:error('not_found')).
-spec(lookup_or_die/1 :: (name()) -> rabbit_types:exchange()).
-spec(list/1 :: (rabbit_types:vhost()) -> [rabbit_types:exchange()]).
-spec(info_keys/0 :: () -> [rabbit_types:info_key()]).
diff --git a/src/rabbit_exchange_type_registry.erl b/src/rabbit_exchange_type_registry.erl
index acad1875..729ede3e 100644
--- a/src/rabbit_exchange_type_registry.erl
+++ b/src/rabbit_exchange_type_registry.erl
@@ -45,10 +45,10 @@
-ifdef(use_specs).
--spec(start_link/0 :: () -> 'ignore' | rabbit_types:error(term()) | {'ok', pid()}).
+-spec(start_link/0 :: () -> 'ignore' | rabbit_types:error(term()) | rabbit_types:ok(pid())).
-spec(register/2 :: (binary(), atom()) -> 'ok').
-spec(binary_to_type/1 :: (binary()) -> atom() | rabbit_types:error('not_found')).
--spec(lookup_module/1 :: (atom()) -> {'ok', atom()} | rabbit_types:error('not_found')).
+-spec(lookup_module/1 :: (atom()) -> rabbit_types:ok(atom()) | rabbit_types:error('not_found')).
-endif.
diff --git a/src/rabbit_guid.erl b/src/rabbit_guid.erl
index dfbe0d84..45cbcc80 100644
--- a/src/rabbit_guid.erl
+++ b/src/rabbit_guid.erl
@@ -54,7 +54,7 @@
-type(guid() :: binary()).
--spec(start_link/0 :: () -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())).
+-spec(start_link/0 :: () -> rabbit_types:ok(pid()) | 'ignore' | rabbit_types:error(any())).
-spec(guid/0 :: () -> guid()).
-spec(string_guid/1 :: (any()) -> string()).
-spec(binstring_guid/1 :: (any()) -> binary()).
diff --git a/src/rabbit_log.erl b/src/rabbit_log.erl
index 15fe8dea..7beed2c0 100644
--- a/src/rabbit_log.erl
+++ b/src/rabbit_log.erl
@@ -50,7 +50,7 @@
-ifdef(use_specs).
--spec(start_link/0 :: () -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())).
+-spec(start_link/0 :: () -> rabbit_types:ok(pid()) | 'ignore' | rabbit_types:error(any())).
-spec(debug/1 :: (string()) -> 'ok').
-spec(debug/2 :: (string(), [any()]) -> 'ok').
-spec(info/1 :: (string()) -> 'ok').
diff --git a/src/rabbit_memory_monitor.erl b/src/rabbit_memory_monitor.erl
index 55d26c57..4c5695e9 100644
--- a/src/rabbit_memory_monitor.erl
+++ b/src/rabbit_memory_monitor.erl
@@ -86,7 +86,7 @@
-ifdef(use_specs).
--spec(start_link/0 :: () -> 'ignore' | rabbit_types:error(any()) | {'ok', pid()}).
+-spec(start_link/0 :: () -> 'ignore' | rabbit_types:error(any()) | rabbit_types:ok(pid())).
-spec(update/0 :: () -> 'ok').
-spec(register/2 :: (pid(), {atom(),atom(),[any()]}) -> 'ok').
-spec(deregister/1 :: (pid()) -> 'ok').
diff --git a/src/rabbit_misc.erl b/src/rabbit_misc.erl
index 98921ad3..0133b9cf 100644
--- a/src/rabbit_misc.erl
+++ b/src/rabbit_misc.erl
@@ -93,10 +93,10 @@
-spec(protocol_error/4 :: (rabbit_framing:amqp_exception(), string(), [any()],
rabbit_framing:amqp_method_name()) -> no_return()).
-spec(not_found/1 :: (rabbit_types:r(atom())) -> no_return()).
--spec(get_config/1 :: (atom()) -> {'ok', any()} | rabbit_types:error('not_found')).
+-spec(get_config/1 :: (atom()) -> rabbit_types:ok(any()) | rabbit_types:error('not_found')).
-spec(get_config/2 :: (atom(), A) -> A).
-spec(set_config/2 :: (atom(), any()) -> 'ok').
--spec(dirty_read/1 :: ({atom(), any()}) -> {'ok', any()} | rabbit_types:error('not_found')).
+-spec(dirty_read/1 :: ({atom(), any()}) -> rabbit_types:ok(any()) | rabbit_types:error('not_found')).
-spec(r/3 :: (rabbit_types:vhost() | rabbit_types:r(atom()), K, resource_name())
-> rabbit_types:r(K) when is_subtype(K, atom())).
-spec(r/2 :: (rabbit_types:vhost(), K)
diff --git a/src/rabbit_net.erl b/src/rabbit_net.erl
index cd0ea7d6..20485bec 100644
--- a/src/rabbit_net.erl
+++ b/src/rabbit_net.erl
@@ -46,17 +46,17 @@
-type(error() :: rabbit_types:error(any())).
-type(socket() :: rabbit_networking:ip_port() | rabbit_types:ssl_socket()).
--spec(async_recv/3 :: (socket(), integer(), timeout()) -> {'ok', any()}).
+-spec(async_recv/3 :: (socket(), integer(), timeout()) -> rabbit_types:ok(any())).
-spec(close/1 :: (socket()) -> rabbit_types:ok_or_error(any())).
-spec(controlling_process/2 :: (socket(), pid()) -> rabbit_types:ok_or_error(any())).
-spec(port_command/2 :: (socket(), iolist()) -> 'true').
-spec(send/2 :: (socket(), binary() | iolist()) -> rabbit_types:ok_or_error(any())).
-spec(peername/1 :: (socket()) ->
- {'ok', {inet:ip_address(), rabbit_networking:ip_port()}} | error()).
+ rabbit_types:ok({inet:ip_address(), rabbit_networking:ip_port()}) | error()).
-spec(sockname/1 :: (socket()) ->
- {'ok', {inet:ip_address(), rabbit_networking:ip_port()}} | error()).
+ rabbit_types:ok({inet:ip_address(), rabbit_networking:ip_port()}) | error()).
-spec(getstat/2 :: (socket(), [stat_option()]) ->
- {'ok', [{stat_option(), integer()}]} | error()).
+ rabbit_types:ok([{stat_option(), integer()}]) | error()).
-endif.
diff --git a/src/rabbit_persister.erl b/src/rabbit_persister.erl
index 8505dfdb..327fc4b7 100644
--- a/src/rabbit_persister.erl
+++ b/src/rabbit_persister.erl
@@ -74,7 +74,7 @@
{ack, pmsg()}).
-spec(start_link/1 :: ([rabbit_amqqueue:name()]) ->
- {'ok', pid()} | 'ignore' | rabbit_types:error(any())).
+ rabbit_types:ok(pid()) | 'ignore' | rabbit_types:error(any())).
-spec(transaction/1 :: ([work_item()]) -> 'ok').
-spec(extend_transaction/2 :: ({rabbit_types:txn(), rabbit_amqqueue:name()}, [work_item()]) -> 'ok').
-spec(dirty_work/1 :: ([work_item()]) -> 'ok').
diff --git a/src/rabbit_reader_queue_collector.erl b/src/rabbit_reader_queue_collector.erl
index e0919cd5..a9117e9c 100644
--- a/src/rabbit_reader_queue_collector.erl
+++ b/src/rabbit_reader_queue_collector.erl
@@ -46,7 +46,7 @@
-ifdef(use_specs).
--spec(start_link/0 :: () -> {'ok', pid()}).
+-spec(start_link/0 :: () -> rabbit_types:ok(pid())).
-spec(register_exclusive_queue/2 :: (pid(), rabbit_types:amqqueue()) -> 'ok').
-spec(delete_all/1 :: (pid()) -> 'ok').
diff --git a/src/rabbit_types.erl b/src/rabbit_types.erl
index 5adf72d7..e42c6b44 100644
--- a/src/rabbit_types.erl
+++ b/src/rabbit_types.erl
@@ -39,7 +39,7 @@
delivery/0, content/0, decoded_content/0, undecoded_content/0,
unencoded_content/0, encoded_content/0, vhost/0, ctag/0, amqp_error/0,
r/1, ssl_socket/0, listener/0, binding/0, amqqueue/0,
- exchange/0, connection/0, user/0, error/1, ok_or_error/1]).
+ exchange/0, connection/0, user/0, error/1, ok_or_error/1, ok/1]).
-type(maybe(T) :: T | 'none').
-type(vhost() :: binary()).
@@ -131,6 +131,7 @@
#user{username :: rabbit_access_control:username(),
password :: rabbit_access_control:password()}).
+-type(ok(A) :: {'ok', A}).
-type(error(A) :: {'error', A}).
-type(ok_or_error(A) :: 'ok' | error(A)).
diff --git a/src/vm_memory_monitor.erl b/src/vm_memory_monitor.erl
index 20890672..069c5a0f 100644
--- a/src/vm_memory_monitor.erl
+++ b/src/vm_memory_monitor.erl
@@ -73,7 +73,7 @@
-ifdef(use_specs).
-spec(start_link/1 :: (float()) ->
- ('ignore' | rabbit_types:error(any()) | {'ok', pid()})).
+ ('ignore' | rabbit_types:error(any()) | rabbit_types:ok(pid()))).
-spec(update/0 :: () -> 'ok').
-spec(get_total_memory/0 :: () -> (non_neg_integer() | 'unknown')).
-spec(get_vm_limit/0 :: () -> (non_neg_integer() | 'unknown')).
diff --git a/src/worker_pool.erl b/src/worker_pool.erl
index cc2658d9..a1e94fa8 100644
--- a/src/worker_pool.erl
+++ b/src/worker_pool.erl
@@ -52,7 +52,7 @@
-ifdef(use_specs).
--spec(start_link/0 :: () -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())).
+-spec(start_link/0 :: () -> rabbit_types:ok(pid()) | 'ignore' | rabbit_types:error(any())).
-spec(submit/1 :: (fun (() -> A) | {atom(), atom(), [any()]}) -> A).
-spec(submit_async/1 ::
(fun (() -> any()) | {atom(), atom(), [any()]}) -> 'ok').
diff --git a/src/worker_pool_sup.erl b/src/worker_pool_sup.erl
index dbffff10..3d9d5b16 100644
--- a/src/worker_pool_sup.erl
+++ b/src/worker_pool_sup.erl
@@ -41,9 +41,9 @@
-ifdef(use_specs).
--spec(start_link/0 :: () -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())).
+-spec(start_link/0 :: () -> rabbit_types:ok(pid()) | 'ignore' | rabbit_types:error(any())).
-spec(start_link/1 ::
- (non_neg_integer()) -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())).
+ (non_neg_integer()) -> rabbit_types:ok(pid()) | 'ignore' | rabbit_types:error(any())).
-endif.