From 9eef1d822c4bff6b92e1e543441cdf96de8c0c86 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Tue, 14 Nov 2023 17:56:43 -0600 Subject: [PATCH] Update: Specifications for Payload and Simple Packet. Add "type" as a recommended Object in the header section for the Payload. Change the size units being used in Simple Packet. The numbers used in some areas are completely wrong 2^4 is not 32-bits. Instead use the word "bytes" or "bits" and update the units. The Payload Block Structure uses "bytes" rather than bits as that is the general focus of that section. All others use "bits". --- specifications/fss-000e.txt | 7 ++++--- specifications/fss-000f.txt | 16 ++++++++-------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/specifications/fss-000e.txt b/specifications/fss-000e.txt index a62e115..c91c310 100644 --- a/specifications/fss-000e.txt +++ b/specifications/fss-000e.txt @@ -1,7 +1,7 @@ # fss-0002 iki-0000 # # license open-standard-license-1.0 -# version 2023/10/04 +# version 2023/11/14 # # This file (assumed to be named fss-000e.txt) can be more easily read using the following iki_read commands: # iki_read fss-000e.txt +Q -w -rr EOF EOF FLL FLL -WWW character "'" "'" code '"' '"' italic '"' '"' @@ -18,11 +18,12 @@ Featureless Settings Specification: 000e - Payload: The italic:"header"\: - The italic:"header"'s Content is of type code:"FSS-0001 (Extended)". - - The italic:"header" is recommended to have the Objects italic:"length", italic:"status", italic:"part", and italic:"total". + - The italic:"header" is recommended to have the Objects italic:"length", italic:"status", italic:"part", italic:"total", and italic:"type". - The recommended italic:"length" represents the size of the italic:"payload". - The recommended italic:"part" represents a single part of a set of packets for when the data being transmitted is split across multiple payloads. - - The recommended italic:"total" represents the total number of parts representing a complete data transmitted across multiple payloads. - The recommended italic:"status" represents status codes (such as success or failure) and multiple. + - The recommended italic:"total" represents the total number of parts representing a complete data transmitted across multiple payloads. + - The recommended italic:"type" represents the type of information being transmitted. - The Content for the recommended italic:"length" and italic:"status" are positive whole numbers (including zero) that may be in italic:"binary", italic:"octal", italic:"decimal", italic:"duodecimal", or italic:"hexidecimal" numerical format. - There may be multiple italic:"header" Object and associated Content but the behavior is not defined by this standard. - For guaranteed safe and compatible behavior, only a single italic:"header" Object and associated Content should be defined. diff --git a/specifications/fss-000f.txt b/specifications/fss-000f.txt index 1f4b973..1451834 100644 --- a/specifications/fss-000f.txt +++ b/specifications/fss-000f.txt @@ -1,7 +1,7 @@ # fss-0002 iki-0000 # # license open-standard-license-1.0 -# version 2023/07/16 +# version 2023/11/14 # # This file (assumed to be named fss-000f.txt) can be more easily read using the following iki_read commands: # iki_read fss-000f.txt +Q -w -WWWW character "'" "'" code '"' '"' italic '"' '"' bold '"' '"' @@ -27,8 +27,8 @@ Featureless Settings Specification: 000f - Simple Packet: Control Block Structure\: code:" - [ Endianness Bit ] [ String / Binary Bit ] [ Remaining 6 bits (unused) ] - [ size: 2^1 ] [ size: 2^1 ] [ size: 2^6 ] + [ Endianness Bit ] [ String / Binary Bit ] [ Remaining 6 Bits (unused) ] + [ size: 1 bit ] [ size: 1 bit ] [ size: 6 bits ] " The endianness bit designates whether or not the packet is in big endian or little endian format. @@ -48,11 +48,11 @@ Featureless Settings Specification: 000f - Simple Packet: Size Block Structure\: code:" - [ Size Block ] - [ size: 2^4 ] + [ Size Block ] + [ size: 32 bits ] " - The bold:"Size Block" is an unsigned 32-bit integer representing the size of the entire packet, including the bold:"Control Block" and bold:"Size Block". + The bold:"Size Block" is an unsigned 32-bit integer representing the size of the entire packet in bytes, including the bold:"Control Block" and bold:"Size Block". This size must exactly match the packet to be a valid packet. The size represents number of bytes in the file. The bold:"Control Block" is 1 byte long and the bold:"Size Block" is 4 bytes long, therefore the maximum available size of the entire bold:"Simple Packet" structure is code:"(2^32)-6". @@ -61,8 +61,8 @@ Featureless Settings Specification: 000f - Simple Packet: Payload Block Structure\: code:" - [ Payload Block ] - [ size: (2^32)-6 ] + [ Payload Block ] + [ size: (2^32)-6 bytes ] " The bold:"Payload Block" is not defined by this standard other than that it exists and should be in code:"FSS-000e (Payload)" format. -- 1.8.3.1