Sign Up
Log In
Log In
or
Sign Up
Places
All Projects
Status Monitor
Collapse sidebar
home:Ledest:erlang
erlang
1571-snmp-doc-snmp_index-type-cleanup.patch
Overview
Repositories
Revisions
Requests
Users
Attributes
Meta
File 1571-snmp-doc-snmp_index-type-cleanup.patch of Package erlang
From 6ecb1edd933e54c3296f80225c942739d5ff5ffa Mon Sep 17 00:00:00 2001 From: Micael Karlberg <bmk@erlang.org> Date: Mon, 15 Jan 2024 17:34:22 +0100 Subject: [PATCH 51/67] [snmp|doc] snmp_index type cleanup --- lib/snmp/doc/src/snmp_index.xml | 59 +-------------------------------- 1 file changed, 1 insertion(+), 58 deletions(-) diff --git a/lib/snmp/doc/src/snmp_index.xml b/lib/snmp/doc/src/snmp_index.xml index fc410f5217..d0ab58e67f 100644 --- a/lib/snmp/doc/src/snmp_index.xml +++ b/lib/snmp/doc/src/snmp_index.xml @@ -151,64 +151,7 @@ get_next_pid(Oid, SnmpIndex) -> </datatypes> <section> - <title>Common data types</title> - <p>The following data types are used in the functions below: - </p> - <list type="bulleted"> - <item> - <p><c>index()</c></p> - </item> - <item> - <p><c>oid() = [byte()]</c></p> - </item> - <item> - <p><c>key_types = type_spec() | {type_spec(), type_spec(), ...}</c></p> - </item> - <item> - <p><c>type_spec() = fix_string | string | integer</c></p> - </item> - <item> - <p><c>key() = key_spec() | {key_spec(), key_spec(), ...}</c></p> - </item> - <item> - <p><c>key_spec() = string() | integer()</c></p> - </item> - </list> - <p>The <c>index()</c> type denotes an snmp index structure. - </p> - <p>The <c>oid()</c> type is used to represent an ASN.1 OBJECT - IDENTIFIER. - </p> - <p>The <c>key_types()</c> type is used when creating the - index structure, and the <c>key()</c> type is used when inserting - and deleting items from the structure. - </p> - <p>The <c>key_types()</c> type defines the types of the SNMP INDEX - columns for the table. If the table has one single INDEX column, - this type should be a single atom, but if the table has multiple - INDEX columns, it should be a tuple with atoms. - </p> - <p>If the INDEX column is of type INTEGER, or derived from - INTEGER, the corresponding type should be <c>integer</c>. If it - is a variable length type (e.g. OBJECT IDENTIFIER, OCTET STRING), - the corresponding type should be <c>string</c>. Finally, if the - type is of variable length, but with a fixed size restriction - (e.g. IpAddress), the corresponding type should be - <c>fix_string</c>. - </p> - <p>For example, if the SNMP table has two INDEX columns, the first - one an OCTET STRING with size 2, and the second one an OBJECT - IDENTIFIER, the corresponding <c>key_types</c> parameter would be - <c>{fix_string, string}</c>. - </p> - <p>The <c>key()</c> type correlates to the <c>key_types()</c> - type. If the <c>key_types()</c> is a single atom, the - corresponding <c>key()</c> is a single type as well, but if the - <c>key_types()</c> is a tuple, <c>key</c> must be a tuple of the - same size. - </p> - <p>In the example above, valid <c>keys</c> could be <c>{"hi", "mom"}</c> and <c>{"no", "thanks"}</c>, whereas <c>"hi"</c>, - <c>{"hi", 42}</c> and <c>{"hello", "there"}</c> would be invalid.</p> + <title>Warnings</title> <warning> <marker id="1"></marker> <p>All API functions that update the index return a <c>NewIndex</c> -- 2.35.3
Locations
Projects
Search
Status Monitor
Help
OpenBuildService.org
Documentation
API Documentation
Code of Conduct
Contact
Support
@OBShq
Terms
openSUSE Build Service is sponsored by
The Open Build Service is an
openSUSE project
.
Sign Up
Log In
Places
Places
All Projects
Status Monitor