Packages

rabbit_common

3.11.20
4.2.1 4.2.0 retired 4.2.0-rc.1 retired 4.1.6 4.1.5 retired 4.1.5-rc.2 retired 4.1.5-rc.1 4.0.3 4.0.3-rc.1 4.0.2 4.0.2-rc.2 4.0.2-rc.1 4.0.1 4.0.0 4.0.0-rc.2 4.0.0-rc.1 3.13.7 3.13.6 3.13.5 3.13.4 3.13.3 3.13.2 3.13.2-rc.1 3.13.1 3.13.0 3.13.0-rc.6 3.13.0-rc.5 3.13.0-rc.4 3.13.0-rc.3 3.13.0-rc.2 3.13.0-rc.1 3.12.14 3.12.13 3.12.12 3.12.11 3.12.10 3.12.9 3.12.8 3.12.7 3.12.6 3.12.5 3.12.4 3.12.3 3.12.2 3.12.1 3.12.0 3.12.0-rc.4 3.12.0-rc.3 3.12.0-rc.2 3.12.0-rc.1 3.11.28 3.11.27 3.11.26 3.11.25 3.11.24 3.11.23 3.11.22 3.11.21 3.11.20 3.11.19 3.11.18 3.11.17 3.11.16 3.11.15 3.11.14 3.11.13 3.11.12 3.11.11 3.11.10 3.11.9 3.11.8 3.11.7 3.11.6 3.11.5 3.11.4 3.11.3 3.11.2 3.11.1 3.11.0 3.11.0-rc.2 3.11.0-rc.1 3.11.0-1 3.10.25 3.10.24 3.10.23 3.10.22 3.10.21 3.10.20 3.10.19 3.10.18 3.10.17 3.10.16 3.10.15 3.10.14 3.10.13 3.10.12 3.10.11 3.10.10 3.10.9 3.10.8 3.10.7 3.10.6 3.10.5 3.10.4 3.10.3 3.10.2 3.10.1 3.10.0 3.10.0-rc.6 3.10.0-rc.5 3.9.29 3.9.28 3.9.27 3.9.26 3.9.25 3.9.24 3.9.23 3.9.22 3.9.21 3.9.20 3.9.19 3.9.18 3.9.17 3.9.16 3.9.15 3.9.11 3.9.10 3.9.9 3.9.8 3.9.7 3.9.6 3.9.5 3.9.4 3.9.3 3.9.2 3.9.1 3.8.35 3.8.34 3.8.33 3.8.32 3.8.31 3.8.30 3.8.26 3.8.25 3.8.24 3.8.23 3.8.22 3.8.21 3.8.20 3.8.19 3.8.14 3.8.12-rc.3 3.8.12-rc.2 3.8.12-rc.1 3.8.11 3.8.10 3.8.10-rc.6 3.8.10-rc.5 3.8.10-rc.1 3.8.9 3.8.8 3.8.7 3.8.6 3.8.6-rc.2 3.8.6-rc.1 3.8.5 3.8.5-rc.2 3.8.5-rc.1 3.8.4 3.8.4-rc.3 3.8.4-rc.1 3.8.3 3.8.3-rc.2 3.8.3-rc.1 3.8.2 3.8.2-rc.1 3.8.1 3.8.1-rc.1 3.8.0 3.8.0-rc.3 3.8.0-rc.2 3.8.0-rc.1 3.7.28 3.7.27 3.7.27-rc.2 3.7.27-rc.1 3.7.26 3.7.25 3.7.25-rc.1 3.7.24 3.7.24-rc.2 3.7.24-rc.1 3.7.23 3.7.23-rc.1 3.7.22 3.7.22-rc.2 3.7.22-rc.1 3.7.21 3.7.20 3.7.20-rc.2 3.7.20-rc.1 3.7.19 3.7.18 3.7.18-rc.1 3.7.17 3.7.17-rc.3 3.7.17-rc.2 3.7.17-rc.1 retired 3.7.16 retired 3.7.16-rc.4 retired 3.7.16-rc.3 retired 3.7.16-rc.2 retired 3.7.16-rc.1 retired 3.7.16-beta.1 3.7.15 3.7.14 3.7.14-rc.2 3.7.14-rc.1 3.7.13 3.7.13-rc.2 3.7.13-rc.1 3.7.12 3.7.12-rc.2 3.7.12-rc.1 3.7.11 3.7.11-rc.2 3.7.11-rc.1 3.7.10-rc.4 3.7.10-rc.3 3.7.10-rc.2 3.7.10-rc.1 3.7.9 3.7.9-rc.3 3.7.9-rc.2 3.7.8 3.7.8-rc.4 3.7.8-rc.3 3.7.8-rc.2 3.7.8-rc.1 3.7.7 3.7.7-rc.2 3.7.7-rc.1 3.7.6 3.7.6-rc.2 3.7.6-rc.1 3.7.5 3.7.5-rc.1 3.7.4 3.7.4-rc.4 3.7.4-rc.3 3.7.4-rc.2 3.7.4-rc.1 3.7.3 3.7.3-rc.2 3.7.3-rc.1 3.7.2 3.7.1 3.7.0-rc.2 3.7.0-alpha.544 3.7.0-alpha.542 3.6.16 3.6.16-rc.1 3.6.15 3.6.15-rc.1 3.6.14 3.6.13 3.6.12 3.6.11 3.6.10 3.6.9 3.6.8 3.6.7 3.6.7-pre.1 3.5.6 3.5.0 3.4.0 3.3.5 3.0.2 0.0.0-rc.1

