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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
%% 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 https://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 GoPivotal, Inc.
%% Copyright (c) 2018-2020 Pivotal Software, Inc. All rights reserved.
%%
-module(vhost_v1).
-include("vhost.hrl").
-export([new/2,
new/3,
upgrade/1,
upgrade_to/2,
fields/0,
fields/1,
info_keys/0,
field_name/0,
record_version_to_use/0,
pattern_match_all/0,
get_name/1,
get_limits/1,
get_metadata/1,
get_description/1,
get_tags/1,
set_limits/2
]).
-define(record_version, ?MODULE).
%% Represents a vhost.
%%
%% Historically this record had 2 arguments although the 2nd
%% was never used (`dummy`, always undefined). This is because
%% single field records were/are illegal in OTP.
%%
%% As of 3.6.x, the second argument is vhost limits,
%% which is actually used and has the same default.
%% Nonetheless, this required a migration, see rabbit_upgrade_functions.
-record(vhost, {
%% name as a binary
virtual_host :: vhost:name() | '_',
%% proplist of limits configured, if any
limits :: list() | '_'}).
-type vhost() :: vhost_v1().
-type vhost_v1() :: #vhost{
virtual_host :: vhost:name(),
limits :: list()
}.
-export_type([vhost/0,
vhost_v1/0,
vhost_pattern/0,
vhost_v1_pattern/0]).
-spec new(rabbit_vhost:name(), list()) -> vhost().
new(Name, Limits) ->
#vhost{virtual_host = Name, limits = Limits}.
-spec new(rabbit_vhost:name(), list(), map()) -> vhost().
new(Name, Limits, _Metadata) ->
#vhost{virtual_host = Name, limits = Limits}.
-spec record_version_to_use() -> vhost_v1.
record_version_to_use() ->
?record_version.
-spec upgrade(vhost()) -> vhost().
upgrade(#vhost{} = VHost) -> VHost.
-spec upgrade_to(vhost_v1, vhost()) -> vhost().
upgrade_to(?record_version, #vhost{} = VHost) ->
VHost.
fields() -> fields(?record_version).
fields(?record_version) -> record_info(fields, vhost).
field_name() -> #vhost.virtual_host.
info_keys() -> [name, tracing, cluster_state].
-type vhost_pattern() :: vhost_v1_pattern().
-type vhost_v1_pattern() :: #vhost{
virtual_host :: vhost:name() | '_',
limits :: '_'
}.
-spec pattern_match_all() -> vhost_pattern().
pattern_match_all() -> #vhost{_ = '_'}.
get_name(#vhost{virtual_host = Value}) -> Value.
get_limits(#vhost{limits = Value}) -> Value.
get_metadata(_VHost) -> undefined.
get_description(_VHost) -> undefined.
get_tags(_VHost) -> undefined.
set_limits(VHost, Value) ->
VHost#vhost{limits = Value}.
|
