Sign Up
Log In
Log In
or
Sign Up
Places
All Projects
Status Monitor
Collapse sidebar
home:Ledest:erlang
erlang
1532-snmp-Types-and-specs-for-snmp-log_to_txt-5...
Overview
Repositories
Revisions
Requests
Users
Attributes
Meta
File 1532-snmp-Types-and-specs-for-snmp-log_to_txt-5-6-7-8.patch of Package erlang
From 5a3986589722f902c8b015d4527937d80c83f570 Mon Sep 17 00:00:00 2001 From: Micael Karlberg <bmk@erlang.org> Date: Wed, 10 Jan 2024 15:38:04 +0100 Subject: [PATCH 12/67] [snmp] Types and specs for snmp:log_to_txt/5,6,7,8 --- lib/snmp/doc/src/snmp.xml | 24 +++-------- lib/snmp/src/app/snmp.erl | 83 ++++++++++++++++++++++++++++++++++++++- 2 files changed, 88 insertions(+), 19 deletions(-) diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml index e9ed011411..55b1633bf4 100644 --- a/lib/snmp/doc/src/snmp.xml +++ b/lib/snmp/doc/src/snmp.xml @@ -429,25 +429,13 @@ </func> <func> - <name since="">log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason}</name> - <name since="">log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason}</name> - <name since="">log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason}</name> - <name since="OTP R16B03">log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason}</name> + <name name="log_to_txt" arity="5" clause_i="1" since=""/> + <name name="log_to_txt" arity="6" clause_i="1" since=""/> + <name name="log_to_txt" arity="6" clause_i="2" since=""/> + <name name="log_to_txt" arity="7" clause_i="1" since=""/> + <name name="log_to_txt" arity="7" clause_i="2" since=""/> + <name name="log_to_txt" arity="8" clause_i="1" since="OTP R16B03"/> <fsummary>Convert an Audit Trail Log to text format</fsummary> - <type> - <v>LogDir = string()</v> - <v>Mibs = [MibName]</v> - <v>OutFile = string()</v> - <v>MibName = string()</v> - <v>LogName = string()</v> - <v>LogFile = string()</v> - <v>Start = Stop = null | datetime() | {local_time,datetime()} | {universal_time,datetime()} </v> - <v>Block = boolean()</v> - <v>Cnt = {NumOK, NumERR}</v> - <v>NumOK = non_neg_integer()</v> - <v>NumERR = pos_integer()</v> - <v>Reason = term()</v> - </type> <desc> <p>Converts an Audit Trail Log to a readable text file, where each item has a trailing TAB character, and any TAB diff --git a/lib/snmp/src/app/snmp.erl b/lib/snmp/src/app/snmp.erl index 83553a3548..1404e518bd 100644 --- a/lib/snmp/src/app/snmp.erl +++ b/lib/snmp/src/app/snmp.erl @@ -956,14 +956,52 @@ read_mib(FileName) -> %%% Audit Trail Log functions %%%----------------------------------------------------------------- +-spec log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> + ok | {ok, Cnt} | {error, Reason} when + LogDir :: string(), + Mibs :: [mib_name()], + OutFile :: string(), + LogName :: string(), + LogFile :: string(), + Cnt :: {NumOK, NumERR}, + NumOK :: non_neg_integer(), + NumERR :: pos_integer(), + Reason :: term(). + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> Block = ?ATL_BLOCK_DEFAULT, Start = null, Stop = null, log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop). + +-spec log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block) -> + ok | {ok, Cnt} | {error, Reason} when + LogDir :: string(), + Mibs :: [mib_name()], + OutFile :: string(), + LogName :: string(), + LogFile :: string(), + Block :: boolean(), + Cnt :: {NumOK, NumERR}, + NumOK :: non_neg_integer(), + NumERR :: pos_integer(), + Reason :: term(); + (LogDir, Mibs, OutFile, LogName, LogFile, Start) -> + ok | {ok, Cnt} | {error, Reason} when + LogDir :: string(), + Mibs :: [mib_name()], + OutFile :: string(), + LogName :: string(), + LogFile :: string(), + Start :: 'null' | log_time(), + Cnt :: {NumOK, NumERR}, + NumOK :: non_neg_integer(), + NumERR :: pos_integer(), + Reason :: term(). + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block) - when ((Block =:= true) orelse (Block =:= false)) -> + when is_boolean(Block) -> Start = null, Stop = null, log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop); @@ -972,6 +1010,34 @@ log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start) -> Stop = null, log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop). + +-spec log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> + ok | {ok, Cnt} | {error, Reason} when + LogDir :: string(), + Mibs :: [mib_name()], + OutFile :: string(), + LogName :: string(), + LogFile :: string(), + Block :: boolean(), + Start :: 'null' | log_time(), + Cnt :: {NumOK, NumERR}, + NumOK :: non_neg_integer(), + NumERR :: pos_integer(), + Reason :: term(); + (LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> + ok | {ok, Cnt} | {error, Reason} when + LogDir :: string(), + Mibs :: [mib_name()], + OutFile :: string(), + LogName :: string(), + LogFile :: string(), + Start :: 'null' | log_time(), + Stop :: 'null' | log_time(), + Cnt :: {NumOK, NumERR}, + NumOK :: non_neg_integer(), + NumERR :: pos_integer(), + Reason :: term(). + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) when ((Block =:= true) orelse (Block =:= false)) -> Stop = null, @@ -980,6 +1046,21 @@ log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> Block = ?ATL_BLOCK_DEFAULT, log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop). +-spec log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> + ok | {ok, Cnt} | {error, Reason} when + LogDir :: string(), + Mibs :: [mib_name()], + OutFile :: string(), + LogName :: string(), + LogFile :: string(), + Block :: boolean(), + Start :: 'null' | log_time(), + Stop :: 'null' | log_time(), + Cnt :: {NumOK, NumERR}, + NumOK :: non_neg_integer(), + NumERR :: pos_integer(), + Reason :: term(). + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> snmp_log:log_to_txt(LogName, Block, LogFile, LogDir, Mibs, OutFile, Start, Stop). -- 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
