From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/snmp/doc/src/snmpm_network_interface.xml | 252 +++++++++++++++++++++++++++ 1 file changed, 252 insertions(+) create mode 100644 lib/snmp/doc/src/snmpm_network_interface.xml (limited to 'lib/snmp/doc/src/snmpm_network_interface.xml') diff --git a/lib/snmp/doc/src/snmpm_network_interface.xml b/lib/snmp/doc/src/snmpm_network_interface.xml new file mode 100644 index 0000000000..33eb736b8f --- /dev/null +++ b/lib/snmp/doc/src/snmpm_network_interface.xml @@ -0,0 +1,252 @@ + + + + +
+ + 20042009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + snmpm_network_interface + + + + + + + + snmpm_network_interface.xml +
+ snmpm_network_interface + Behaviour module for the SNMP manager network interface. + +

This module defines the behaviour of the manager network + interface. A snmpm_network_interface compliant module + must export the following functions:

+ + +

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 are explained + below.

+ + + + + + + start_link(Server, NoteStore) -> {ok, Pid} | {error, Reason} + Start-link the network interface process + + Server = pid() + NoteStore = pid() + + +

Start-link the network interface process.

+

Server is the pid of the managing process.

+

NoteStore is the pid of the note-store process.

+ + + + + + + stop(Pid) -> void() + Stop the network interface process + + Pid = pid() + + +

Stop the network interface process.

+ + + + + + + send_pdu(Pid, Pdu, Vsn, MsgData, Addr, Port, ExtraInfo) -> void() + Request the network interface process to send this pdu + + Pid = pid() + Pdu = pdu() + Vsn = 'version-1' | 'version-2' | 'version-3' + MsgData = term() + Addr = address() + Port = integer() + ExtraInfo = term() + + +

Request the network interface process (Pid) to send + this pdu (Pdu).

+

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.

+ + + + + + + inform_response(Pid, Ref, Addr, Port) -> void() + Send the inform-request ack + + Pid = pid() + Ref = term() + Addr = address() + Port = integer() + + +

Instruct the network interface process to send the response + (acknowledgment) to an inform-request.

+

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.

+ + + + + + + note_store(Pid, NoteStore) -> void() + Change the verbosity of the network interface process + + Pid = pid() + NoteStore = pid() + + +

Change the pid of the note-store process. + This is used when the server re-starts the note_store + (e.g. after a crach).

+ + + + + + + info(Pid) -> [{Key, Value}] + Return information about the running network interface process + + Pid = 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 + info function is called + (tagged with the key net_if).

+ + + + + + + verbosity(Pid, Verbosity) -> void() + Change the verbosity of the network interface process + + Pid = pid() + Verbosity = verbosity() + + +

Change the verbosity of the network interface process.

+ + + + + + + get_log_type(Pid) -> {ok, LogType} | {error, Reason} + Get the Audit Trail Log type + + 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 return the actual log-type.

+ + + + + + + + set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} + Change the Audit Trail Log type + + 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.

+ + + + + + + + -- cgit v1.2.3