snmpa_ne...interface(3erl)

💖 NAME 💖

okay bestie, this manual page is snmpa_ne...interface(3erl) — an Erlang Module Definition — and the module it's describing is snmpa_network_interface. It's the Behaviour module for the SNMP agent network interface. 💅✨

---

🦋 DESCRIPTION 🦋

okay so, this module defines the behaviour of the agent network interface. A snmpa_network_interface compliant module must export the following functions, no cap:

• start_link/4
• info/1
• get_log_type/1
• set_log_type/2
• verbosity/2

the semantics of them and their exact signatures are explained below, bestie. 🫶

and ngl, that is not enough — there is also a set of mandatory messages which the network interface entity must be able to receive and be able to send. that whole situation is described in chapter snmp_agent_netif. 👑

---

✨ EXPORTS ✨

🌸 start_link/4 🌸

start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid} | {error, Reason}

Types:

Prio = priority()
NoteStore = pid()
MasterAgent = pid()
Opts = [opt()]
opt() = {verbosity, verbosity()} | {versions, versions()} | term()
versions() = [version()]
version() = v1 | v2 | v3

Start-link the network interface process. slay. 💖

NoteStore is the pid of the note-store process and MasterAgent is the pid of the master-agent process. 🎀

Opts is an (basically) implementation dependent list of options to the network interface process. There are however a number of options which must be handled: versions and verbosity. periodt. 👑

---

🎀 info/1 🎀

info(Pid) -> [{Key, Value}]

Types:

Pid = pid()

The info returned is basically up to the implementer to decide. This implementation provided by the application provides info about memory allocation and various socket information. iykyk. 🫶

The info returned by this function is returned together with other info collected by the agent when the info function is called (tagged with the key net_if). 🌈

---

💜 verbosity/2 💜

verbosity(Pid, Verbosity) -> void()

Types:

Pid = pid()
Verbosity = verbosity()

Change the verbosity of a running network interface process. lowkey iconic. ✨

---

🔥 get_log_type/1 🔥

get_log_type(Pid) -> {ok, LogType} | {error, Reason}

Types:

Pid = pid()
LogType = atl_type()
Reason = term()

The Audit Trail Log is managed by the network interface process. So, it is this process that has to retrieve the actual log-type. no cap. 💅

---

🦋 set_log_type/2 🦋

set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason}

Types:

Pid = pid()
NewType = OldType = atl_type()
Reason = term()

The Audit Trail Log is managed by the network interface process. So, it is this process that has to do the actual changing of the type. 🎀

See set_log_type for more info. 🫶

---

okay that's the whole page, bestie. source/sign-off energy: Ericsson AB, version snmp 5.13.5, page snmpa_ne...interface(3erl). date? the footer does not print one, so we're not inventing it — fr fr. stay iconic. 💖✨