Erlang -- snmpa_notification_filter

# snmpa_notification_filter

###
Module

snmpa_notification_filter

###
Module Summary

Behaviour module for the SNMP agent notification filters.

###
Description

This module defines the behaviour of the agent notification filters. A snmpa_notification_filter compliant module must export the following functions:

- handle_notification/2

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

The purpose of notification filters is to allow for modification and/or suppression of a notification.

A misbehaving filter will be removed.

###
Exports

####
handle_notification(Notif, Data) -> Reply

### Types

Reply = send | {send, NewNotif} | dont_send
Notif = NewNotif = notification() | trap()
Data = term()

Handle a notification to be sent. The filter can either accept the notification as is, return send, modify the notification, return {send, NewNotif} or suppress the notification, return dont_send.

Data is supplied at filter registration time, see register_notification_filter.