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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 1996-2013. All Rights Reserved.
%%
%% The contents of this file are subject to the Erlang Public License,
%% Version 1.1, (the "License"); you may not use this file except in
%% compliance with the License. You should have received a copy of the
%% Erlang Public License along with this software. If not, it can be
%% retrieved online at http://www.erlang.org/.
%%
%% 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.
%%
%% %CopyrightEnd%
%%
-module(snmpa_mib_data).
-include_lib("snmp/include/snmp_types.hrl").
%%%-----------------------------------------------------------------
%%% This is the behaviour for the MIB server backend internal
%%% data storage.
%%%-----------------------------------------------------------------
%% These types should really be defined elsewhere...
-export_type([
oid/0,
mib_storage/0,
mib_storage_dir/0,
mib_storage_action/0,
mib_view/0,
mib_view_elem/0,
mib_view_mask/0,
mib_view_inclusion/0
]).
-type oid() :: [non_neg_integer()].
-type mib_storage() :: ets |
{ets, Dir :: mib_storage_dir()} |
{ets, Dir :: mib_storage_dir(), Action :: mib_storage_action()} |
dets |
{dets, Dir :: mib_storage_dir()} |
{dets, Dir :: mib_storage_dir(), Action :: mib_storage_action()} |
mnesia |
{mnesia, Nodes :: [node()]} |
{mnesia, Nodes :: [node()],
Action :: mib_storage_action()}.
-type mib_storage_dir() :: default | string().
-type mib_storage_action() :: clear | keep.
-type mib_view() :: [mib_view_elem()].
-type mib_view_elem() :: {SubTree :: oid(),
Mask :: [non_neg_integer()],
Inclusion :: mib_view_inclusion()}.
-type mib_view_mask() :: [non_neg_integer()].
-type mib_view_inclusion() :: 1 | 2. % 1 = included, 2 = excluded
-type me() :: #me{}.
-type filename() :: file:filename().
-callback new(MibStorage :: mib_storage()) -> State :: term().
-callback close(State :: term()) -> ok.
-callback sync(State :: term()) -> ok.
-callback load_mib(State :: term(), FileName :: string(),
MeOverride :: boolean(),
TeOverride :: boolean()) ->
{ok, NewState :: term()} | {error, Reason :: already_loaded | term()}.
-callback unload_mib(State :: term(), FileName :: string(),
MeOverride :: boolean(),
TeOverride :: boolean()) ->
{ok, NewState :: term()} | {error, Reason :: not_loaded | term()}.
-callback lookup(State :: term(), Oid :: oid()) ->
{false, Reason :: term()} |
{variable, MibEntry :: me()} |
{table_column, MibEntry :: me(), TableEntryOid :: oid()} |
{subagent, SubAgentPid :: pid(), SAOid :: oid()}.
-callback next(State :: term(), Oid :: oid(), MibView :: mib_view()) ->
endOfView | false |
{subagent, SubAgentPid :: pid(), SAOid :: oid()} |
{variable, MibEntry :: me(), VarOid :: oid()} |
{table, TableOid :: oid(), TableRestOid :: oid(), MibEntry :: me()}.
-callback register_subagent(State :: term(), Oid :: oid(), Pid :: pid()) ->
{ok, NewState :: term()} | {error, Reason :: term()}.
-callback unregister_subagent(State :: term(),
PidOrOid :: pid() | oid()) ->
{ok, NewState :: term()} | % When second arg was a pid()
{ok, NewState :: term(), Pid :: pid()} | % When second arg was a oid()
{error, Reason :: term()}.
-callback dump(State :: term(), Destination :: io | filename()) ->
ok | {error, Reason :: term()}.
-callback which_mib(State :: term(), Oid :: oid()) ->
{ok, Mib :: string()} | {error, Reason :: term()}.
-callback which_mibs(State :: term()) ->
[{MibName :: atom(), Filename :: string()}].
-callback whereis_mib(State :: term(), MibName :: atom()) ->
{ok, Filename :: string()} | {error, Reason :: term()}.
-callback info(State :: term()) -> list().
-callback backup(State :: term(), BackupDir :: string()) ->
ok | {error, Reason :: term()}.
-callback code_change(Direction :: up | down,
Vsn :: term(),
Extra :: term(),
State :: term()) ->
NewState :: term().
|
