View Source snmpm_mpd (snmp v5.15)
Message Processing and Dispatch module for the SNMP manager
The module snmpm_mpd
implements the version independent Message Processing and
Dispatch functionality in SNMP for the manager. It is supposed to be used from a
Network Interface process
(Definition of Manager Net if).
Legacy API function process_msg/7
that has got separate IpAddr
and
PortNumber
arguments still works as before for backwards compatibility
reasons.
Summary
Functions
generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason}
generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason}
init(Vsns) -> mpd_state()
process_msg(Msg, Domain, Addr, State, NoteStore, Logger) -> {ok, Vsn, Pdu, PduMS, MsgData} | {discarded, Reason}
Functions
generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason}
Generates a possibly encrypted packet to be sent to the network.
NoteStore
is the pid/0
of the note-store process.
MsgData
is the message specific data used in the SNMP message. In SNMPv1 and
SNMPv2c, this message data is the community string. In SNMPv3, it is the context
information.
Logger
is the function used for audit trail logging.
generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason}
Generates a possibly encrypted response packet to be sent to the network.
MsgData
is the message specific data used in the SNMP message. This value is
received from the process_msg function.
init(Vsns) -> mpd_state()
This function can be called from the net_if process at start-up. The options list defines which versions to use.
process_msg(Msg, Domain, Addr, State, NoteStore, Logger)
View Source (since OTP 17.3)process_msg(Msg, Domain, Addr, State, NoteStore, Logger) -> {ok, Vsn, Pdu, PduMS, MsgData} | {discarded, Reason}
Processes an incoming message. Performs authentication and decryption as necessary. The return values should be passed the manager server.
NoteStore
is the pid/0
of the note-store process.
Logger
is the function used for audit trail logging.
In the case when the pdu type is report
, MsgData
is either ok
or
{error, ReqId, Reason}
.