← Back to branch summary

~statik/ubuntu/maverick/erlang/erlang-merge-testing

« back to all changes in this revision

Viewing changes to lib/snmp/doc/src/snmp_framework_mib.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-05-01 10:14:38 UTC
  • mfrom: (3.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20090501101438-6qlr6rsdxgyzrg2z
Tags: 1:13.b-dfsg-2
* Cleaned up patches: removed unneeded patch which helped to support
  different SCTP library versions, made sure that changes for m68k
  architecture applied only when building on this architecture.
* Removed duplicated information from binary packages descriptions.
* Don't require libsctp-dev build-dependency on solaris-i386 architecture
  which allows to build Erlang on Nexenta (thanks to Tim Spriggs for
  the suggestion).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/snmp/doc/src/snmp_framework_mib.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>1999</year><year>2009</year>
 
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
 
9
    </copyright>
 
10
    <legalnotice>
 
11
      The contents of this file are subject to the Erlang Public License,
 
12
      Version 1.1, (the "License"); you may not use this file except in
 
13
      compliance with the License. You should have received a copy of the
 
14
      Erlang Public License along with this software. If not, it can be
 
15
      retrieved online at http://www.erlang.org/.
 
16
    
 
17
      Software distributed under the License is distributed on an "AS IS"
 
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
19
      the License for the specific language governing rights and limitations
 
20
      under the License.
 
21
    
 
22
    </legalnotice>
 
23
 
 
24
    <title>snmp_framework_mib</title>
 
25
    <prepared></prepared>
 
26
    <responsible></responsible>
 
27
    <docno></docno>
 
28
    <approved></approved>
 
29
    <checked></checked>
 
30
    <date></date>
 
31
    <rev></rev>
 
32
    <file>snmp_framework_mib.xml</file>
 
33
  </header>
 
34
  <module>snmp_framework_mib</module>
 
35
  <modulesummary>Instrumentation Functions for SNMP-FRAMEWORK-MIB</modulesummary>
 
36
  <description>
 
37
    <p>The module <c>snmp_framework_mib</c> implements instrumentation
 
38
      functions for the
 
39
      SNMP-FRAMEWORK-MIB, and functions for initializing and configuring the
 
40
      database.
 
41
      </p>
 
42
    <p>The configuration files are described in the SNMP User's Manual.</p>
 
43
  </description>
 
44
  <funcs>
 
45
    <func>
 
46
      <name>configure(ConfDir) -> void()</name>
 
47
      <fsummary>Configure the SNMP-FRAMEWORK-MIB</fsummary>
 
48
      <type>
 
49
        <v>ConfDir = string()</v>
 
50
      </type>
 
51
      <desc>
 
52
        <p>This function is called from the supervisor at system
 
53
          start-up.
 
54
          </p>
 
55
        <p>Inserts all data in the configuration files into the
 
56
          database and destroys all old data.
 
57
          </p>
 
58
        <p>Thus, the data in the SNMP-FRAMEWORK-MIB, after this
 
59
          function has been called, is from the configuration
 
60
          files.
 
61
          </p>
 
62
        <p>All <c>snmp</c> counters are set to zero.
 
63
          </p>
 
64
        <p>If an error is found in the configuration file, it is
 
65
          reported using the function <c>config_err/2</c> of the error 
 
66
          report module, and the function fails with reason 
 
67
          <c>configuration_error</c>.
 
68
          </p>
 
69
        <p><c>ConfDir</c> is a string which points to the directory
 
70
          where the configuration files are found.
 
71
          </p>
 
72
        <p>The configuration file read is: <c>context.conf</c>.
 
73
          </p>
 
74
      </desc>
 
75
    </func>
 
76
    <func>
 
77
      <name>init() -> void()</name>
 
78
      <fsummary>Initialize the SNMP-FRAMEWORK-MIB</fsummary>
 
79
      <desc>
 
80
        <p>This function is called from the supervisor at system
 
81
          start-up.
 
82
          </p>
 
83
        <p>Creates the necessary objects in the database if they do not
 
84
          exist. It does not destroy any old values.
 
85
                    <marker id="add_context"></marker>
 
86
</p>
 
87
      </desc>
 
88
    </func>
 
89
    <func>
 
90
      <name>add_context(Ctx) -> Ret</name>
 
91
      <fsummary>Added one context</fsummary>
 
92
      <type>
 
93
        <v>Ctx = string()</v>
 
94
        <v>Ret = {ok, Key} | {error, Reason}</v>
 
95
        <v>Key = term()</v>
 
96
        <v>Reason = term()</v>
 
97
      </type>
 
98
      <desc>
 
99
        <p>Adds a context to the agent config. 
 
100
          Equivalent to one line in the <c>context.conf</c> file.</p>
 
101
        <marker id="delete_context"></marker>
 
102
      </desc>
 
103
    </func>
 
104
    <func>
 
105
      <name>delete_context(Key) -> Ret</name>
 
106
      <fsummary>Delete one context</fsummary>
 
107
      <type>
 
108
        <v>Key = term()</v>
 
109
        <v>Ret = ok | {error, Reason}</v>
 
110
        <v>Reason = term()</v>
 
111
      </type>
 
112
      <desc>
 
113
        <p>Delete a context from the agent config.</p>
 
114
      </desc>
 
115
    </func>
 
116
  </funcs>
 
117
  
 
118
</erlref>
 
119