EVOLUTION-MANAGER

Edit File: snmpa_notification_delivery_info_receiver.3

.TH snmpa_notification_delivery_info_receiver 3 "snmp 4.25" "Ericsson AB" "Erlang Module Definition"
.SH NAME
snmpa_notification_delivery_info_receiver \- 
    Behaviour module for the SNMP agent notification delivery 
    information receiver.
  
.SH DESCRIPTION
.LP
This module defines the behaviour of the notification delivery information receiver\&.
.LP
A \fIsnmpa_notification_delivery_info_receiver\fR\& compliant module must export the following functions:
.RS 2
.TP 2
*
\fBdelivery_targets/3\fR\&
.LP
.TP 2
*
\fBdelivery_info/4\fR\&
.LP
.RE

.LP
The semantics of them and their exact signatures are explained below\&.
.SH "DATA TYPES"

.LP
.nf

address() = A 4-tuple
    
.fi
.SH EXPORTS
.LP
.B
delivery_targets(Tag, Targets, Extra) -> void()
.br
.RS
.LP
Types:

.RS 3
Tag = term()
.br
Targets = [target()]
.br
target() = {Address, Port}
.br
Address = address()
.br
Port = integer()
.br
Extra = term()
.br
.RE
.RE
.RS
.LP
Inform about target addresses\&.
.LP
This is the first function called when a notification delivery is in progress\&. It informs the \fIreceiver\fR\& which targets will get the notification\&. The result of the delivery will be provided via successive calls to \fIdelivery_info/4\fR\& function, see below\&.
.RE
.LP
.B
delivery_info(Tag, Target, DeliveryResult, Extra) -> void()
.br
.RS
.LP
Types:

.RS 3
Tag = term()
.br
Target = target()
.br
target() = {Address, Port}
.br
Address = address()
.br
Port = integer()
.br
DeliveryResult = delivery_result()
.br
delivery_result() = no_response | got_response
.br
Extra = term()
.br
.RE
.RE
.RS
.LP
Inform about delivery result\&.
.LP
This function is called for each target in the \fITargets\fR\& argument of the \fIdelivery_targets/3\fR\& function, see above\&.
.LP
The purpose is to inform the \fIreceiver\fR\& of the result of the delivery (was the notification acknowledged or not) for each target\&.
.RE