在线文档教程
Erlang 20

snmpa_mib_storage

snmpa_mib_storage

模块

snmpa_mib_storage

模块摘要

SNMP代理mib存储的行为模块。

描述

此模块定义SNMP代理mib存储的行为。

代理使用mib存储来存储内部的mib相关信息。mib存储模块由多个实体使用,而不仅仅是mib服务器。

一个snmpa_mib_storage兼容的模块必须导出以下功能:

  • open/5

  • close/1

  • read/2

  • write/2

  • delete/1

  • delete/2

  • match_object/2

  • match_delete/2

  • tab2list/1

  • info/1

  • sync/1

  • backup/2

他们的语义和他们的确切签名解释如下。

回调函数

必须从mib-server数据回调模块:

输出

Module:open(Name, RecordName, Fields, Type, Options) -> {ok, TabId} | {error, Reason}

类型

创建或打开MIB存储表。

请注意,参数RecordNameFields我不能在所有实现中使用(它们实际上仅在基于mnesia的实现中才需要)。

还请注意,Options参数来源于options配置选项的MIB-存储配置选项,并将按原样传递。

Module:close(TabId) -> void()

类型

关闭MIB存储表。

Module:read(TabId, Key) -> false | {value, Record}

类型

从MIB存储表中读取一条记录。

Module:write(TabId, Record) -> ok | {error, Reason}

类型

将记录写入MIB-存储表。

Module:delete(TabId) -> void()

类型

删除整个MIB存储表。

Module:delete(TabId, Key) -> ok | {error, Reason}

类型

从MIB-存储表中删除一条记录。

Module:match_object(TabId, Pattern) -> {ok, Recs} | {error, Reason}

类型

在MIB-存储表中搜索与指定模式匹配的记录。

Module:match_delete(TabId, Pattern) -> {ok, Recs} | {error, Reason}

类型

搜索MIB-存储表,查找与指定模式匹配的记录,然后删除它们。还将返回已删除的记录。

Module:tab2list(TabId) -> Recs

类型

以列表的形式返回MIB-存储表中的所有记录。

Module:info(TabId) -> {ok, Info} | {error, Reason}

类型

检索与实现相关的MIB-存储表信息。

Module:sync(TabId) -> void()

类型

同步MIB-存储表。

这意味着,如果有的话,是依赖于实现的。

Module:backup(TabId, BackupDir) -> ok | {error, Reason}

类型

执行MIB存储表的备份。

这意味着,如果有的话,是依赖于实现的。