← Back to branch summary

~ubuntu-branches/ubuntu/trusty/erlang/trusty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2011-05-05 15:48:43 UTC
  • mfrom: (3.5.13 sid)
  • Revision ID: james.westby@ubuntu.com-20110505154843-0om6ekzg6m7ugj27
Tags: 1:14.b.2-dfsg-3ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Drop libwxgtk2.8-dev build dependency. Wx isn't in main, and not
    supposed to.
  - Drop erlang-wx binary.
  - Drop erlang-wx dependency from -megaco, -common-test, and -reltool, they
    do not really need wx. Also drop it from -debugger; the GUI needs wx,
    but it apparently has CLI bits as well, and is also needed by -megaco,
    so let's keep the package for now.
  - debian/patches/series: Do what I meant, and enable build-options.patch
    instead.
* Additional changes:
  - Drop erlang-wx from -et
* Dropped Changes:
  - patches/pcre-crash.patch: CVE-2008-2371: outer level option with
    alternatives caused crash. (Applied Upstream)
  - fix for ssl certificate verification in newSSL: 
    ssl_cacertfile_fix.patch (Applied Upstream)
  - debian/patches/series: Enable native.patch again, to get stripped beam
    files and reduce the package size again. (build-options is what
    actually accomplished this)
  - Remove build-options.patch on advice from upstream and because it caused
    odd build failures.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/snmp/doc/src/snmpa_mpd.xml
4
4
<erlref>
5
5
  <header>
6
6
    <copyright>
7
 
      <year>1999</year><year>2009</year>
 
7
      <year>1999</year><year>2010</year>
8
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
9
9
    </copyright>
10
10
    <legalnotice>
13
13
      compliance with the License. You should have received a copy of the
14
14
      Erlang Public License along with this software. If not, it can be
15
15
      retrieved online at http://www.erlang.org/.
16
 
    
 
16
 
17
17
      Software distributed under the License is distributed on an "AS IS"
18
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
19
19
      the License for the specific language governing rights and limitations
20
20
      under the License.
21
 
    
 
21
 
22
22
    </legalnotice>
23
23
 
24
24
    <title>snmpa_mpd</title>
63
63
    </func>
64
64
 
65
65
    <func>
66
 
      <name>process_packet(Packet, TDomain, TAddress, State) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
 
66
      <name>process_packet(Packet, TDomain, TAddress, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
 
67
      <name>process_packet(Packet, TDomain, TAddress, LocalEngineID, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
67
68
      <fsummary>Process a packet received from the network</fsummary>
68
69
      <type>
69
70
        <v>Packet = binary()</v>
70
71
        <v>TDomain = snmpUDPDomain</v>
71
72
        <v>TAddress = {Ip, Udp}</v>
 
73
        <v>LocalEngineID = string()</v>
72
74
        <v>Ip = {integer(), integer(), integer(), integer()}</v>
73
75
        <v>Udp = integer()</v>
74
76
        <v>State = mpd_state()</v>
 
77
        <v>NoteStore = pid()</v>
 
78
        <v>Log = snmp_log()</v>
75
79
        <v>Vsn = 'version-1' | 'version-2' | 'version-3'</v>
76
80
        <v>Pdu = #pdu</v>
77
81
        <v>PduMs = integer()</v>
84
88
          decryption as necessary.  The return values should be passed the
85
89
          agent.</p>
86
90
 
 
91
        <note>
 
92
          <p>Note that the use of the LocalEngineID argument is only intended 
 
93
            for special cases, if the agent is to "emulate" multiple EngineIDs!
 
94
            By default, the agent uses the value of <c>SnmpEngineID</c> 
 
95
            (see SNMP-FRAMEWORK-MIB). </p>
 
96
        </note>
 
97
 
87
98
        <marker id="generate_response_msg"></marker>
88
99
      </desc>
89
100
    </func>
90
101
 
91
102
    <func>
92
 
      <name>generate_response_msg(Vsn, RePdu, Type, ACMData) -> {ok, Packet} | {discarded, Reason}</name>
 
103
      <name>generate_response_msg(Vsn, RePdu, Type, ACMData, Log) -> {ok, Packet} | {discarded, Reason}</name>
 
104
      <name>generate_response_msg(Vsn, RePdu, Type, ACMData, LocalEngineID, Log) -> {ok, Packet} | {discarded, Reason}</name>
93
105
      <fsummary>Generate a response packet to be sent to the network</fsummary>
94
106
      <type>
95
107
        <v>Vsn = 'version-1' | 'version-2' | 'version-3'</v>
96
108
        <v>RePdu = #pdu</v>
97
109
        <v>Type = atom()</v>
98
110
        <v>ACMData = acm_data()</v>
 
111
        <v>LocalEngineID = string()</v>
99
112
        <v>Packet = binary()</v>
100
113
      </type>
101
114
      <desc>
103
116
          network. <c>Type</c> is the <c>#pdu.type</c> of the original
104
117
          request.</p>
105
118
 
 
119
        <note>
 
120
          <p>Note that the use of the LocalEngineID argument is only intended 
 
121
            for special cases, if the agent is to "emulate" multiple EngineIDs!
 
122
            By default, the agent uses the value of <c>SnmpEngineID</c> 
 
123
            (see SNMP-FRAMEWORK-MIB). </p>
 
124
        </note>
 
125
 
106
126
        <marker id="generate_msg"></marker>
107
127
      </desc>
108
128
    </func>
109
129
 
110
130
    <func>
111
 
      <name>generate_msg(Vsn, Pdu, MsgData, To) -> {ok, PacketsAndAddresses} | {discarded, Reason}</name>
 
131
      <name>generate_msg(Vsn, NoteStore, Pdu, MsgData, To) -> {ok, PacketsAndAddresses} | {discarded, Reason}</name>
 
132
      <name>generate_msg(Vsn, NoteStore, Pdu, MsgData, LocalEngineID, To) -> {ok, PacketsAndAddresses} | {discarded, Reason}</name>
112
133
      <fsummary>Generate a request message to be sent to the network</fsummary>
113
134
      <type>
114
135
        <v>Vsn = 'version-1' | 'version-2' | 'version-3'</v>
 
136
        <v>NoteStore = pid()</v>
115
137
        <v>Pdu = #pdu</v>
116
138
        <v>MsgData = msg_data()</v>
 
139
        <v>LocalEngineID = string()</v>
117
140
        <v>To = [dest_addrs()]</v>
118
141
        <v>PacketsAndAddresses = [{TDomain, TAddress, Packet}]</v>
119
142
        <v>TDomain = snmpUDPDomain</v>
136
159
          also received from the requests mentioned above.
137
160
          </p>
138
161
 
 
162
        <note>
 
163
          <p>Note that the use of the LocalEngineID argument is only intended 
 
164
            for special cases, if the agent is to "emulate" multiple EngineIDs!
 
165
            By default, the agent uses the value of <c>SnmpEngineID</c> 
 
166
            (see SNMP-FRAMEWORK-MIB). </p>
 
167
        </note>
 
168
 
139
169
        <marker id="discarded_pdu"></marker>
140
170
      </desc>
141
171
    </func>