File: snmpa_error_report.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 23,284 kB
  • ctags: 10,724
  • sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (124 lines) | stat: -rw-r--r-- 2,609 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
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>snmpa_error_report</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>snmpa_error_report</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
snmpa_error_report
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
 Behaviour module for reporting SNMP agent errors

</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<A NAME="desc"><!-- Empty --></A>
<P>This module defines the behaviour of the agent error reporting.
A <CODE>snmpa_error_report</CODE> compliant module 
must export the following functions: 
<P>
<UL>

<LI>
config_err/2<BR>

</LI>


<LI>
user_err/2<BR>

</LI>


</UL>

<P>The semantics of them and their exact signatures are explained
below. 
</DIV>

<H3>EXPORTS</H3>

<P><A NAME="config_err/2"><STRONG><CODE>config_err(Format, Args) -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Format = string()</CODE></STRONG><BR>
<STRONG><CODE>Args = list()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>The function is called if an error occurs during the
        configuration phase, for example if a syntax error is found in
        a configuration file.

        
<P><CODE>Format</CODE> and <CODE>Args</CODE> are as in
        <CODE>io:format(Format, Args)</CODE>.

</DIV>

<P><A NAME="user_err/2"><STRONG><CODE>user_err(Format, Args) -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Format = string()</CODE></STRONG><BR>
<STRONG><CODE>Args = list()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>The function is called if a user related error occurs at
        runtime, for example if a user defined instrumentation
        function returns erroneous.

        
<P><CODE>Format</CODE> and <CODE>Args</CODE> are as in
        <CODE>io:format(Format, Args)</CODE>.

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Micael Karlberg - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>snmp 4.8.2<BR>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>