2008 2009 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. The Initial Developer of the Original Code is Ericsson AB. snmpa_notification_delivery_info_receiver snmpa_notification_delivery_info_receiver.xml
snmpa_notification_delivery_info_receiver Behaviour module for the SNMP agent notification delivery information receiver.

This module defines the behaviour of the notification delivery information receiver.

A snmpa_notification_delivery_info_receiver compliant module must export the following functions:

delivery_targets/3

delivery_info/4

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

DATA TYPES
delivery_targets(Tag, Targets, Extra) -> void() Inform about target addresses Tag = term() Targets = [target()] target() = {Address, Port} Address = address() Port = integer() Extra = term()

Inform about target addresses.

This is the first function called when a notification delivery is in progress. It informs the receiver which targets will get the notification. The result of the delivery will be provided via successive calls to delivery_info/4 function, see below.

 delivery_info(Tag, Target, DeliveryResult, Extra) -> void() Inform about delivery result Tag = term() Target = target() target() = {Address, Port} Address = address() Port = integer() DeliveryResult = delivery_result() delivery_result() = no_response | got_response Extra = term()

Inform about delivery result.

This function is called for each target in the Targets argument of the delivery_targets/3 function, see above.

The purpose is to inform the receiver of the result of the delivery (was the notification acknowledged or not) for each target.