diff options
Diffstat (limited to 'lib/snmp/doc/src/snmpa_notification_filter.xml')
-rw-r--r-- | lib/snmp/doc/src/snmpa_notification_filter.xml | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/lib/snmp/doc/src/snmpa_notification_filter.xml b/lib/snmp/doc/src/snmpa_notification_filter.xml new file mode 100644 index 0000000000..c3b300ecab --- /dev/null +++ b/lib/snmp/doc/src/snmpa_notification_filter.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2004</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>snmpa_notification_filter</title> + <prepared></prepared> + <responsible></responsible> + <docno></docno> + <approved></approved> + <checked></checked> + <date></date> + <rev></rev> + <file>snmpa_notification_filter.xml</file> + </header> + <module>snmpa_notification_filter</module> + <modulesummary>Behaviour module for the SNMP agent notification filters.</modulesummary> + <description> + <p>This module defines the behaviour of the agent notification + filters. A <c>snmpa_notification_filter</c> compliant module + must export the following functions: </p> + <list type="bulleted"> + <item> + <p>handle_notification/2</p> + </item> + </list> + <p>The semantics of them and their exact signatures are explained + below. </p> + <p>The purpose of notification filters is to allow for modification + and/or suppression of a notification.</p> + <p>A misbehaving filter will be removed.</p> + </description> + <funcs> + <func> + <name>handle_notification(Notif, Data) -> Reply</name> + <fsummary>Handle a notification</fsummary> + <type> + <v>Reply = send | {send, NewNotif} | dont_send</v> + <v>Notif = NewNotif = notification() | trap()</v> + <v>Data = term()</v> + </type> + <desc> + <p>Handle a notification to be sent. The filter can either + accept the notification as is, return <c>send</c>, modify + the notification, return <c>{send, NewNotif}</c> or + suppress the notification, return <c>dont_send</c>.</p> + <p><c>Data</c> is supplied at filter registration time, + see <seealso marker="snmpa#register_notification_filter">register_notification_filter</seealso>. + </p> + </desc> + </func> + </funcs> + +</erlref> + |