Modules shared by rabbitmq-server and rabbitmq-erlang-client

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
279 Versions
3 Dependencies
4 Dependants
4 Advisories
Files
Activity
rabbit_common src rabbit_types.erl
Raw

src/rabbit_types.erl 

%% This Source Code Form is subject to the terms of the Mozilla Public

%% License, v. 2.0. If a copy of the MPL was not distributed with this

%% file, You can obtain one at https://mozilla.org/MPL/2.0/.

%%

%% Copyright (c) 2007-2023 VMware, Inc. or its affiliates.  All rights reserved.

%%



-module(rabbit_types).



-include("rabbit.hrl").



-export_type([maybe/1, info/0, infos/0, info_key/0, info_keys/0,

              message/0, msg_id/0, basic_message/0,

              delivery/0, content/0, decoded_content/0, undecoded_content/0,

              unencoded_content/0, encoded_content/0, message_properties/0,

              vhost/0, ctag/0, amqp_error/0, r/1, r2/2, r3/3, listener/0,

              binding/0, binding_source/0, binding_destination/0,

              exchange/0,

              connection/0, connection_name/0, channel/0, channel_name/0,

              protocol/0, auth_user/0, user/0,

              username/0, password/0, password_hash/0,

              ok/1, error/1, error/2, ok_or_error/1, ok_or_error2/2, ok_pid_or_error/0,

              channel_exit/0, connection_exit/0, mfargs/0, proc_name/0,

              proc_type_and_name/0, timestamp/0, tracked_connection_id/0,

              tracked_connection/0, tracked_channel_id/0, tracked_channel/0,

              node_type/0, topic_access_context/0,

              authz_data/0, authz_context/0,

              permission_atom/0, rabbit_amqqueue_name/0, binding_key/0, channel_number/0,

              exchange_name/0, exchange_type/0, guid/0, routing_key/0]).



-type(maybe(T) :: T | 'none').

-type(timestamp() :: {non_neg_integer(), non_neg_integer(), non_neg_integer()}).



-type(vhost() :: binary()).

-type(ctag() :: 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            :: rabbit_framing:amqp_property_record(),

                 properties_bin        :: 'none',

                 payload_fragments_rev :: [binary()]}).

-type(unencoded_content() :: undecoded_content()).

-type(decoded_content() ::

        #content{class_id              :: rabbit_framing:amqp_class_id(),

                 properties            :: rabbit_framing:amqp_property_record(),

                 properties_bin        :: maybe(binary()),

                 payload_fragments_rev :: [binary()]}).

-type(encoded_content() ::

        #content{class_id       :: rabbit_framing:amqp_class_id(),

                 properties     :: maybe(rabbit_framing:amqp_property_record()),

                 properties_bin        :: binary(),

                 payload_fragments_rev :: [binary()]}).

-type(content() :: undecoded_content() | decoded_content()).



-type(guid() :: binary()).

-type(msg_id() :: guid()).

-type(routing_key() :: binary()).

-type(basic_message() ::

        #basic_message{exchange_name  :: exchange_name(),

                       routing_keys   :: [routing_key()],

                       content        :: content(),

                       id             :: msg_id(),

                       is_persistent  :: boolean()}).

-type(message() :: basic_message()).

-type(delivery() ::

        #delivery{mandatory :: boolean(),

                  sender    :: pid(),

                  message   :: message()}).

-type(message_properties() ::

        #message_properties{expiry :: pos_integer() | 'undefined',

                            needs_confirming :: boolean()}).



