File 2831-snmp-Types-and-specs-for-snmp-log_to_io-4-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2831-snmp-Types-and-specs-for-snmp-log_to_io-4-5-6-7.patch of Package erlang (Revision 2f15b05a39d64e5cba90e927e8665465)

Currently displaying revision 2f15b05a39d64e5cba90e927e8665465 , Show latest

From 25c8d212de5f7ddacbf2f22ccad056bf082961f7 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Wed, 10 Jan 2024 15:13:08 +0100
Subject: [PATCH 11/67] [snmp] Types and specs for snmp:log_to_io/4,5,6,7

---
 lib/snmp/doc/src/snmp.xml | 33 ++++++++--------
 lib/snmp/src/app/snmp.erl | 82 ++++++++++++++++++++++++++++++++++++++-
 2 files changed, 97 insertions(+), 18 deletions(-)

diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml
index a7ee72c7c4..e9ed011411 100644
--- a/lib/snmp/doc/src/snmp.xml
+++ b/lib/snmp/doc/src/snmp.xml
@@ -121,6 +121,17 @@
       </desc>
     </datatype>
 
+    <datatype>
+      <name name="log_time"/>
+      
+    </datatype>
+
     <datatype>
       <name name="void"/>
       <desc>
@@ -489,23 +500,13 @@
     </func>
 
     <func>
-      <name since="OTP R15B01">log_to_io(LogDir, Mibs, LogName, LogFile) ->  ok | {ok, Cnt} | {error, Reason}</name>
-      <name since="OTP R15B01">log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) ->  ok | {ok, Cnt} | {error, Reason}</name>
-      <name since="OTP R15B01">log_to_io(LogDir, Mibs, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason}</name>
-      <name since="OTP R16B03">log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason}</name>
+      <name name="log_to_io" arity="4" clause_i="1" since="OTP R15B01"/>
+      <name name="log_to_io" arity="5" clause_i="1" since="OTP R15B01"/>
+      <name name="log_to_io" arity="5" clause_i="2" since="OTP R15B01"/>
+      <name name="log_to_io" arity="6" clause_i="1" since="OTP R15B01"/>
+      <name name="log_to_io" arity="6" clause_i="2" since="OTP R15B01"/>
+      <name name="log_to_io" arity="7" 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>MibName = string()</v>
-        <v>LogName = string()</v>
-        <v>LogFile = string()</v>
-        <v>Start = Stop = null | datetime() | {local_time,datetime()} |  {universal_time,datetime()} </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 format and 
 	prints it on stdio. See 
diff --git a/lib/snmp/src/app/snmp.erl b/lib/snmp/src/app/snmp.erl
index 03c4e6695d..83553a3548 100644
--- a/lib/snmp/src/app/snmp.erl
+++ b/lib/snmp/src/app/snmp.erl
@@ -124,13 +124,17 @@
 
 %% This type, which is documented in disk_log,
 %% is not actually exported by disk_log.
-%% Instead is defined in an internal header file.
+%% Instead it is defined in an internal header file.
 %% So we have to create a "copy" of it here.
 %% Lets hope it never changes...
 -type log_size()              :: 'infinity' | pos_integer() |
                                  {MaxNoBytes :: pos_integer(),
                                   MaxNoFiles :: pos_integer()}.
 
+-type log_time()              :: calendar:datetime() |
+                                 {local_time, calendar:datetime()} |
+                                 {universal_time, calendar:datetime()}.
+
 -type bits()                  :: integer().
 -type octet()                 :: 0..255.
 -type octet_string()          :: [octet()].
@@ -981,14 +985,49 @@ log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) ->
 			Start, Stop).
 
 
+-spec log_to_io(LogDir, Mibs, LogName, LogFile) ->
+          ok | {ok, Cnt} | {error, Reason} when
+      LogDir  :: string(),
+      Mibs    :: [mib_name()],
+      LogName :: string(),
+      LogFile :: string(),
+      Cnt     :: {NumOK, NumERR},
+      NumOK   :: non_neg_integer(),
+      NumERR  :: pos_integer(),
+      Reason  :: term().
+
 log_to_io(LogDir, Mibs, LogName, LogFile) -> 
     Block = ?ATL_BLOCK_DEFAULT, 
     Start = null, 
     Stop  = null, 
     log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop).
 
+
+-spec log_to_io(LogDir, Mibs, LogName, LogFile, Block) ->
+          ok | {ok, Cnt} | {error, Reason} when
+      LogDir  :: string(),
+      Mibs    :: [mib_name()],
+      LogName :: string(),
+      LogFile :: string(),
+      Block   :: boolean(),
+      Cnt     :: {NumOK, NumERR},
+      NumOK   :: non_neg_integer(),
+      NumERR  :: pos_integer(),
+      Reason  :: term();
+               (LogDir, Mibs, LogName, LogFile, Start) ->
+          ok | {ok, Cnt} | {error, Reason} when
+      LogDir  :: string(),
+      Mibs    :: [mib_name()],
+      LogName :: string(),
+      LogFile :: string(),
+      Start   :: 'null' | log_time(),
+      Cnt     :: {NumOK, NumERR},
+      NumOK   :: non_neg_integer(),
+      NumERR  :: pos_integer(),
+      Reason  :: term().
+
 log_to_io(LogDir, Mibs, LogName, LogFile, Block) 
-  when ((Block =:= true) orelse (Block =:= false)) -> 
+  when is_boolean(Block) -> 
     Start = null, 
     Stop  = null, 
     log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop);
@@ -997,6 +1036,31 @@ log_to_io(LogDir, Mibs, LogName, LogFile, Start) ->
     Stop  = null, 
     log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop).
 
+-spec log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start) ->
+          ok | {ok, Cnt} | {error, Reason} when
+      LogDir  :: string(),
+      Mibs    :: [mib_name()],
+      LogName :: string(),
+      LogFile :: string(),
+      Block   :: boolean(),
+      Start   :: 'null' | log_time(),
+      Cnt     :: {NumOK, NumERR},
+      NumOK   :: non_neg_integer(),
+      NumERR  :: pos_integer(),
+      Reason  :: term();
+               (LogDir, Mibs, LogName, LogFile, Start, Stop) ->
+          ok | {ok, Cnt} | {error, Reason} when
+      LogDir  :: string(),
+      Mibs    :: [mib_name()],
+      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_io(LogDir, Mibs, LogName, LogFile, Block, Start) 
   when ((Block =:= true) orelse (Block =:= false)) -> 
     Stop  = null, 
@@ -1005,6 +1069,20 @@ log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) ->
     Block = ?ATL_BLOCK_DEFAULT, 
     log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop).
 
+-spec log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) ->
+          ok | {ok, Cnt} | {error, Reason} when
+      LogDir  :: string(),
+      Mibs    :: [mib_name()],
+      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_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) -> 
     snmp_log:log_to_io(LogName, Block, LogFile, LogDir, Mibs, Start, Stop).
 
-- 
2.35.3

Places

File 2831-snmp-Types-and-specs-for-snmp-log_to_io-4-5-6-7.patch of Package erlang (Revision 2f15b05a39d64e5cba90e927e8665465)

Places