diff options
| author | Alexandru Scvortov <alexandru@rabbitmq.com> | 2010-07-06 10:50:28 +0100 |
|---|---|---|
| committer | Alexandru Scvortov <alexandru@rabbitmq.com> | 2010-07-06 10:50:28 +0100 |
| commit | 1dff479dc24af4b411a6acb8c5aca5f21a268bb7 (patch) | |
| tree | 0d1ab01ceb7a14baf4de071e60f0399d3b5ef324 | |
| parent | 46090b481301088c31c373e77534d6e4def64697 (diff) | |
| download | rabbitmq-server-git-1dff479dc24af4b411a6acb8c5aca5f21a268bb7.tar.gz | |
{error, A} -> rabbit_types:error(A)
| -rw-r--r-- | src/delegate_sup.erl | 2 | ||||
| -rw-r--r-- | src/file_handle_cache.erl | 2 | ||||
| -rw-r--r-- | src/pg_local.erl | 4 | ||||
| -rw-r--r-- | src/rabbit.erl | 2 | ||||
| -rw-r--r-- | src/rabbit_access_control.erl | 2 | ||||
| -rw-r--r-- | src/rabbit_amqqueue.erl | 16 | ||||
| -rw-r--r-- | src/rabbit_basic.erl | 4 | ||||
| -rw-r--r-- | src/rabbit_exchange.erl | 13 | ||||
| -rw-r--r-- | src/rabbit_exchange_type_registry.erl | 6 | ||||
| -rw-r--r-- | src/rabbit_guid.erl | 2 | ||||
| -rw-r--r-- | src/rabbit_log.erl | 2 | ||||
| -rw-r--r-- | src/rabbit_memory_monitor.erl | 2 | ||||
| -rw-r--r-- | src/rabbit_misc.erl | 10 | ||||
| -rw-r--r-- | src/rabbit_net.erl | 2 | ||||
| -rw-r--r-- | src/rabbit_persister.erl | 2 | ||||
| -rw-r--r-- | src/rabbit_types.erl | 8 | ||||
| -rw-r--r-- | src/vm_memory_monitor.erl | 2 | ||||
| -rw-r--r-- | src/worker_pool.erl | 2 | ||||
| -rw-r--r-- | src/worker_pool_sup.erl | 4 | ||||
| -rw-r--r-- | src/worker_pool_worker.erl | 2 |
20 files changed, 44 insertions, 45 deletions
diff --git a/src/delegate_sup.erl b/src/delegate_sup.erl index 1c1d62a95d..7836809020 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' | {'error', any()}). +-spec(start_link/0 :: () -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())). -endif. diff --git a/src/file_handle_cache.erl b/src/file_handle_cache.erl index 0f648dcd2b..888aed1ffc 100644 --- a/src/file_handle_cache.erl +++ b/src/file_handle_cache.erl @@ -182,7 +182,7 @@ -ifdef(use_specs). -type(ref() :: any()). --type(error() :: {'error', any()}). +-type(error() :: rabbit_types:error(any())). -type(ok_or_error() :: ('ok' | error())). -type(val_or_error(T) :: ({'ok', T} | error())). -type(position() :: ('bof' | 'eof' | non_neg_integer() | diff --git a/src/pg_local.erl b/src/pg_local.erl index 1501331d6b..4f22fb341d 100644 --- a/src/pg_local.erl +++ b/src/pg_local.erl @@ -45,8 +45,8 @@ -type(name() :: term()). --spec(start_link/0 :: () -> {'ok', pid()} | {'error', term()}). --spec(start/0 :: () -> {'ok', pid()} | {'error', term()}). +-spec(start_link/0 :: () -> {'ok', pid()} | rabbit_types:error(term())). +-spec(start/0 :: () -> {'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.erl b/src/rabbit.erl index 3ebbd07215..df46627438 100644 --- a/src/rabbit.erl +++ b/src/rabbit.erl @@ -191,7 +191,7 @@ -spec(start/0 :: () -> 'ok'). -spec(stop/0 :: () -> 'ok'). -spec(stop_and_halt/0 :: () -> 'ok'). --spec(rotate_logs/1 :: (file_suffix()) -> 'ok' | {'error', any()}). +-spec(rotate_logs/1 :: (file_suffix()) -> 'ok' | rabbit_types:error(any())). -spec(status/0 :: () -> [{running_applications, [{atom(), string(), string()}]} | {nodes, [{rabbit_mnesia:node_type(), [node()]}]} | diff --git a/src/rabbit_access_control.erl b/src/rabbit_access_control.erl index 6f1b3340c2..20415fd09a 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:not_found()). + {'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 b23058a60f..fa7ceda658 100644 --- a/src/rabbit_amqqueue.erl +++ b/src/rabbit_amqqueue.erl @@ -73,8 +73,8 @@ -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:not_found()). --spec(with/2 :: (name(), qfun(A)) -> A | rabbit_types:not_found()). +-spec(lookup/1 :: (name()) -> {'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(), rabbit_framing:amqp_table(), rabbit_types:maybe(pid)) @@ -95,11 +95,11 @@ (rabbit_types:amqqueue()) -> {'ok', non_neg_integer(), non_neg_integer()}). -spec(delete/3 :: (rabbit_types:amqqueue(), 'false', 'false') -> qlen(); - (rabbit_types:amqqueue(), 'true' , 'false') -> qlen() | {'error', 'in_use'}; - (rabbit_types:amqqueue(), 'false', 'true' ) -> qlen() | {'error', 'not_empty'}; + (rabbit_types:amqqueue(), 'true' , 'false') -> qlen() | rabbit_types:error('in_use'); + (rabbit_types:amqqueue(), 'false', 'true' ) -> qlen() | rabbit_types:error('not_empty'); (rabbit_types:amqqueue(), 'true' , 'true' ) -> qlen() | - {'error', 'in_use'} | - {'error', 'not_empty'}). + rabbit_types:error('in_use') | + rabbit_types:error('not_empty')). -spec(purge/1 :: (rabbit_types:amqqueue()) -> qlen()). -spec(deliver/2 :: (pid(), rabbit_types:delivery()) -> boolean()). -spec(requeue/3 :: (pid(), [msg_id()], pid()) -> 'ok'). @@ -114,13 +114,13 @@ -spec(basic_consume/7 :: (rabbit_types:amqqueue(), boolean(), pid(), pid() | 'undefined', rabbit_types:ctag(), boolean(), any()) - -> 'ok' | {'error', 'exclusive_consume_unavailable'}). + -> 'ok' | rabbit_types:error('exclusive_consume_unavailable')). -spec(basic_cancel/4 :: (rabbit_types:amqqueue(), pid(), rabbit_types: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 :: (rabbit_types:amqqueue(), boolean()) -> rabbit_types:amqqueue() | 'not_found'). --spec(internal_delete/1 :: (name()) -> 'ok' | rabbit_types:not_found()). +-spec(internal_delete/1 :: (name()) -> 'ok' | rabbit_types:error('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'). diff --git a/src/rabbit_basic.erl b/src/rabbit_basic.erl index 7615301037..5d50f5c28a 100644 --- a/src/rabbit_basic.erl +++ b/src/rabbit_basic.erl @@ -44,14 +44,14 @@ -type(properties_input() :: (rabbit_framing:amqp_property_record() | [{atom(), any()}])). -type(publish_result() :: ({ok, rabbit_router:routing_result(), [pid()]} - | rabbit_types:not_found())). + | rabbit_types:error('not_found'))). -spec(publish/1 :: (rabbit_types:delivery()) -> publish_result()). -spec(delivery/4 :: (boolean(), boolean(), rabbit_types:maybe(rabbit_types:txn()), rabbit_types:message()) -> rabbit_types:delivery()). -spec(message/4 :: (rabbit_exchange:name(), rabbit_router:routing_key(), properties_input(), binary()) - -> (rabbit_types:message() | {'error', any()})). + -> (rabbit_types:message() | rabbit_types:error(any()))). -spec(properties/1 :: (properties_input()) -> rabbit_framing:amqp_property_record()). -spec(publish/4 :: (rabbit_exchange:name(), rabbit_router:routing_key(), properties_input(), binary()) -> publish_result()). diff --git a/src/rabbit_exchange.erl b/src/rabbit_exchange.erl index b63fd87660..8a3262d5a7 100644 --- a/src/rabbit_exchange.erl +++ b/src/rabbit_exchange.erl @@ -62,10 +62,9 @@ -type(type() :: atom()). -type(binding_key() :: binary()). --type(bind_res() :: 'ok' | {'error', - 'queue_not_found' | - 'exchange_not_found' | - 'exchange_and_queue_not_found'}). +-type(bind_res() :: 'ok' | rabbit_types:error('queue_not_found') | + rabbit_types:error('exchange_not_found') | + rabbit_types:error('exchange_and_queue_not_found')). -type(inner_fun() :: fun((rabbit_types:exchange(), queue()) -> any())). -spec(recover/0 :: () -> 'ok'). @@ -77,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:not_found()). + -> {'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()]). @@ -94,7 +93,7 @@ -spec(delete_binding/5 :: (name(), rabbit_amqqueue:name(), rabbit_router:routing_key(), rabbit_framing:amqp_table(), inner_fun()) - -> bind_res() | {'error', 'binding_not_found'}). + -> bind_res() | rabbit_types:error('binding_not_found')). -spec(list_bindings/1 :: (rabbit_types:vhost()) -> [{name(), rabbit_amqqueue:name(), rabbit_router:routing_key(), rabbit_framing:amqp_table()}]). @@ -103,7 +102,7 @@ -spec(delete_transient_queue_bindings/1 :: (rabbit_amqqueue:name()) -> fun (() -> none())). -spec(delete/2 :: (name(), boolean()) -> - 'ok' | rabbit_types:not_found() | {'error', 'in_use'}). + 'ok' | rabbit_types:error('not_found') | rabbit_types:error('in_use')). -spec(list_queue_bindings/1 :: (rabbit_amqqueue:name()) -> [{name(), rabbit_router:routing_key(), rabbit_framing:amqp_table()}]). diff --git a/src/rabbit_exchange_type_registry.erl b/src/rabbit_exchange_type_registry.erl index 33ea0e926b..acad1875f7 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' | {'error', term()} | {'ok', pid()}). +-spec(start_link/0 :: () -> 'ignore' | rabbit_types:error(term()) | {'ok', pid()}). -spec(register/2 :: (binary(), atom()) -> 'ok'). --spec(binary_to_type/1 :: (binary()) -> atom() | {'error', 'not_found'}). --spec(lookup_module/1 :: (atom()) -> {'ok', atom()} | {'error', 'not_found'}). +-spec(binary_to_type/1 :: (binary()) -> atom() | rabbit_types:error('not_found')). +-spec(lookup_module/1 :: (atom()) -> {'ok', atom()} | rabbit_types:error('not_found')). -endif. diff --git a/src/rabbit_guid.erl b/src/rabbit_guid.erl index 6afbbee971..dfbe0d8447 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' | {'error', any()}). +-spec(start_link/0 :: () -> {'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 cc80e360ae..15fe8deab9 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' | {'error', any()}). +-spec(start_link/0 :: () -> {'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 e78b59f16e..55d26c57d4 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' | {'error', _} | {'ok', pid()}). +-spec(start_link/0 :: () -> 'ignore' | rabbit_types:error(any()) | {'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 671505636b..8d4d046005 100644 --- a/src/rabbit_misc.erl +++ b/src/rabbit_misc.erl @@ -74,7 +74,7 @@ -export_type([resource_name/0]). --type(ok_or_error() :: 'ok' | {'error', any()}). +-type(ok_or_error() :: 'ok' | rabbit_types:error(any())). -type(resource_name() :: binary()). -type(thunk(T) :: fun(() -> T)). @@ -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:not_found()). +-spec(get_config/1 :: (atom()) -> {'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:not_found()). +-spec(dirty_read/1 :: ({atom(), any()}) -> {'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) @@ -113,7 +113,7 @@ -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(throw_on_error/2 :: (atom(), thunk(rabbit_types:error(any()) | {ok, A} | A)) -> A). -spec(with_exit_handler/2 :: (thunk(A), thunk(A)) -> A). -spec(filter_exit_map/2 :: (fun ((A) -> B), [A]) -> [B]). -spec(with_user/2 :: (rabbit_access_control:username(), thunk(A)) -> A). @@ -134,7 +134,7 @@ -spec(dirty_foreach_key/2 :: (fun ((any()) -> any()), atom()) -> 'ok' | 'aborted'). -spec(dirty_dump_log/1 :: (file:filename()) -> ok_or_error()). --spec(read_term_file/1 :: (file:filename()) -> {'ok', [any()]} | {'error', any()}). +-spec(read_term_file/1 :: (file:filename()) -> {'ok', [any()]} | rabbit_types:error(any())). -spec(write_term_file/2 :: (file:filename(), [any()]) -> ok_or_error()). -spec(append_file/2 :: (file:filename(), string()) -> ok_or_error()). -spec(ensure_parent_dirs_exist/1 :: (string()) -> 'ok'). diff --git a/src/rabbit_net.erl b/src/rabbit_net.erl index 8848ea8736..e1c77e29bf 100644 --- a/src/rabbit_net.erl +++ b/src/rabbit_net.erl @@ -43,7 +43,7 @@ -type(stat_option() :: '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(error() :: rabbit_types:error(any())). -type(socket() :: rabbit_networking:ip_port() | rabbit_types:ssl_socket()). -spec(async_recv/3 :: (socket(), integer(), timeout()) -> {'ok', any()}). diff --git a/src/rabbit_persister.erl b/src/rabbit_persister.erl index ea290b372c..8505dfdbeb 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' | {'error', any()}). + {'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_types.erl b/src/rabbit_types.erl index 22f9f8d76d..dd88135b6d 100644 --- a/src/rabbit_types.erl +++ b/src/rabbit_types.erl @@ -38,8 +38,8 @@ -export_type([txn/0, maybe/1, info/0, info_key/0, message/0, basic_message/0, delivery/0, content/0, decoded_content/0, undecoded_content/0, unencoded_content/0, encoded_content/0, vhost/0, ctag/0, amqp_error/0, - not_found/0, r/1, ssl_socket/0, listener/0, binding/0, amqqueue/0, - exchange/0, connection/0, user/0]). + r/1, ssl_socket/0, listener/0, binding/0, amqqueue/0, + exchange/0, connection/0, user/0, error/1]). -type(maybe(T) :: T | 'none'). -type(vhost() :: binary()). @@ -92,8 +92,6 @@ #amqp_error{name :: rabbit_framing:amqp_exception(), explanation :: string(), method :: rabbit_framing:amqp_method_name()}). --type(not_found() :: {'error', 'not_found'}). - -type(r(Kind) :: #resource{virtual_host :: rabbit_types:vhost(), kind :: Kind, @@ -133,4 +131,6 @@ #user{username :: rabbit_access_control:username(), password :: rabbit_access_control:password()}). +-type(error(A) :: {'error', A}). + -endif. % use_specs diff --git a/src/vm_memory_monitor.erl b/src/vm_memory_monitor.erl index cd03fcc6e6..2089067215 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' | {'error', any()} | {'ok', pid()})). + ('ignore' | rabbit_types:error(any()) | {'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 97e075459f..cc2658d9d9 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' | {'error', any()}). +-spec(start_link/0 :: () -> {'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 4ded63a8db..dbffff1020 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' | {'error', any()}). +-spec(start_link/0 :: () -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())). -spec(start_link/1 :: - (non_neg_integer()) -> {'ok', pid()} | 'ignore' | {'error', any()}). + (non_neg_integer()) -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())). -endif. diff --git a/src/worker_pool_worker.erl b/src/worker_pool_worker.erl index 57901fd5cf..6a14484ee5 100644 --- a/src/worker_pool_worker.erl +++ b/src/worker_pool_worker.erl @@ -44,7 +44,7 @@ -ifdef(use_specs). --spec(start_link/1 :: (any()) -> {'ok', pid()} | 'ignore' | {'error', any()}). +-spec(start_link/1 :: (any()) -> {'ok', pid()} | 'ignore' | rabbit_types:error(any())). -spec(submit/2 :: (pid(), fun (() -> A) | {atom(), atom(), [any()]}) -> A). -spec(submit_async/2 :: (pid(), fun (() -> any()) | {atom(), atom(), [any()]}) -> 'ok'). |
