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
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2004-2014. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
-module(snmpm_user).
-export_type([
snmp_gen_info/0,
snmp_v1_trap_info/0
]).
-type snmp_gen_info() :: {ErrorStatus :: atom(),
ErrorIndex :: pos_integer(),
Varbinds :: [snmp:varbind()]}.
-type snmp_v1_trap_info() :: {Enteprise :: snmp:oid(),
Generic :: integer(),
Spec :: integer(),
Timestamp :: integer(),
Varbinds :: [snmp:varbind()]}.
-type ip_address() :: inet:ip_address().
-type port_number() :: inet:port_number().
%% *** handle_error ***
%% An "asynchronous" error has been detected
-callback handle_error(
ReqId :: integer(),
Reason :: {unexpected_pdu, SnmpInfo :: snmp_gen_info()} |
{invalid_sec_info,
SecInfo :: term(),
SnmpInfo :: snmp_gen_info()} |
{empty_message,
TransportDomain :: atom(),
{Addr :: ip_address(), Port :: port_number()}} |
term(),
UserData :: term()) ->
snmp:void().
%% *** handle_agent ***
%% A message was received from an unknown agent
-callback handle_agent(Domain :: atom(),
Address :: term(),
Type :: pdu | trap | inform | report,
SnmpInfo :: snmp_gen_info() | snmp_v1_trap_info(),
UserData :: term()) ->
Reply :: ignore |
{register,
UserId :: term(),
RTargetName :: snmpm:target_name(),
AgentConfig :: [snmpm:agent_config()]}.
%% *** handle_pdu ***
%% Handle the reply to an async request (such as get, get-next and set).
-callback handle_pdu(TargetName :: snmpm:target_name(),
ReqId :: term(),
SnmpResponse :: snmp_gen_info(),
UserData :: term()) ->
snmp:void().
%% *** handle_trap ***
%% Handle a trap/notification message received from an agent
-callback handle_trap(TargetName :: snmpm:target_name(),
SnmpTrapInfo :: snmp_gen_info() | snmp_v1_trap_info(),
UserData :: term()) ->
Reply :: ignore |
unregister |
{register,
UserId :: term(),
RTargetName :: snmpm:target_name(),
AgentConfig :: [snmpm:agent_config()]}.
%% *** handle_inform ***
%% Handle a inform message received from an agent
-callback handle_inform(TargetName :: snmpm:target_name(),
SnmpInform :: snmp_gen_info(),
UserData :: term()) ->
Reply :: ignore | no_reply |
unregister |
{register,
UserId :: term(),
RTargetName :: snmpm:target_name(),
AgentConfig :: [snmpm:agent_config()]}.
%% *** handle_report ***
%% Handle a report message received from an agent
-callback handle_report(TargetName :: snmpm:target_name(),
SnmpReport :: snmp_gen_info(),
UserData :: term()) ->
Reply :: ignore |
unregister |
{register,
UserId :: term(),
RTargetName :: snmpm:target_name(),
AgentConfig :: [snmpm:agent_config()]}.
|
