1snmpa_network_interface(3) Erlang Module Definition snmpa_network_interface(3)
2
3
4

NAME

6       snmpa_network_interface  -  Behaviour module for the SNMP agent network
7       interface.
8

DESCRIPTION

10       This module defines the behaviour of the agent network interface. A sn‐
11       mpa_network_interface  compliant module must export the following func‐
12       tions:
13
14         * start_link/4
15
16         * info/1
17
18         * get_log_type/1
19
20         * set_log_type/2
21
22         * verbosity/2
23
24       The semantics of them and their exact signatures are explained below.
25
26       But this is not enough. There is also a set of mandatory messages which
27       the  network  interface  entity  must be able to receive and be able to
28       send. This is described in chapter snmp_agent_netif.
29

EXPORTS

31       start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid}  |  {error,
32       Reason}
33
34              Types:
35
36                 Prio = priority()
37                 NoteStore = pid()
38                 MasterAgent = pid()
39                 Opts = [opt()]
40                 opt()  =  {verbosity, verbosity()} | {versions, versions()} |
41                 term()
42                 versions() = [version()]
43                 version() = v1 | v2 | v3
44
45              Start-link the network interface process.
46
47              NoteStore is the pid of the note-store process  and  MasterAgent
48              is the pid of the master-agent process.
49
50              Opts  is an (basically) implementation dependent list of options
51              to the network interface process. There are however a number  of
52              options which must be handled: versions and verbosity.
53
54       info(Pid) -> [{Key, Value}]
55
56              Types:
57
58                 Pid = pid()
59
60              The  info returned is basically up to the implementer to decide.
61              This implementation provided by the  application  provides  info
62              about memory allocation and various socket information.
63
64              The  info  returned  by  this function is returned together with
65              other info collected by the agent  when  the  info  function  is
66              called (tagged with with the key net_if).
67
68       verbosity(Pid, Verbosity) -> void()
69
70              Types:
71
72                 Pid = pid()
73                 Verbosity = verbosity()
74
75              Change the verbosity of a running network interface process.
76
77       get_log_type(Pid) -> {ok, LogType} | {error, Reason}
78
79              Types:
80
81                 Pid = pid()
82                 LogType = atl_type()
83                 Reason = term()
84
85              The Audit Trail Log is managed by the network interface process.
86              So, it is this process that has to retrieve the actual log-type.
87
88       set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason}
89
90              Types:
91
92                 Pid = pid()
93                 NewType = OldType = atl_type()
94                 Reason = term()
95
96              The Audit Trail Log is managed by the network interface process.
97              So, it is this process that has to do the actual changing of the
98              type.
99
100              See set_log_type for more info.
101
102
103
104Ericsson AB                        snmp 5.12        snmpa_network_interface(3)