snmpa_mib_storage behaviour (snmp v5.20.1)

Copy Markdown View Source

Behaviour module for the SNMP agent mib storage.

This module defines the behaviour of the SNMP agent mib storage.

The mib storage is used by the agent to store internal mib- related information. The mib storage module is used by several entities, not just the mib-server.

A snmpa_mib_storage compliant module must export the following functions:

The semantics of them and their exact signatures are explained below.

Summary

Types

mib_storage_fields()
mib_storage_table_id()
mib_storage_table_type()

Callbacks

backup(TabId, Dir)

Perform a backup of the mib-storage table.

close(TabId)

Close the mib-storage table.

delete(TabId)

Delete an entire mib-storage table.

delete(TabId, Key)

Delete a record from the mib-storage table.

info(TabId)

Retrieve implementation dependent mib-storage table information.

info(TabId, Item)
match_delete(TabId, Pattern)

Search the mib-storage table for record that match the specified pattern and then delete them. The records deleted are also returned.

match_object(TabId, Pattern)

Search the mib-storage table for record that match the specified pattern.

open(Name, RecName, Fields, Type, Options)

Create or open a mib storage table.

read(TabId, Key)

Read a record from the mib-storage table.

sync(TabId)

Synchronize the mib-storage table.

tab2list(TabId)

Return all records in the mib-storage table in the form of a list.

write(TabId, Record)

Write a record to the mib-storage table.

Types

mib_storage_fields()

(since OTP R16B01) 
-type mib_storage_fields() :: [atom()].

mib_storage_table_id()

(since OTP R16B01) 
-type mib_storage_table_id() :: term().

mib_storage_table_type()

(since OTP R16B01) 
-type mib_storage_table_type() :: set | bag.

Callbacks

backup(TabId, Dir) -> Result

(since OTP R16B01)

Types

TabId = mib_storage_table_id()
Dir = file:filename()
Result = ok | {error, Reason :: term()}

Perform a backup of the mib-storage table.

What this means, if anything, is implementation dependent.

close(TabId :: mib_storage_table_id()) -> term()

(since OTP R16B01)

Close the mib-storage table.

delete(TabId :: mib_storage_table_id()) -> snmp:void()

(since OTP R16B01)

Delete an entire mib-storage table.

delete(TabId, Key) -> Result

(since OTP R16B01)

Types

TabId = mib_storage_table_id()
Key = term()
Result = ok | {error, Reason :: term()}

Delete a record from the mib-storage table.

info(TabId :: mib_storage_table_id()) -> Info

(since OTP R16B01)

Types

Info = term()

Retrieve implementation dependent mib-storage table information.

info(TabId :: mib_storage_table_id(), Item :: atom()) -> Info

(since OTP R16B01)

Types

Info = term()

match_delete(TabId, Pattern) -> Recs

(since OTP R16B01)

Types

TabId = mib_storage_table_id()
Pattern = ets:match_pattern()
Recs = [tuple()] | {error, Reason :: term()}

Search the mib-storage table for record that match the specified pattern and then delete them. The records deleted are also returned.

match_object(TabId, Pattern) -> Recs

(since OTP R16B01)

Types

TabId = mib_storage_table_id()
Pattern = ets:match_pattern()
Recs = [tuple()] | {error, Reason :: term()}

Search the mib-storage table for record that match the specified pattern.

open(Name, RecName, Fields, Type, Options) -> Result

(since OTP R16B01)

Types

Name = RecName = atom()
Fields = mib_storage_fields()
Type = mib_storage_table_type()
Options = list()
Result = {ok, TabId :: mib_storage_table_id()} | {error, Reason :: term()}

Create or open a mib storage table.

Note that the RecordName and Fields arguments my not be used in all implementations (they are actually only needed for mnesia-based implementations).

Note also that the Options argument comes from the options config option of the mib-storage config option, and is passed on as is.

read(TabId, Key) -> Result

(since OTP R16B01)

Types

TabId = mib_storage_table_id()
Key = term()
Result = false | {value, Record :: tuple()}

Read a record from the mib-storage table.

sync(TabId :: mib_storage_table_id()) -> snmp:void()

(since OTP R16B01)

Synchronize the mib-storage table.

What this means, if anything, is implementation dependent.

tab2list(TabId :: mib_storage_table_id()) -> [tuple()]

(since OTP R16B01)

Return all records in the mib-storage table in the form of a list.

write(TabId, Record) -> Result

(since OTP R16B01)

Types

TabId = mib_storage_table_id()
Record = tuple()
Result = ok | {error, Reason :: term()}

Write a record to the mib-storage table.