snmpm_network_interface(3)

📦
version 29.0.6 · 3 versions
, in ubuntu stonking

snmpm_network_interface(3) 🫶✨

Erlang Module Definition

NAME 💖

snmpm_network_interface — the behaviour module for the SNMP manager network interface, bestie. That's literally the whole vibe.

DESCRIPTION 🌸

Okay so this module defines the behaviour of the manager network interface. If you're making a snmpm_network_interface compliant module, you must export these functions, no skips:

  • start_link/2
  • stop/1
  • send_pdu/7
  • inform_response/4
  • note_store/2
  • info/1
  • get_log_type/1
  • set_log_type/2
  • verbosity/2

The semantics of them and their exact signatures? Explained below, periodt. 💅

Also legacy API function send_pdu/7 that has got separate IpAddr and PortNumber arguments still works as before for backwards compatibility reasons. So if you see the old split-args version, it's not broken, it's just legacy and still slaying. 🕰️

CALLBACKS 🦋

get_log_type(Pid) 💖

The Audit Trail Log is managed by the network interface process. So, it is this process that has to return the actual log-type. Like, it's the only one who knows, okay? 🫶

info(Pid) ✨

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

The info returned by this function is returned together with other info collected by the manager when the snmpm:info() function is called (tagged with the key net_if). So when you call snmpm:info(), look for the net_if key, bestie. 🔍

inform_response(Pid, Ref, Addr, Port) 🔥

Instruct the network interface process to send the response (acknowledgment) to an inform-request. It's like replying "k I got it" in the group chat. 💬

Ref is something that can be used to identify the inform-request, e.g. request-id of the inform-request.

Addr and Port identifies the agent, from which the inform-request originated. So you know who slid into your DMs. 📬

note_store(Pid, NoteStore) 🎀

Change the pid of the note-store process. This is used when the server restarts the note-store (e.g. after a crach — yes, that's their spelling, not mine, but we keep it exactly 💅).

send_pdu(Pid, Pdu, Vsn, MsgData, Domain, Addr, ExtraInfo) 🚀

Request the network interface process (Pid) to send this pdu (Pdu). Go little pdu, go! 🕊️

ExtraInfo is some opaque data that is passed to the net-if process. It originates from the ExtraInfo parameter in the calls to the synchronous get-request, asynchronous get-request, synchronous get-next-request, asynchronous get-next-request, synchronous set-request and asynchronous set-request functions. Whether the net-if process chooses to use this is implementation dependent. The net-if process included in this application ignores it. So yeah, it's just vibing there, ignored. 🙈

set_log_type(Pid, NewType) 🌈

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. You want a different log type? Talk to the net-if process, not me. 💁

See snmpm:set_log_type/1 for more info.

Start-link the network interface process. It's giving main character energy, obviously.

Server is the pid of the managing process.

NoteStore is the pid of the note-store process.

stop(Pid) 💀

Stop the network interface process. Bye bestie, it was real. 👋

verbosity(Pid, Verbosity) 🗣️

Change the verbosity of the network interface process. Whether you want it quiet or screaming, this is how. 📢

Ericsson AB made this, version snmp 5.20.5, and the page is snmpm_network_interface(3) — that's the footer, no cap. Have fun exporting those callbacks, bestie! 💖✨🦋

📦 where this page comes from