File: snmpa_notification_filter.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (39 lines) | stat: -rw-r--r-- 1,157 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
.TH snmpa_notification_filter 3 "snmp  4.11" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
snmpa_notification_filter \- Behaviour module for the SNMP agent notification filters\&.
.SH DESCRIPTION
.LP
This module defines the behaviour of the agent notification filters\&. A \fIsnmpa_notification_filter\fR compliant module must export the following functions: 
.RS 2
.TP 2
*
handle_notification/2
.RE
.LP
The semantics of them and their exact signatures are explained below\&. 
.LP
The purpose of notification filters is to allow for modification and/or suppression of a notification\&.
.LP
A misbehaving filter will be removed\&.

.SH EXPORTS
.LP
.B
handle_notification(Notif, Data) -> Reply
.br
.RS
.TP
Types
Reply = send | {send, NewNotif} | dont_send
.br
Notif = NewNotif = notification() | trap()
.br
Data = term()
.br
.RE
.RS
.LP
Handle a notification to be sent\&. The filter can either accept the notification as is, return \fIsend\fR, modify the notification, return \fI{send, NewNotif}\fR or suppress the notification, return \fIdont_send\fR\&.
.LP
\fIData\fR is supplied at filter registration time, see register_notification_filter\&. 
.RE