File: snmpa_notification_delivery_info_receiver.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 (84 lines) | stat: -rw-r--r-- 1,819 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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
.TH snmpa_notification_delivery_info_receiver 3 "snmp  4.11" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
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
*
delivery_targets/3
.TP 2
*
delivery_info/4
.RE
.LP
The semantics of them and their exact signatures are explained below\&. 

.SH DATA TYPES

.nf
address() = A 4-tuple
    
.fi
.SH EXPORTS
.LP
.B
delivery_targets(Tag, Targets, Extra) -> void()
.br
.RS
.TP
Types
Tag = term()
.br
Targets = [target()]
.br
target() = {Address, Port}
.br
Address = address()
.br
Port = integer()
.br
Extra = term()
.br
.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
.TP
Types
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
.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