-type(info_key() :: atom()).

-type(info_keys() :: [info_key()]).



-type(info() :: {info_key(), any()}).

-type(infos() :: [info()]).



-type(amqp_error() ::

        #amqp_error{name        :: rabbit_framing:amqp_exception(),

                    explanation :: string(),

                    method      :: rabbit_framing:amqp_method_name()}).



-type(r(Kind) ::

        r2(vhost(), Kind)).

-type(r2(VirtualHost, Kind) ::

        r3(VirtualHost, Kind, rabbit_misc:resource_name())).

-type(r3(VirtualHost, Kind, Name) ::

        #resource{virtual_host :: VirtualHost,

                  kind         :: Kind,

                  name         :: Name}).



-type(listener() ::

        #listener{node     :: node(),

                  protocol :: atom(),

                  host     :: rabbit_net:hostname(),

                  port     :: rabbit_net:ip_port()}).



-type rabbit_amqqueue_name() :: rabbit_types:r('queue').



-type(binding_source() :: exchange_name()).

-type(binding_destination() :: rabbit_amqqueue_name() | exchange_name()).



-type binding_key() :: binary().



-type(binding() ::

        #binding{source      :: exchange_name(),

                 destination :: binding_destination(),

                 key         :: binding_key(),

                 args        :: rabbit_framing:amqp_table()}).



-type(exchange() ::

        #exchange{name        :: exchange_name(),

                  type        :: exchange_type(),

                  durable     :: boolean(),

                  auto_delete :: boolean(),

                  arguments   :: rabbit_framing:amqp_table()}).



-type exchange_name() :: r('exchange').

-type exchange_type() :: atom().



-type(connection_name() :: binary()).



%% used e.g. by rabbit_networking

-type(connection() :: pid()).



%% used e.g. by rabbit_connection_tracking

-type(tracked_connection_id() :: {node(), connection_name()}).



-type(tracked_connection() ::

        #tracked_connection{id           :: tracked_connection_id(),

                            node         :: node(),

                            vhost        :: vhost(),

                            name         :: connection_name(),

                            pid          :: connection(),

                            protocol     :: protocol_name(),

                            peer_host    :: rabbit_net:hostname(),

                            peer_port    :: rabbit_net:ip_port(),

                            username     :: username(),

                            connected_at :: integer()}).



-type(channel_name() :: binary()).



-type(channel() :: pid()).



-type(channel_number() :: non_neg_integer()).



%% used e.g. by rabbit_channel_tracking

-type(tracked_channel_id() :: {node(), channel_name()}).



-type(tracked_channel() ::

        #tracked_channel{ id          :: tracked_channel_id(),

                          node        :: node(),

                          vhost       :: vhost(),

                          name        :: channel_name(),

                          pid         :: channel(),

                          username    :: username(),

                          connection  :: connection()}).



%% old AMQP 0-9-1-centric type, avoid when possible

-type(protocol() :: rabbit_framing:protocol()).



-type(protocol_name() :: 'amqp0_8' | 'amqp0_9_1' | 'amqp1_0' | 'mqtt' | 'stomp' | any()).



-type(node_type() :: 'disc' | 'ram').



-type(auth_user() ::

        #auth_user{username :: username(),

                   tags     :: [atom()],

                   impl     :: any()}).



-type(authz_data() ::

        #{peeraddr := inet:ip_address() | binary(),

          _ => _      } | undefined).



-type(user() ::

        #user{username       :: username(),

              tags           :: [atom()],

              authz_backends :: [{atom(), any()}]}).



-type(username() :: binary()).

-type(password() :: binary()).

-type(password_hash() :: binary()).



-type(ok(A) :: {'ok', A}).

-type(error(A) :: {'error', A}).

-type(error(A, B) :: {'error', A, B}).

-type(ok_or_error(A) :: 'ok' | error(A)).

-type(ok_or_error2(A, B) :: ok(A) | error(B)).

-type(ok_pid_or_error() :: ok_or_error2(pid(), any())).



-type(channel_exit() :: no_return()).

-type(connection_exit() :: no_return()).



-type(mfargs() :: {atom(), atom(), [any()]}).



-type(proc_name() :: term()).

-type(proc_type_and_name() :: {atom(), proc_name()}).



-type(topic_access_context() :: #{routing_key  => routing_key(),

                                  variable_map => map(),

                                  _ => _}).



-type(authz_context() :: map()).



-type(permission_atom() :: 'configure' | 'write' | 'read').