diff options
| author | Micael Karlberg <[email protected]> | 2013-04-30 23:29:13 +0200 |
|---|---|---|
| committer | Micael Karlberg <[email protected]> | 2013-04-30 23:29:13 +0200 |
| commit | 61ac3a2188af0f5d96ef9e1143845a12093acf4c (patch) | |
| tree | 328993bf5fe1953ed3cdf7678751e3082017f633 /lib/snmp/doc/src | |
| parent | 39096a9e9183df34299914d0983b17815fdf2730 (diff) | |
| download | otp-61ac3a2188af0f5d96ef9e1143845a12093acf4c.tar.gz otp-61ac3a2188af0f5d96ef9e1143845a12093acf4c.tar.bz2 otp-61ac3a2188af0f5d96ef9e1143845a12093acf4c.zip | |
[snmp/agent] Some minor documentation additions
Diffstat (limited to 'lib/snmp/doc/src')
| -rw-r--r-- | lib/snmp/doc/src/snmpa_mib_data.xml | 40 |
1 files changed, 39 insertions, 1 deletions
diff --git a/lib/snmp/doc/src/snmpa_mib_data.xml b/lib/snmp/doc/src/snmpa_mib_data.xml index 462112ac71..eeeb124d9d 100644 --- a/lib/snmp/doc/src/snmpa_mib_data.xml +++ b/lib/snmp/doc/src/snmpa_mib_data.xml @@ -180,7 +180,7 @@ <fsummary>Find the mib-entry corresponding to the Oid</fsummary> <type> <v>State = term()</v> - <v>Reply = {variable, ME} | {table_column, ME, TEOid} | {subagent, SAPid, SAOid} | [false, Reason}</v> + <v>Reply = {variable, ME} | {table_column, ME, TEOid} | {subagent, SAPid, SAOid} | {false, Reason}</v> <v>Oid = TEOid = SAOid = oid()</v> <v>SAPid = pid()</v> <v>ME = me()</v> @@ -193,8 +193,46 @@ and if it is a table, Oid must be <table>.<entry>.<col>.<any>.</p> <!-- FIX --> + + <marker id="next"></marker> + </desc> + </func> + + <func> + <name>next(State, Oid, MibView) -> Reply</name> + <fsummary>Finds the lexicographically next oid</fsummary> + <type> + <v>State = term()</v> + <v>Reply = false | endOfTable | {subagent, SAPid, SAOid} | {variable, ME, VarOid} | {table, TableOid, TableRestOid, ME}</v> + <v>Oid = SAOid = VarOid = TableOid = TableRestOid = oid()</v> + <v>SAPid = pid()</v> + <v>ME = me()</v> + </type> + <desc> + <p>Finds the lexicographically next oid. </p> + + <marker id="register_subagent"></marker> </desc> </func> + + <func> + <name>register_subagent(State, Oid, Pid) -> Reply</name> + <fsummary>Register the subagent</fsummary> + <type> + <v>State = NewState = term()</v> + <v>Reply = {ok, NewState} | {error, Reason}</v> + <v>Oid = oid()</v> + <v>Pid = pid()</v> + <v>Reason = term()</v> + </type> + <desc> + <p>Register the the subagent, process, + handling part of the mib-tree. </p> + + <marker id="unregister_subagent"></marker> + </desc> + </func> + </funcs> </erlref> |