File 1584-snmp-Types-and-specs-for-snmp_pdus-enc_mes... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1584-snmp-Types-and-specs-for-snmp_pdus-enc_message_only-.patch of Package erlang

From b9dd454a7ee1316c4aa6c18b1ff7dc7a60eb120a Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Tue, 16 Jan 2024 11:18:46 +0100
Subject: [PATCH 64/67] [snmp] Types and specs for snmp_pdus:enc_message_only/1

---
 lib/snmp/doc/src/snmp_pdus.xml  | 14 ++++++--------
 lib/snmp/src/misc/snmp_pdus.erl |  5 +++++
 2 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/lib/snmp/doc/src/snmp_pdus.xml b/lib/snmp/doc/src/snmp_pdus.xml
index 17ada0b02f..85e8ee0a7a 100644
--- a/lib/snmp/doc/src/snmp_pdus.xml
+++ b/lib/snmp/doc/src/snmp_pdus.xml
@@ -181,18 +181,16 @@
 Encodes a message record to a list of bytes.
 </desc>
 </func>
+
 <func>
- <name since="">enc_message_only(Message) -> [byte()]</name>
+ <name name="enc_message_only" arity="1" clause_i="1" since=""/>
 <fsummary>Encode an SNMP Message, but not the data part</fsummary>
- <type>
- <v>Message = #message</v>
- </type>
 <desc>
 <c>Message</c> is a record where the <c>data</c> field is
- assumed to be encoded (a list of bytes). If there is a v1 or v2
- message, the <c>data</c> field is an encoded <c>PDU</c>, and if
- there is a v3 message, <c>data</c> is an encoded and possibly
- encrypted <c>scopedPDU</c>.
+	assumed to be encoded (a list of bytes). If there is a v1 or v2
+	message, the <c>data</c> field is an encoded <c>PDU</c>, and if
+	there is a v3 message, <c>data</c> is an encoded and possibly
+	encrypted <c>scopedPDU</c>. 
 </desc>
 </func>
 <func>
diff --git a/lib/snmp/src/misc/snmp_pdus.erl b/lib/snmp/src/misc/snmp_pdus.erl
index 8c490024b7..6c0c16b8bf 100644
--- a/lib/snmp/src/misc/snmp_pdus.erl
+++ b/lib/snmp/src/misc/snmp_pdus.erl
@@ -578,6 +578,11 @@ enc_message(#message{version = Ver, vsn_hdr = VsnHdr, data = Data}) ->
 Len = elength(length(Bytes2)),
 [48 | Len] ++ Bytes2.
 
+
+-spec enc_message_only(Message) -> Bytes when
+ Message :: message(),
+ Bytes :: [byte()].
+
 enc_message_only(#message{version = Ver, vsn_hdr = VsnHdr, data = DataBytes}) ->
 VerBytes = enc_version(Ver),
 Bytes = 
-- 
2.35.3

Places

File 1584-snmp-Types-and-specs-for-snmp_pdus-enc_message_only-.patch of Package erlang

Places