diff options
Diffstat (limited to 'lib/snmp/doc/src/snmp_impl_example_manager.xml')
-rw-r--r-- | lib/snmp/doc/src/snmp_impl_example_manager.xml | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/lib/snmp/doc/src/snmp_impl_example_manager.xml b/lib/snmp/doc/src/snmp_impl_example_manager.xml new file mode 100644 index 0000000000..edc1f3998e --- /dev/null +++ b/lib/snmp/doc/src/snmp_impl_example_manager.xml @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2006</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>Manager Implementation Example</title> + <prepared></prepared> + <responsible></responsible> + <docno></docno> + <approved></approved> + <checked></checked> + <date></date> + <rev></rev> + <file>snmp_impl_example_manager.xml</file> + </header> + <p>This <em>Implementation Example</em> section describes + how a simple manager can be implemented with the + SNMP Development Toolkit. </p> + <p>The example shown, <em>ex2</em>, can be found in the toolkit + distribution. </p> + <p>This example has two functions: </p> + <list type="bulleted"> + <item> + <p>A simple example of how to use the manager component of + the SNMP Development Toolkit.</p> + </item> + <item> + <p>A simple example of how to write agent test cases, using the new + manager.</p> + </item> + </list> + + <section> + <title>The example manager</title> + <p>The example manager, <c>snmp_ex2_manager</c>, is a simple example of + how to implement an snmp manager using the manager component of the + SNMP Development Toolkit.</p> + <p>The module exports the following functions:</p> + <list type="bulleted"> + <item> + <p>start_link/0, start_link/1</p> + </item> + <item> + <p>stop/0</p> + </item> + <item> + <p>agent/2, agent/3</p> + </item> + <item> + <p>sync_get/2, sync_get/3</p> + </item> + <item> + <p>sync_get_next/2, sync_get_next/3</p> + </item> + <item> + <p>sync_get_bulk/4, sync_get_bulk/5</p> + </item> + <item> + <p>sync_set/2, sync_set/3</p> + </item> + <item> + <p>oid_to_name/1</p> + </item> + </list> + <p>This module is also used by the test module described in the + next section.</p> + </section> + + <section> + <title>A simple standard test</title> + <p>This simple standard test, <c>snmp_ex2_simple_standard_test</c>, + a module which, using the <c>snmp_ex2_manager</c> described in the + previous section, implements a simple agent test utility. </p> + </section> +</chapter> + |