# snmpa_network_interface

### MODULE

snmpa_network_interface

### MODULE SUMMARY

Behaviour module for the SNMP agent network interface.

### DESCRIPTION

This module defines the behaviour of the agent network interface. A `snmpa_network_interface` compliant module must export the following functions:

- start_link/4
- info/1
- verbosity/2

The semantics of them and their exact signatures are explained below.

But this 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. This is described in chapter snmp_agent_netif.

### EXPORTS

`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.

`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`.

`verbosity(Pid, Verbosity) -> void()`

Types:

`Pid = pid()`
`Verbosity = verbosity()`

Change the verbosity of a running network interface process.

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

Types:

`Pid = pid()`

The info returned is basically up to the implementor to decide. This implemention provided by the 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 agent when the info function is called (tagged with with the key `net_if`).

### AUTHORS

Micael Karlberg - support@erlang.ericsson.se

snmp 4.8.2
Copyright © 1991-2006 Ericsson AB