summaryrefslogtreecommitdiff
path: root/include/rabbit_exchange_type_spec.hrl
blob: 8f7e22d37e64938eb040cdcd01c7cf73f2d8cce8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
%% The contents of this file are subject to the Mozilla Public License
%% Version 1.1 (the "License"); you may not use this file except in
%% compliance with the License. You may obtain a copy of the License
%% at http://www.mozilla.org/MPL/
%%
%% 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.
%%
%% The Original Code is RabbitMQ.
%%
%% The Initial Developer of the Original Code is VMware, Inc.
%% Copyright (c) 2007-2012 VMware, Inc.  All rights reserved.
%%

-ifdef(use_specs).

-type(tx() :: 'transaction' | 'none').
-type(serial() :: pos_integer() | tx()).

-spec(description/0 :: () -> [{atom(), any()}]).
-spec(serialise_events/0 :: () -> boolean()).
-spec(route/2 :: (rabbit_types:exchange(), rabbit_types:delivery())
                 -> rabbit_router:match_result()).
-spec(validate/1 :: (rabbit_types:exchange()) -> 'ok').
-spec(create/2 :: (tx(), rabbit_types:exchange()) -> 'ok').
-spec(delete/3 :: (tx(), rabbit_types:exchange(),
                   [rabbit_types:binding()]) -> 'ok').
-spec(add_binding/3 :: (serial(), rabbit_types:exchange(),
                        rabbit_types:binding()) -> 'ok').
-spec(remove_bindings/3 :: (serial(), rabbit_types:exchange(),
                            [rabbit_types:binding()]) -> 'ok').
-spec(assert_args_equivalence/2 ::
        (rabbit_types:exchange(), rabbit_framing:amqp_table())
        -> 'ok' | rabbit_types:connection_exit()).

-endif.