← 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): Sergei Golovan
  • Date: 2009-06-11 12:18:07 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090611121807-ks7eb4xrt7dsysgx
Tags: 1:13.b.1-dfsg-1
http://bugs.debian.org/529512
* New upstream release.
* Removed unnecessary dependency of erlang-os-mon on erlang-observer and
  erlang-tools and added missing dependency of erlang-nox on erlang-os-mon
  (closes: #529512).
* Removed a patch to eunit application because the bug was fixed upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/snmp/doc/src/snmpa_mpd.xml
39
39
      It is supposed to be used from a Network Interface process 
40
40
      (<seealso marker="snmp_agent_netif">Definition of Agent Net if</seealso>).
41
41
      </p>
 
42
 
 
43
    <marker id="init"></marker>
42
44
  </description>
 
45
 
43
46
  <funcs>
44
47
    <func>
45
48
      <name>init(Vsns) -> mpd_state()</name>
54
57
          </p>
55
58
        <p>It also initializes some SNMP counters.
56
59
          </p>
 
60
 
 
61
        <marker id="process_packet"></marker>
57
62
      </desc>
58
63
    </func>
 
64
 
59
65
    <func>
60
 
      <name>process_packet(Packet, TDomain, TAddress, State) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason}</name>
 
66
      <name>process_packet(Packet, TDomain, TAddress, State) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
61
67
      <fsummary>Process a packet received from the network</fsummary>
62
68
      <type>
63
69
        <v>Packet = binary()</v>
70
76
        <v>Pdu = #pdu</v>
71
77
        <v>PduMs = integer()</v>
72
78
        <v>ACMData = acm_data()</v>
 
79
        <v>Reason = term()</v>
 
80
        <v>DiscoPacket = binary()</v>
73
81
      </type>
74
82
      <desc>
75
83
        <p>Processes an incoming packet.  Performs authentication and 
76
84
          decryption as necessary.  The return values should be passed the
77
85
          agent.</p>
 
86
 
 
87
        <marker id="generate_response_msg"></marker>
78
88
      </desc>
79
89
    </func>
 
90
 
80
91
    <func>
81
92
      <name>generate_response_msg(Vsn, RePdu, Type, ACMData) -> {ok, Packet} | {discarded, Reason}</name>
82
93
      <fsummary>Generate a response packet to be sent to the network</fsummary>
91
102
        <p>Generates a possibly encrypted response packet to be sent to the
92
103
          network. <c>Type</c> is the <c>#pdu.type</c> of the original
93
104
          request.</p>
 
105
 
 
106
        <marker id="generate_msg"></marker>
94
107
      </desc>
95
108
    </func>
 
109
 
96
110
    <func>
97
111
      <name>generate_msg(Vsn, Pdu, MsgData, To) -> {ok, PacketsAndAddresses} | {discarded, Reason}</name>
98
112
      <fsummary>Generate a request message to be sent to the network</fsummary>
121
135
          their corresponding security parameters.  This value is
122
136
          also received from the requests mentioned above.
123
137
          </p>
 
138
 
 
139
        <marker id="discarded_pdu"></marker>
124
140
      </desc>
125
141
    </func>
 
142
 
126
143
    <func>
127
144
      <name>discarded_pdu(Variable) -> void()</name>
128
145
      <fsummary>Increment the variable associated with a discarded pdu</fsummary>