-
Notifications
You must be signed in to change notification settings - Fork 1
/
snmpa_notification_delivery_info_receiver.html
168 lines (115 loc) · 4.89 KB
/
snmpa_notification_delivery_info_receiver.html
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>snmpa_notification_delivery_info_receiver</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="css/main.css" type="text/css" media="screen" />
<script src="js/main.js" type="text/javascript" charset="utf-8"></script>
</head>
<body>
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'>
<tr>
<td class="file-title"><span class="file-title-prefix">Module</span><br />snmpa_notification_delivery_info_receiver</td>
<td align="right">
</td>
</tr>
</table>
<div id="bodyContent">
<div id="content">
<div class="description">
<p>This module defines the behaviour of the notification
delivery information receiver. </p>
<p>A <tt>snmpa_notification_delivery_info_receiver</tt> compliant module
must export the following functions: </p>
<list type="bulleted">
<item>
<p><seealso marker="#delivery_targets">delivery_targets/3</seealso></p>
</item>
<item>
<p><seealso marker="#delivery_info">delivery_info/4</seealso></p>
</item>
</list>
<p>The semantics of them and their exact signatures are explained
below. </p>
</div>
<div class="sectiontitle">Contents</div>
<ul>
<li><a href="#">DATA TYPES</a></li>
</ul>
<div class="sectiontitle">Functions</div>
<ul>
<li><a href="#delivery_infoTagTargetDeliveryResultExtragtvoid">delivery_info(Tag, Target, DeliveryResult, Extra) -> void()</a></li>
<li><a href="#delivery_targetsTagTargetsExtragtvoid">delivery_targets(Tag, Targets, Extra) -> void()</a></li>
</ul>
<div class="sectiontitle">DATA TYPES</div>
<div class="description">
<title>DATA TYPES</title>
<pre><![CDATA[
address() = A 4-tuple
]]></pre>
<marker id="delivery_targets"/>
</div>
<div class="sectiontitle">Exports</div>
<div class="method">
<div class="title">
<a name="delivery_targetsTagTargetsExtragtvoid"></a><b>delivery_targets(Tag, Targets, Extra) -> void()</b>
</div>
<div class="func_types">
Types:
<p>
<b>Tag = term()</b><br/>
<b>Targets = [target()]</b><br/>
<b>target() = {Address, Port}</b><br/>
<b>Address = address()</b><br/>
<b>Port = integer()</b><br/>
<b>Extra = term()</b><br/>
</p>
</div>
<div class="description">
<p>Inform about target addresses. </p>
<p>This is the first function called when a notification delivery is
in progress. It informs the <tt>receiver</tt> which targets will
get the notification. The result of the delivery will be
provided via successive calls to <tt>delivery_info/4</tt> function,
see below.</p>
<marker id="delivery_info"/>
</div>
</div>
<div class="method">
<div class="title">
<a name="delivery_infoTagTargetDeliveryResultExtragtvoid"></a><b>delivery_info(Tag, Target, DeliveryResult, Extra) -> void()</b>
</div>
<div class="func_types">
Types:
<p>
<b>Tag = term()</b><br/>
<b>Target = target()</b><br/>
<b>target() = {Address, Port}</b><br/>
<b>Address = address()</b><br/>
<b>Port = integer()</b><br/>
<b>DeliveryResult = delivery_result()</b><br/>
<b>delivery_result() = no_response | got_response</b><br/>
<b>Extra = term()</b><br/>
</p>
</div>
<div class="description">
<p>Inform about delivery result.</p>
<p>This function is called for each target in the <tt>Targets</tt>
argument of the <tt>delivery_targets/3</tt> function, see above. </p>
<p>The purpose is to inform the <tt>receiver</tt> of the
result of the delivery (was the notification acknowledged or
not) for each target.</p>
</div>
</div>
<center>
<hr/>
<small>Copyright © 1991-2009
<a href="http://www.ericsson.com/technology/opensource/erlang">Ericsson AB</a><br/>
</small>
</center>
</div>
</div>
</body>
</html>