The R13B03 release.OTP_R13B03

1 files changed, 95 insertions, 0 deletions

diff --git a/lib/snmp/doc/src/snmpa_error_logger.xml b/lib/snmp/doc/src/snmpa_error_logger.xml
new file mode 100644
index 0000000000..06382a6057
--- /dev/null
+++ b/lib/snmp/doc/src/snmpa_error_logger.xml
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+  <header>
+    <copyright>
+      <year>1996</year><year>2009</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      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.
+    
+    </legalnotice>
+
+    <title>snmpa_error_logger</title>
+    <prepared></prepared>
+    <responsible></responsible>
+    <docno></docno>
+    <approved></approved>
+    <checked></checked>
+    <date></date>
+    <rev></rev>
+    <file>snmpa_error_logger.xml</file>
+  </header>
+  <module>snmpa_error_logger</module>
+  <modulesummary>Functions for Reporting SNMP Errors through the error_logger</modulesummary>
+  <description>
+    <p>The module <c>snmpa_error_logger</c> implements the 
+      <c>snmpa_error_report</c> behaviour 
+      (see <seealso marker="snmpa_error_report">snmpa_error_report</seealso>) 
+      containing two callback functions which are called in order to 
+      report SNMP errors.
+      </p>
+    <p>This module provides a simple mechanism for reporting SNMP
+      errors. Errors are sent to the <c>error_logger</c> after a 
+      size check. Messages are truncated after 1024 chars. 
+      It is provided as an example.
+      </p>
+    <p>This module is the default error report module, but can be 
+      explicitly configured, see
+      <seealso marker="snmpa_error#desc">snmpa_error</seealso> and
+      <seealso marker="snmp_config#configuration_params">configuration parameters</seealso>.
+      </p>
+  </description>
+  <funcs>
+    <func>
+      <name>config_err(Format, Args) -> void()</name>
+      <fsummary>Called if a configuration error occurs</fsummary>
+      <type>
+        <v>Format = string()</v>
+        <v>Args = list()</v>
+      </type>
+      <desc>
+        <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>
+        <p><c>Format</c> and <c>Args</c> are as in
+          <c>io:format(Format, Args)</c>.</p>
+      </desc>
+    </func>
+    <func>
+      <name>user_err(Format, Args) -> void()</name>
+      <fsummary>Called if a user related error occurs</fsummary>
+      <type>
+        <v>Format = string()</v>
+        <v>Args = list()</v>
+      </type>
+      <desc>
+        <p>The function is called if a user related error occurs at
+          run-time, for example if a user defined instrumentation
+          function returns erroneous.
+          </p>
+        <p><c>Format</c> and <c>Args</c> are as in
+          <c>io:format(Format, Args)</c>.</p>
+      </desc>
+    </func>
+  </funcs>
+
+  <section>
+    <title>See Also</title>
+    <p>error_logger(3)</p>
+  </section>
+  
+</erlref>
+