draft in progress
This commit is contained in:
brent saner
commit
ca2010e62c
GPG Key ID:
8C004C2F93481F6B
22
.githooks/pre-commit/01-docgen
Executable file
22
.githooks/pre-commit/01-docgen
Executable file
@ -0,0 +1,22 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
docsdir="${PWD}/docs"
|
||||||
|
|
||||||
|
if ! command -v asciidoctor &> /dev/null;
|
||||||
|
then
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p "${docsdir}"
|
||||||
|
|
||||||
|
for f in $(find . -maxdepth 1 -type f -iname "*.adoc"); do
|
||||||
|
filename=$(basename -- "${f}")
|
||||||
|
nosuffix="${filename%.*}"
|
||||||
|
|
||||||
|
asciidoctor \
|
||||||
|
-a allow-uri-read \
|
||||||
|
-o "${docsdir}/${nosuffix}.html" \
|
||||||
|
"${f}"
|
||||||
|
git add "${docsdir}/${nosuffix}.html"
|
||||||
|
done
|
||||||
|
echo "Regenerated docs"
|
||||||
427
LICENSE
Normal file
427
LICENSE
Normal file
@ -0,0 +1,427 @@
|
|||||||
|
Attribution-ShareAlike 4.0 International
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||||
|
does not provide legal services or legal advice. Distribution of
|
||||||
|
Creative Commons public licenses does not create a lawyer-client or
|
||||||
|
other relationship. Creative Commons makes its licenses and related
|
||||||
|
information available on an "as-is" basis. Creative Commons gives no
|
||||||
|
warranties regarding its licenses, any material licensed under their
|
||||||
|
terms and conditions, or any related information. Creative Commons
|
||||||
|
disclaims all liability for damages resulting from their use to the
|
||||||
|
fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and
|
||||||
|
conditions that creators and other rights holders may use to share
|
||||||
|
original works of authorship and other material subject to copyright
|
||||||
|
and certain other rights specified in the public license below. The
|
||||||
|
following considerations are for informational purposes only, are not
|
||||||
|
exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are
|
||||||
|
intended for use by those authorized to give the public
|
||||||
|
permission to use material in ways otherwise restricted by
|
||||||
|
copyright and certain other rights. Our licenses are
|
||||||
|
irrevocable. Licensors should read and understand the terms
|
||||||
|
and conditions of the license they choose before applying it.
|
||||||
|
Licensors should also secure all rights necessary before
|
||||||
|
applying our licenses so that the public can reuse the
|
||||||
|
material as expected. Licensors should clearly mark any
|
||||||
|
material not subject to the license. This includes other CC-
|
||||||
|
licensed material, or material used under an exception or
|
||||||
|
limitation to copyright. More considerations for licensors:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensors
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public
|
||||||
|
licenses, a licensor grants the public permission to use the
|
||||||
|
licensed material under specified terms and conditions. If
|
||||||
|
the licensor's permission is not necessary for any reason--for
|
||||||
|
example, because of any applicable exception or limitation to
|
||||||
|
copyright--then that use is not regulated by the license. Our
|
||||||
|
licenses grant only permissions under copyright and certain
|
||||||
|
other rights that a licensor has authority to grant. Use of
|
||||||
|
the licensed material may still be restricted for other
|
||||||
|
reasons, including because others have copyright or other
|
||||||
|
rights in the material. A licensor may make special requests,
|
||||||
|
such as asking that all changes be marked or described.
|
||||||
|
Although not required by our licenses, you are encouraged to
|
||||||
|
respect those requests where reasonable. More considerations
|
||||||
|
for the public:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensees
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Attribution-ShareAlike 4.0 International Public
|
||||||
|
License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree
|
||||||
|
to be bound by the terms and conditions of this Creative Commons
|
||||||
|
Attribution-ShareAlike 4.0 International Public License ("Public
|
||||||
|
License"). To the extent this Public License may be interpreted as a
|
||||||
|
contract, You are granted the Licensed Rights in consideration of Your
|
||||||
|
acceptance of these terms and conditions, and the Licensor grants You
|
||||||
|
such rights in consideration of benefits the Licensor receives from
|
||||||
|
making the Licensed Material available under these terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
|
||||||
|
Section 1 -- Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar
|
||||||
|
Rights that is derived from or based upon the Licensed Material
|
||||||
|
and in which the Licensed Material is translated, altered,
|
||||||
|
arranged, transformed, or otherwise modified in a manner requiring
|
||||||
|
permission under the Copyright and Similar Rights held by the
|
||||||
|
Licensor. For purposes of this Public License, where the Licensed
|
||||||
|
Material is a musical work, performance, or sound recording,
|
||||||
|
Adapted Material is always produced where the Licensed Material is
|
||||||
|
synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright
|
||||||
|
and Similar Rights in Your contributions to Adapted Material in
|
||||||
|
accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. BY-SA Compatible License means a license listed at
|
||||||
|
creativecommons.org/compatiblelicenses, approved by Creative
|
||||||
|
Commons as essentially the equivalent of this Public License.
|
||||||
|
|
||||||
|
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||||
|
closely related to copyright including, without limitation,
|
||||||
|
performance, broadcast, sound recording, and Sui Generis Database
|
||||||
|
Rights, without regard to how the rights are labeled or
|
||||||
|
categorized. For purposes of this Public License, the rights
|
||||||
|
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||||
|
Rights.
|
||||||
|
|
||||||
|
e. Effective Technological Measures means those measures that, in the
|
||||||
|
absence of proper authority, may not be circumvented under laws
|
||||||
|
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||||
|
Treaty adopted on December 20, 1996, and/or similar international
|
||||||
|
agreements.
|
||||||
|
|
||||||
|
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||||
|
any other exception or limitation to Copyright and Similar Rights
|
||||||
|
that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
g. License Elements means the license attributes listed in the name
|
||||||
|
of a Creative Commons Public License. The License Elements of this
|
||||||
|
Public License are Attribution and ShareAlike.
|
||||||
|
|
||||||
|
h. Licensed Material means the artistic or literary work, database,
|
||||||
|
or other material to which the Licensor applied this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
i. Licensed Rights means the rights granted to You subject to the
|
||||||
|
terms and conditions of this Public License, which are limited to
|
||||||
|
all Copyright and Similar Rights that apply to Your use of the
|
||||||
|
Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||||
|
under this Public License.
|
||||||
|
|
||||||
|
k. Share means to provide material to the public by any means or
|
||||||
|
process that requires permission under the Licensed Rights, such
|
||||||
|
as reproduction, public display, public performance, distribution,
|
||||||
|
dissemination, communication, or importation, and to make material
|
||||||
|
available to the public including in ways that members of the
|
||||||
|
public may access the material from a place and at a time
|
||||||
|
individually chosen by them.
|
||||||
|
|
||||||
|
l. Sui Generis Database Rights means rights other than copyright
|
||||||
|
resulting from Directive 96/9/EC of the European Parliament and of
|
||||||
|
the Council of 11 March 1996 on the legal protection of databases,
|
||||||
|
as amended and/or succeeded, as well as other essentially
|
||||||
|
equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
m. You means the individual or entity exercising the Licensed Rights
|
||||||
|
under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
|
||||||
|
Section 2 -- Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License,
|
||||||
|
the Licensor hereby grants You a worldwide, royalty-free,
|
||||||
|
non-sublicensable, non-exclusive, irrevocable license to
|
||||||
|
exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
a. reproduce and Share the Licensed Material, in whole or
|
||||||
|
in part; and
|
||||||
|
|
||||||
|
b. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||||
|
Exceptions and Limitations apply to Your use, this Public
|
||||||
|
License does not apply, and You do not need to comply with
|
||||||
|
its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section
|
||||||
|
6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The
|
||||||
|
Licensor authorizes You to exercise the Licensed Rights in
|
||||||
|
all media and formats whether now known or hereafter created,
|
||||||
|
and to make technical modifications necessary to do so. The
|
||||||
|
Licensor waives and/or agrees not to assert any right or
|
||||||
|
authority to forbid You from making technical modifications
|
||||||
|
necessary to exercise the Licensed Rights, including
|
||||||
|
technical modifications necessary to circumvent Effective
|
||||||
|
Technological Measures. For purposes of this Public License,
|
||||||
|
simply making modifications authorized by this Section 2(a)
|
||||||
|
(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
a. Offer from the Licensor -- Licensed Material. Every
|
||||||
|
recipient of the Licensed Material automatically
|
||||||
|
receives an offer from the Licensor to exercise the
|
||||||
|
Licensed Rights under the terms and conditions of this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
b. Additional offer from the Licensor -- Adapted Material.
|
||||||
|
Every recipient of Adapted Material from You
|
||||||
|
automatically receives an offer from the Licensor to
|
||||||
|
exercise the Licensed Rights in the Adapted Material
|
||||||
|
under the conditions of the Adapter's License You apply.
|
||||||
|
|
||||||
|
c. No downstream restrictions. You may not offer or impose
|
||||||
|
any additional or different terms or conditions on, or
|
||||||
|
apply any Effective Technological Measures to, the
|
||||||
|
Licensed Material if doing so restricts exercise of the
|
||||||
|
Licensed Rights by any recipient of the Licensed
|
||||||
|
Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or
|
||||||
|
may be construed as permission to assert or imply that You
|
||||||
|
are, or that Your use of the Licensed Material is, connected
|
||||||
|
with, or sponsored, endorsed, or granted official status by,
|
||||||
|
the Licensor or others designated to receive attribution as
|
||||||
|
provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not
|
||||||
|
licensed under this Public License, nor are publicity,
|
||||||
|
privacy, and/or other similar personality rights; however, to
|
||||||
|
the extent possible, the Licensor waives and/or agrees not to
|
||||||
|
assert any such rights held by the Licensor to the limited
|
||||||
|
extent necessary to allow You to exercise the Licensed
|
||||||
|
Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to
|
||||||
|
collect royalties from You for the exercise of the Licensed
|
||||||
|
Rights, whether directly or through a collecting society
|
||||||
|
under any voluntary or waivable statutory or compulsory
|
||||||
|
licensing scheme. In all other cases the Licensor expressly
|
||||||
|
reserves any right to collect such royalties.
|
||||||
|
|
||||||
|
|
||||||
|
Section 3 -- License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the
|
||||||
|
following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified
|
||||||
|
form), You must:
|
||||||
|
|
||||||
|
a. retain the following if it is supplied by the Licensor
|
||||||
|
with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed
|
||||||
|
Material and any others designated to receive
|
||||||
|
attribution, in any reasonable manner requested by
|
||||||
|
the Licensor (including by pseudonym if
|
||||||
|
designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of
|
||||||
|
warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the
|
||||||
|
extent reasonably practicable;
|
||||||
|
|
||||||
|
b. indicate if You modified the Licensed Material and
|
||||||
|
retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
c. indicate the Licensed Material is licensed under this
|
||||||
|
Public License, and include the text of, or the URI or
|
||||||
|
hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||||
|
reasonable manner based on the medium, means, and context in
|
||||||
|
which You Share the Licensed Material. For example, it may be
|
||||||
|
reasonable to satisfy the conditions by providing a URI or
|
||||||
|
hyperlink to a resource that includes the required
|
||||||
|
information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the
|
||||||
|
information required by Section 3(a)(1)(A) to the extent
|
||||||
|
reasonably practicable.
|
||||||
|
|
||||||
|
b. ShareAlike.
|
||||||
|
|
||||||
|
In addition to the conditions in Section 3(a), if You Share
|
||||||
|
Adapted Material You produce, the following conditions also apply.
|
||||||
|
|
||||||
|
1. The Adapter's License You apply must be a Creative Commons
|
||||||
|
license with the same License Elements, this version or
|
||||||
|
later, or a BY-SA Compatible License.
|
||||||
|
|
||||||
|
2. You must include the text of, or the URI or hyperlink to, the
|
||||||
|
Adapter's License You apply. You may satisfy this condition
|
||||||
|
in any reasonable manner based on the medium, means, and
|
||||||
|
context in which You Share Adapted Material.
|
||||||
|
|
||||||
|
3. You may not offer or impose any additional or different terms
|
||||||
|
or conditions on, or apply any Effective Technological
|
||||||
|
Measures to, Adapted Material that restrict exercise of the
|
||||||
|
rights granted under the Adapter's License You apply.
|
||||||
|
|
||||||
|
|
||||||
|
Section 4 -- Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that
|
||||||
|
apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||||
|
to extract, reuse, reproduce, and Share all or a substantial
|
||||||
|
portion of the contents of the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database
|
||||||
|
contents in a database in which You have Sui Generis Database
|
||||||
|
Rights, then the database in which You have Sui Generis Database
|
||||||
|
Rights (but not its individual contents) is Adapted Material,
|
||||||
|
including for purposes of Section 3(b); and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share
|
||||||
|
all or a substantial portion of the contents of the database.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not
|
||||||
|
replace Your obligations under this Public License where the Licensed
|
||||||
|
Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
|
||||||
|
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||||
|
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||||
|
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||||
|
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||||
|
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||||
|
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||||
|
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||||
|
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||||
|
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||||
|
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||||
|
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||||
|
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||||
|
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||||
|
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||||
|
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||||
|
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||||
|
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided
|
||||||
|
above shall be interpreted in a manner that, to the extent
|
||||||
|
possible, most closely approximates an absolute disclaimer and
|
||||||
|
waiver of all liability.
|
||||||
|
|
||||||
|
|
||||||
|
Section 6 -- Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and
|
||||||
|
Similar Rights licensed here. However, if You fail to comply with
|
||||||
|
this Public License, then Your rights under this Public License
|
||||||
|
terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under
|
||||||
|
Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided
|
||||||
|
it is cured within 30 days of Your discovery of the
|
||||||
|
violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||||
|
right the Licensor may have to seek remedies for Your violations
|
||||||
|
of this Public License.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, the Licensor may also offer the
|
||||||
|
Licensed Material under separate terms or conditions or stop
|
||||||
|
distributing the Licensed Material at any time; however, doing so
|
||||||
|
will not terminate this Public License.
|
||||||
|
|
||||||
|
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 7 -- Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different
|
||||||
|
terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the
|
||||||
|
Licensed Material not stated herein are separate from and
|
||||||
|
independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 8 -- Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and
|
||||||
|
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||||
|
conditions on any use of the Licensed Material that could lawfully
|
||||||
|
be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is
|
||||||
|
deemed unenforceable, it shall be automatically reformed to the
|
||||||
|
minimum extent necessary to make it enforceable. If the provision
|
||||||
|
cannot be reformed, it shall be severed from this Public License
|
||||||
|
without affecting the enforceability of the remaining terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no
|
||||||
|
failure to comply consented to unless expressly agreed to by the
|
||||||
|
Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted
|
||||||
|
as a limitation upon, or waiver of, any privileges and immunities
|
||||||
|
that apply to the Licensor or You, including from the legal
|
||||||
|
processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public
|
||||||
|
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||||
|
its public licenses to material it publishes and in those instances
|
||||||
|
will be considered the “Licensor.” The text of the Creative Commons
|
||||||
|
public licenses is dedicated to the public domain under the CC0 Public
|
||||||
|
Domain Dedication. Except for the limited purpose of indicating that
|
||||||
|
material is shared under a Creative Commons public license or as
|
||||||
|
otherwise permitted by the Creative Commons policies published at
|
||||||
|
creativecommons.org/policies, Creative Commons does not authorize the
|
||||||
|
use of the trademark "Creative Commons" or any other trademark or logo
|
||||||
|
of Creative Commons without its prior written consent including,
|
||||||
|
without limitation, in connection with any unauthorized modifications
|
||||||
|
to any of its public licenses or any other arrangements,
|
||||||
|
understandings, or agreements concerning use of licensed material. For
|
||||||
|
the avoidance of doubt, this paragraph does not form part of the
|
||||||
|
public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
475
LICENSE.html
Normal file
475
LICENSE.html
Normal file
@ -0,0 +1,475 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>WireProto Specification License</title>
|
||||||
|
<!-- <link rel="stylesheet" href="style.css"> -->
|
||||||
|
<!-- <script src="script.js"></script> -->
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a property="dct:title"
|
||||||
|
rel="cc:attributionURL"
|
||||||
|
href="https://wireproto.io">
|
||||||
|
WireProto Specification
|
||||||
|
</a> by
|
||||||
|
<a rel="cc:attributionURL dct:creator"
|
||||||
|
property="cc:attributionName"
|
||||||
|
href="https://r00t2.io">
|
||||||
|
Brent Saner
|
||||||
|
</a> is licensed under
|
||||||
|
<a href="https://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1"
|
||||||
|
target="_blank"
|
||||||
|
rel="license noopener noreferrer"
|
||||||
|
style="display:inline-block;">
|
||||||
|
Creative Commons Attribution-ShareAlike 4.0 International
|
||||||
|
<br />
|
||||||
|
<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;"
|
||||||
|
src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1"
|
||||||
|
alt="">
|
||||||
|
<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;"
|
||||||
|
src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1"
|
||||||
|
alt="">
|
||||||
|
<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;"
|
||||||
|
src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1"
|
||||||
|
alt=""></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<details>
|
||||||
|
<summary>(License in full)</summary>
|
||||||
|
<pre>
|
||||||
|
Attribution-ShareAlike 4.0 International
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||||
|
does not provide legal services or legal advice. Distribution of
|
||||||
|
Creative Commons public licenses does not create a lawyer-client or
|
||||||
|
other relationship. Creative Commons makes its licenses and related
|
||||||
|
information available on an "as-is" basis. Creative Commons gives no
|
||||||
|
warranties regarding its licenses, any material licensed under their
|
||||||
|
terms and conditions, or any related information. Creative Commons
|
||||||
|
disclaims all liability for damages resulting from their use to the
|
||||||
|
fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and
|
||||||
|
conditions that creators and other rights holders may use to share
|
||||||
|
original works of authorship and other material subject to copyright
|
||||||
|
and certain other rights specified in the public license below. The
|
||||||
|
following considerations are for informational purposes only, are not
|
||||||
|
exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are
|
||||||
|
intended for use by those authorized to give the public
|
||||||
|
permission to use material in ways otherwise restricted by
|
||||||
|
copyright and certain other rights. Our licenses are
|
||||||
|
irrevocable. Licensors should read and understand the terms
|
||||||
|
and conditions of the license they choose before applying it.
|
||||||
|
Licensors should also secure all rights necessary before
|
||||||
|
applying our licenses so that the public can reuse the
|
||||||
|
material as expected. Licensors should clearly mark any
|
||||||
|
material not subject to the license. This includes other CC-
|
||||||
|
licensed material, or material used under an exception or
|
||||||
|
limitation to copyright. More considerations for licensors:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensors
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public
|
||||||
|
licenses, a licensor grants the public permission to use the
|
||||||
|
licensed material under specified terms and conditions. If
|
||||||
|
the licensor's permission is not necessary for any reason--for
|
||||||
|
example, because of any applicable exception or limitation to
|
||||||
|
copyright--then that use is not regulated by the license. Our
|
||||||
|
licenses grant only permissions under copyright and certain
|
||||||
|
other rights that a licensor has authority to grant. Use of
|
||||||
|
the licensed material may still be restricted for other
|
||||||
|
reasons, including because others have copyright or other
|
||||||
|
rights in the material. A licensor may make special requests,
|
||||||
|
such as asking that all changes be marked or described.
|
||||||
|
Although not required by our licenses, you are encouraged to
|
||||||
|
respect those requests where reasonable. More considerations
|
||||||
|
for the public:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensees
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Attribution-ShareAlike 4.0 International Public
|
||||||
|
License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree
|
||||||
|
to be bound by the terms and conditions of this Creative Commons
|
||||||
|
Attribution-ShareAlike 4.0 International Public License ("Public
|
||||||
|
License"). To the extent this Public License may be interpreted as a
|
||||||
|
contract, You are granted the Licensed Rights in consideration of Your
|
||||||
|
acceptance of these terms and conditions, and the Licensor grants You
|
||||||
|
such rights in consideration of benefits the Licensor receives from
|
||||||
|
making the Licensed Material available under these terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
|
||||||
|
Section 1 -- Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar
|
||||||
|
Rights that is derived from or based upon the Licensed Material
|
||||||
|
and in which the Licensed Material is translated, altered,
|
||||||
|
arranged, transformed, or otherwise modified in a manner requiring
|
||||||
|
permission under the Copyright and Similar Rights held by the
|
||||||
|
Licensor. For purposes of this Public License, where the Licensed
|
||||||
|
Material is a musical work, performance, or sound recording,
|
||||||
|
Adapted Material is always produced where the Licensed Material is
|
||||||
|
synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright
|
||||||
|
and Similar Rights in Your contributions to Adapted Material in
|
||||||
|
accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. BY-SA Compatible License means a license listed at
|
||||||
|
creativecommons.org/compatiblelicenses, approved by Creative
|
||||||
|
Commons as essentially the equivalent of this Public License.
|
||||||
|
|
||||||
|
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||||
|
closely related to copyright including, without limitation,
|
||||||
|
performance, broadcast, sound recording, and Sui Generis Database
|
||||||
|
Rights, without regard to how the rights are labeled or
|
||||||
|
categorized. For purposes of this Public License, the rights
|
||||||
|
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||||
|
Rights.
|
||||||
|
|
||||||
|
e. Effective Technological Measures means those measures that, in the
|
||||||
|
absence of proper authority, may not be circumvented under laws
|
||||||
|
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||||
|
Treaty adopted on December 20, 1996, and/or similar international
|
||||||
|
agreements.
|
||||||
|
|
||||||
|
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||||
|
any other exception or limitation to Copyright and Similar Rights
|
||||||
|
that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
g. License Elements means the license attributes listed in the name
|
||||||
|
of a Creative Commons Public License. The License Elements of this
|
||||||
|
Public License are Attribution and ShareAlike.
|
||||||
|
|
||||||
|
h. Licensed Material means the artistic or literary work, database,
|
||||||
|
or other material to which the Licensor applied this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
i. Licensed Rights means the rights granted to You subject to the
|
||||||
|
terms and conditions of this Public License, which are limited to
|
||||||
|
all Copyright and Similar Rights that apply to Your use of the
|
||||||
|
Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||||
|
under this Public License.
|
||||||
|
|
||||||
|
k. Share means to provide material to the public by any means or
|
||||||
|
process that requires permission under the Licensed Rights, such
|
||||||
|
as reproduction, public display, public performance, distribution,
|
||||||
|
dissemination, communication, or importation, and to make material
|
||||||
|
available to the public including in ways that members of the
|
||||||
|
public may access the material from a place and at a time
|
||||||
|
individually chosen by them.
|
||||||
|
|
||||||
|
l. Sui Generis Database Rights means rights other than copyright
|
||||||
|
resulting from Directive 96/9/EC of the European Parliament and of
|
||||||
|
the Council of 11 March 1996 on the legal protection of databases,
|
||||||
|
as amended and/or succeeded, as well as other essentially
|
||||||
|
equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
m. You means the individual or entity exercising the Licensed Rights
|
||||||
|
under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
|
||||||
|
Section 2 -- Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License,
|
||||||
|
the Licensor hereby grants You a worldwide, royalty-free,
|
||||||
|
non-sublicensable, non-exclusive, irrevocable license to
|
||||||
|
exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
a. reproduce and Share the Licensed Material, in whole or
|
||||||
|
in part; and
|
||||||
|
|
||||||
|
b. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||||
|
Exceptions and Limitations apply to Your use, this Public
|
||||||
|
License does not apply, and You do not need to comply with
|
||||||
|
its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section
|
||||||
|
6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The
|
||||||
|
Licensor authorizes You to exercise the Licensed Rights in
|
||||||
|
all media and formats whether now known or hereafter created,
|
||||||
|
and to make technical modifications necessary to do so. The
|
||||||
|
Licensor waives and/or agrees not to assert any right or
|
||||||
|
authority to forbid You from making technical modifications
|
||||||
|
necessary to exercise the Licensed Rights, including
|
||||||
|
technical modifications necessary to circumvent Effective
|
||||||
|
Technological Measures. For purposes of this Public License,
|
||||||
|
simply making modifications authorized by this Section 2(a)
|
||||||
|
(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
a. Offer from the Licensor -- Licensed Material. Every
|
||||||
|
recipient of the Licensed Material automatically
|
||||||
|
receives an offer from the Licensor to exercise the
|
||||||
|
Licensed Rights under the terms and conditions of this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
b. Additional offer from the Licensor -- Adapted Material.
|
||||||
|
Every recipient of Adapted Material from You
|
||||||
|
automatically receives an offer from the Licensor to
|
||||||
|
exercise the Licensed Rights in the Adapted Material
|
||||||
|
under the conditions of the Adapter's License You apply.
|
||||||
|
|
||||||
|
c. No downstream restrictions. You may not offer or impose
|
||||||
|
any additional or different terms or conditions on, or
|
||||||
|
apply any Effective Technological Measures to, the
|
||||||
|
Licensed Material if doing so restricts exercise of the
|
||||||
|
Licensed Rights by any recipient of the Licensed
|
||||||
|
Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or
|
||||||
|
may be construed as permission to assert or imply that You
|
||||||
|
are, or that Your use of the Licensed Material is, connected
|
||||||
|
with, or sponsored, endorsed, or granted official status by,
|
||||||
|
the Licensor or others designated to receive attribution as
|
||||||
|
provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not
|
||||||
|
licensed under this Public License, nor are publicity,
|
||||||
|
privacy, and/or other similar personality rights; however, to
|
||||||
|
the extent possible, the Licensor waives and/or agrees not to
|
||||||
|
assert any such rights held by the Licensor to the limited
|
||||||
|
extent necessary to allow You to exercise the Licensed
|
||||||
|
Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to
|
||||||
|
collect royalties from You for the exercise of the Licensed
|
||||||
|
Rights, whether directly or through a collecting society
|
||||||
|
under any voluntary or waivable statutory or compulsory
|
||||||
|
licensing scheme. In all other cases the Licensor expressly
|
||||||
|
reserves any right to collect such royalties.
|
||||||
|
|
||||||
|
|
||||||
|
Section 3 -- License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the
|
||||||
|
following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified
|
||||||
|
form), You must:
|
||||||
|
|
||||||
|
a. retain the following if it is supplied by the Licensor
|
||||||
|
with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed
|
||||||
|
Material and any others designated to receive
|
||||||
|
attribution, in any reasonable manner requested by
|
||||||
|
the Licensor (including by pseudonym if
|
||||||
|
designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of
|
||||||
|
warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the
|
||||||
|
extent reasonably practicable;
|
||||||
|
|
||||||
|
b. indicate if You modified the Licensed Material and
|
||||||
|
retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
c. indicate the Licensed Material is licensed under this
|
||||||
|
Public License, and include the text of, or the URI or
|
||||||
|
hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||||
|
reasonable manner based on the medium, means, and context in
|
||||||
|
which You Share the Licensed Material. For example, it may be
|
||||||
|
reasonable to satisfy the conditions by providing a URI or
|
||||||
|
hyperlink to a resource that includes the required
|
||||||
|
information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the
|
||||||
|
information required by Section 3(a)(1)(A) to the extent
|
||||||
|
reasonably practicable.
|
||||||
|
|
||||||
|
b. ShareAlike.
|
||||||
|
|
||||||
|
In addition to the conditions in Section 3(a), if You Share
|
||||||
|
Adapted Material You produce, the following conditions also apply.
|
||||||
|
|
||||||
|
1. The Adapter's License You apply must be a Creative Commons
|
||||||
|
license with the same License Elements, this version or
|
||||||
|
later, or a BY-SA Compatible License.
|
||||||
|
|
||||||
|
2. You must include the text of, or the URI or hyperlink to, the
|
||||||
|
Adapter's License You apply. You may satisfy this condition
|
||||||
|
in any reasonable manner based on the medium, means, and
|
||||||
|
context in which You Share Adapted Material.
|
||||||
|
|
||||||
|
3. You may not offer or impose any additional or different terms
|
||||||
|
or conditions on, or apply any Effective Technological
|
||||||
|
Measures to, Adapted Material that restrict exercise of the
|
||||||
|
rights granted under the Adapter's License You apply.
|
||||||
|
|
||||||
|
|
||||||
|
Section 4 -- Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that
|
||||||
|
apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||||
|
to extract, reuse, reproduce, and Share all or a substantial
|
||||||
|
portion of the contents of the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database
|
||||||
|
contents in a database in which You have Sui Generis Database
|
||||||
|
Rights, then the database in which You have Sui Generis Database
|
||||||
|
Rights (but not its individual contents) is Adapted Material,
|
||||||
|
including for purposes of Section 3(b); and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share
|
||||||
|
all or a substantial portion of the contents of the database.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not
|
||||||
|
replace Your obligations under this Public License where the Licensed
|
||||||
|
Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
|
||||||
|
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||||
|
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||||
|
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||||
|
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||||
|
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||||
|
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||||
|
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||||
|
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||||
|
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||||
|
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||||
|
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||||
|
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||||
|
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||||
|
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||||
|
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||||
|
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||||
|
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided
|
||||||
|
above shall be interpreted in a manner that, to the extent
|
||||||
|
possible, most closely approximates an absolute disclaimer and
|
||||||
|
waiver of all liability.
|
||||||
|
|
||||||
|
|
||||||
|
Section 6 -- Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and
|
||||||
|
Similar Rights licensed here. However, if You fail to comply with
|
||||||
|
this Public License, then Your rights under this Public License
|
||||||
|
terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under
|
||||||
|
Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided
|
||||||
|
it is cured within 30 days of Your discovery of the
|
||||||
|
violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||||
|
right the Licensor may have to seek remedies for Your violations
|
||||||
|
of this Public License.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, the Licensor may also offer the
|
||||||
|
Licensed Material under separate terms or conditions or stop
|
||||||
|
distributing the Licensed Material at any time; however, doing so
|
||||||
|
will not terminate this Public License.
|
||||||
|
|
||||||
|
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 7 -- Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different
|
||||||
|
terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the
|
||||||
|
Licensed Material not stated herein are separate from and
|
||||||
|
independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 8 -- Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and
|
||||||
|
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||||
|
conditions on any use of the Licensed Material that could lawfully
|
||||||
|
be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is
|
||||||
|
deemed unenforceable, it shall be automatically reformed to the
|
||||||
|
minimum extent necessary to make it enforceable. If the provision
|
||||||
|
cannot be reformed, it shall be severed from this Public License
|
||||||
|
without affecting the enforceability of the remaining terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no
|
||||||
|
failure to comply consented to unless expressly agreed to by the
|
||||||
|
Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted
|
||||||
|
as a limitation upon, or waiver of, any privileges and immunities
|
||||||
|
that apply to the Licensor or You, including from the legal
|
||||||
|
processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public
|
||||||
|
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||||
|
its public licenses to material it publishes and in those instances
|
||||||
|
will be considered the “Licensor.” The text of the Creative Commons
|
||||||
|
public licenses is dedicated to the public domain under the CC0 Public
|
||||||
|
Domain Dedication. Except for the limited purpose of indicating that
|
||||||
|
material is shared under a Creative Commons public license or as
|
||||||
|
otherwise permitted by the Creative Commons policies published at
|
||||||
|
creativecommons.org/policies, Creative Commons does not authorize the
|
||||||
|
use of the trademark "Creative Commons" or any other trademark or logo
|
||||||
|
of Creative Commons without its prior written consent including,
|
||||||
|
without limitation, in connection with any unauthorized modifications
|
||||||
|
to any of its public licenses or any other arrangements,
|
||||||
|
understandings, or agreements concerning use of licensed material. For
|
||||||
|
the avoidance of doubt, this paragraph does not form part of the
|
||||||
|
public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
|
</pre>
|
||||||
|
</details>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
431
README.adoc
Normal file
431
README.adoc
Normal file
@ -0,0 +1,431 @@
|
|||||||
|
////
|
||||||
|
WireProto Specification © 2024 by Brent Saner is licensed under Creative Commons Attribution-ShareAlike 4.0 International. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/
|
||||||
|
////
|
||||||
|
|
||||||
|
= WireProto Specification
|
||||||
|
Brent Saner <bts@square-r00t.net>
|
||||||
|
Last rendered {localdatetime}
|
||||||
|
:doctype: book
|
||||||
|
:docinfo: shared
|
||||||
|
:data-uri:
|
||||||
|
:imagesdir: images
|
||||||
|
:sectlinks:
|
||||||
|
:sectnums:
|
||||||
|
:sectnumlevels: 7
|
||||||
|
:toc: preamble
|
||||||
|
:toc2: left
|
||||||
|
:idprefix:
|
||||||
|
:toclevels: 7
|
||||||
|
:source-highlighter: rouge
|
||||||
|
:docinfo: shared
|
||||||
|
:this_protover: 1
|
||||||
|
:this_protover_hex: 0x00000001
|
||||||
|
:lib_ver: master
|
||||||
|
:lib_ver_ref: branch
|
||||||
|
|
||||||
|
[id="license"]
|
||||||
|
== License
|
||||||
|
|
||||||
|
++++
|
||||||
|
include::LICENSE.html[]
|
||||||
|
++++
|
||||||
|
|
||||||
|
In a nutshell, means you can:
|
||||||
|
|
||||||
|
* Use it in commercial/proprietary/internal works...
|
||||||
|
* Expand upon/change the specification...
|
||||||
|
** (As long as it is released under the same Creative Commons license)
|
||||||
|
|
||||||
|
As long as you attribute the original (this document). This can be as simple as something like:
|
||||||
|
|
||||||
|
====
|
||||||
|
Based on WireProto version <protocol version> as found at https://wireproto.io/.
|
||||||
|
====
|
||||||
|
|
||||||
|
More details certainly helps, though; you may want to mention the exact date you "forked" it, etc.
|
||||||
|
|
||||||
|
Please see the full text as collapsed above or https://creativecommons.org/licenses/by-sa/4.0/legalcode.en[the online version^] of the license for full legal copy.
|
||||||
|
|
||||||
|
NOTE: In the event of the embedded text in this document differing from the online version, the online version is assumed to take precedence as the valid license applicable to this work.
|
||||||
|
|
||||||
|
[id="proto"]
|
||||||
|
== Protocol
|
||||||
|
The WireProto data packing API is a custom wire protocol//message format designed for incredibly performant, unambiguous, predictable, platform-agnostic, client-agnostic communication. It is based heavily on the https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key[OpenSSH "v1" key format^] https://git.r00t2.io/r00t2/go_sshkeys/src/branch/master/_ref/KEY_GUIDE.html#v1_plain_2[(example/details)] packing method.
|
||||||
|
|
||||||
|
It supports arbitrary binary values, which means they can be anything according to the implementation-specific details; a common practice is to encode ("marshal") a Go struct to JSON bytes, and set that as a WireProto field's value.
|
||||||
|
|
||||||
|
It supports both static construction/parsing/dissection and stream approaches in a single format, as well as multiple commands per request message/multiple answers per response message.
|
||||||
|
|
||||||
|
*All* packed uint32 values are big-endian.
|
||||||
|
|
||||||
|
This specification <<proto_ver>> is `{this_protover}` (`{this_protover_hex}`).
|
||||||
|
|
||||||
|
[id="lib"]
|
||||||
|
=== Library
|
||||||
|
This protocol specification is accompanied with a reference library for Golang, https://git.r00t2.io/r00t2/go_wireproto["WireProto"^] (https://git.r00t2.io/r00t2/wireproto[_source_^]):
|
||||||
|
|
||||||
|
++++
|
||||||
|
<a href="https://pkg.go.dev/go.pkg.dev/r00t2.io/wireproto">
|
||||||
|
<img src="https://pkg.go.dev/badge/go.pkg.dev/r00t2.io/wireproto.svg"
|
||||||
|
alt="Go Reference">
|
||||||
|
</a>
|
||||||
|
++++
|
||||||
|
|
||||||
|
[id="ytho"]
|
||||||
|
=== Why a Custom Message Format?
|
||||||
|
Because existing ones (e.g. JSON, XML, YAML) are slow/bloaty, inaccurate, and/or inflexible. They struggle with binary or abritrary data (or in e.g. XML's case requiring intermediate conditional encoding/decoding).
|
||||||
|
|
||||||
|
If it can be represented as bytes (which all digital data can), WireProto can send and receive it.
|
||||||
|
|
||||||
|
Additionally:
|
||||||
|
|
||||||
|
* https://protobuf.dev/[*Protobuf*^] has performance issues (yes, really; protobufs have large overhead) and is restrictive on data types for future-proofing.
|
||||||
|
* https://go.dev/blog/gob[*Gob*^] is very language-limiting and does not support e.g. nil pointers and cyclical values.
|
||||||
|
* https://capnproto.org/[Cap'n Proto^] has wide language support and excellent performance but is terribly non-idiomatic, requiring the code to be generated from the schema and not vice versa (which is only ideal if you have only one communication interface).
|
||||||
|
* https://en.wikipedia.org/wiki/JSON_streaming[JSON streams^] have no delimiters defined, and thus this makes it an inconvenience if using a parser that does not know when the message ends/is complete, or if it is expecting a standalone JSON object.
|
||||||
|
|
||||||
|
[TIP]
|
||||||
|
====
|
||||||
|
WireProto is only used for binary packing/unpacking; this means it can be used with any e.g. https://pkg.go.dev/net#Conn[`net.Conn`^] (and even has helper functions explicitly to facilitate this), storage on-disk, etc.
|
||||||
|
|
||||||
|
Thus it is transport/storage-agnostic, and can be used with a https://pkg.go.dev/net#Dial[TCP socket, UDP socket, IPC (InterProcess Communication)/UDS (UNIX Domain Socket) handle,^] https://pkg.go.dev/crypto/tls#Dial[TLS-tunneled TCP socket^], etc.
|
||||||
|
====
|
||||||
|
|
||||||
|
[id="msg"]
|
||||||
|
== Message Format
|
||||||
|
|
||||||
|
[TIP]
|
||||||
|
====
|
||||||
|
Throughout this document, you may see references to things like `LF`, `SOH`, and so forth.
|
||||||
|
|
||||||
|
These refer to _ASCII control characters_. You will also see many values represented in hex.
|
||||||
|
|
||||||
|
You can find more details about this (along with a full ASCII reference) https://square-r00t.net/ascii.html[here^]. Note that the socket API fully supports UTF-8 -- just be sure that your <<alloc_size>> are aligned to the byte count, not character count.
|
||||||
|
====
|
||||||
|
|
||||||
|
Each *message* is generally composed of:
|
||||||
|
|
||||||
|
* The <<msg_respstatus>>footnote:responly[Response messages only.]
|
||||||
|
* A <<cksum, Checksum>>footnote:optclient[Optional for Request.]footnote:reqsrv[Required for Response.]
|
||||||
|
* A <<proto_ver>>
|
||||||
|
* A <<hdrs_msgstart>>
|
||||||
|
* A <<msg_grp>> <<alloc_cnt>>
|
||||||
|
* A <<msg_grp>> <<alloc_size>>
|
||||||
|
* A <<hdrs_bodystart>>
|
||||||
|
* One (or more) <<msg_grp>>(s), each of which contain:
|
||||||
|
** One (or more) <<msg_grp_rec>>(s), each of which contain:
|
||||||
|
*** One (or more) <<msg_grp_rec_kv, Field/Value pair>>(s), each of which contain:
|
||||||
|
**** A <<msg_grp_rec_kv_nm>>
|
||||||
|
**** A <<msg_grp_rec_kv_val>>
|
||||||
|
**** A <<msg_grp_recresp, Copy Record>>footnote:responly[]
|
||||||
|
* A <<hdrs_bodyend>>
|
||||||
|
* A <<hdrs_msgend>>
|
||||||
|
|
||||||
|
[id="msg_respstatus"]
|
||||||
|
=== Response Status
|
||||||
|
For responses, their messages have an additional byte prepended; a status indicator.
|
||||||
|
This allows client programs to quickly bail in the case of an error if no further parsing is desired.
|
||||||
|
|
||||||
|
The status will be indicated by one of <<hdrs_respstart, two values>>: an ASCII `ACK` (`0x06`) for all requests being returned successfully or an ASCII `NAK` (`0x15`) if one or more errors were encountered across all records.
|
||||||
|
|
||||||
|
[id="proto_ver"]
|
||||||
|
=== Protocol Version
|
||||||
|
The protocol version is a packed uint32 that denotes which version of this protocol specification is being used.
|
||||||
|
|
||||||
|
It is maintained seperately from the *library* version/repo tags.
|
||||||
|
|
||||||
|
The current protocol version (as demonstrated in this document) is `{this_protover}` (`{this_protover_hex}`).
|
||||||
|
|
||||||
|
NOTE: Version `0` is reserved for current `HEAD` of the `master` branch of this specification and should be considered experimental.
|
||||||
|
|
||||||
|
[id="msg_grp"]
|
||||||
|
=== Record Group
|
||||||
|
A record group contains multiple related <<msg_grp_rec, Records>>. It is common to only have a single Record Group.
|
||||||
|
|
||||||
|
Its structure is:
|
||||||
|
|
||||||
|
. <<msg_grp_rec>> <<alloc_cnt>>
|
||||||
|
. <<msg_grp_rec>> <<alloc_size>>
|
||||||
|
. One (or more) <<msg_grp_rec, Records>>
|
||||||
|
|
||||||
|
[id="msg_grp_rec"]
|
||||||
|
==== Record
|
||||||
|
A record contains multiple related <<msg_grp_rec_kv, Field/Value Pairs (FVP)>>. It is typical to only have a single Record.
|
||||||
|
|
||||||
|
Its structure is:
|
||||||
|
|
||||||
|
. <<msg_grp_rec_kv>> <<alloc_cnt>>
|
||||||
|
. <<msg_grp_rec_kv>> <<alloc_size>>
|
||||||
|
. One (or more) <<msg_grp_rec_kv, Field/Value Pairs>>
|
||||||
|
|
||||||
|
[IMPORTANT]
|
||||||
|
====
|
||||||
|
For response messages, the record's size allocator (but NOT the count allocator) includes the <<msg_grp_recresp, Copy Record>> size for each response record copy!footnote:responly[]
|
||||||
|
====
|
||||||
|
|
||||||
|
[id="msg_grp_rec_kv"]
|
||||||
|
===== Field/Value Pair (Key/Value Pair)
|
||||||
|
A field/value pair (also referred to as a key/value pair) contains a matched <<msg_grp_rec_kv_nm>> and its <<msg_grp_rec_kv_val>>.
|
||||||
|
|
||||||
|
Its structure is:
|
||||||
|
|
||||||
|
. <<msg_grp_rec_kv_nm>> <<alloc_size>>
|
||||||
|
. <<msg_grp_rec_kv_val>> <<alloc_size>>
|
||||||
|
. A single <<msg_grp_rec_kv_nm>>
|
||||||
|
. A single matching <<msg_grp_rec_kv_val>>
|
||||||
|
|
||||||
|
[IMPORTANT]
|
||||||
|
====
|
||||||
|
Unlike most/all other <<alloc>> for other sections/levels, the field name and value allocators are consecutive <<alloc_size, Size Allocators>>! This is because there is only one field name and value per record.
|
||||||
|
====
|
||||||
|
|
||||||
|
[id="msg_grp_rec_kv_nm"]
|
||||||
|
====== Field Name
|
||||||
|
The field name is usually from a finite set of allowed names. The <<msg_grp_rec_kv_val>>, while written as bytes, often contains a data structure defined by the field name. (A field name is closer to a "value type".) It *must* be a UTF-8 string.
|
||||||
|
|
||||||
|
Its structure is:
|
||||||
|
|
||||||
|
. The name in bytes
|
||||||
|
|
||||||
|
[id="msg_grp_rec_kv_val"]
|
||||||
|
====== Field Value
|
||||||
|
A field's value is, on the wire, just a series of bytes. The actual content of those bytes, including any structure or encoding, is likely to/probably depends on the paired <<msg_grp_rec_kv_nm>>.
|
||||||
|
|
||||||
|
Its structure is:
|
||||||
|
|
||||||
|
. The value in bytes
|
||||||
|
|
||||||
|
[id="msg_grp_recresp"]
|
||||||
|
===== Copy Record (Response Copy of Request)
|
||||||
|
This contains a "copy" of the original/request's <<msg_grp_rec>> that this record is in response to.
|
||||||
|
|
||||||
|
It is a variant of a <<msg_grp_rec>> used exclusively in responses, and is tied to (included in) each response's <<msg_grp_rec_kv, FVP>>.
|
||||||
|
|
||||||
|
Its structure is:
|
||||||
|
|
||||||
|
. <<msg_grp_rec_kvcpy>> <<alloc_cnt>>
|
||||||
|
. <<msg_grp_rec_kvcpy>> <<alloc_size>>
|
||||||
|
. One (or more) <<msg_grp_rec_kvcpy, Field/Value Pairs (Response Copy)>>
|
||||||
|
|
||||||
|
[id="msg_grp_rec_kvcpy"]
|
||||||
|
====== Field/Value Pair (Key/Value Pair) (Response Copy)
|
||||||
|
A field/value pair (also referred to as a key/value pair) contains a matched <<msg_grp_rec_kv_nm>> and its <<msg_grp_rec_kv_val>>.
|
||||||
|
|
||||||
|
It is a variant of a <<msg_grp_rec_kv, Field/Value Pair>> used exclusively in response copies of the original request's FVP.
|
||||||
|
|
||||||
|
Its structure is:
|
||||||
|
|
||||||
|
. <<msg_grp_rec_kv_nm>> <<alloc_size>>
|
||||||
|
. <<msg_grp_rec_kv_val>> <<alloc_size>>
|
||||||
|
. A single <<msg_grp_rec_kv_nm>>
|
||||||
|
. A single matching <<msg_grp_rec_kv_val>>
|
||||||
|
|
||||||
|
[IMPORTANT]
|
||||||
|
====
|
||||||
|
Unlike most/all other <<alloc>> for other sections/levels, the field name and value allocators are consecutive <<alloc_size, Size Allocators>>! This is because there is only one field name and value per record.
|
||||||
|
====
|
||||||
|
|
||||||
|
[id="cksum"]
|
||||||
|
== Checksums
|
||||||
|
Checksums are optional for the client but the server will *always* send them. *If present* in the request, the server will validate to ensure the checksum matches the message body (<<hdrs_bodystart, body start>> to <<hdrs_bodyend, body end>>, headers included). If the checksum does not match, an error will be returned.
|
||||||
|
|
||||||
|
They are represented as a big-endian-packed uint32.
|
||||||
|
|
||||||
|
The checksum must be prefixed with a <<hdrs_cksum>>. If no checksum is provided, this prefix must *not* be included in the sequence.
|
||||||
|
|
||||||
|
[TIP]
|
||||||
|
====
|
||||||
|
You can quickly check if a checksum is present by checking the first byte in requests or the second byte in responses. If it is `ESC` (`0x1b`), a checksum is provided. If it is `SOH` (`0x01`), one was *not* provided.
|
||||||
|
====
|
||||||
|
|
||||||
|
The checksum method used is the https://users.ece.cmu.edu/~koopman/crc/crc32.html[IEEE 802.3 CRC-32^], which should be natively available for all/most client implementations as it is perhaps the most ubiquitous of CRC-32 variants. (Polynomial `0x04c11db7`, reversed polynomial `0xedb88320`.)
|
||||||
|
|
||||||
|
To confirm you are using the correct CRC32 implementation (as there are a *ton* of "CRC-32" algorithms and methods out there), use the following validations:
|
||||||
|
|
||||||
|
.CRC-32 Validations
|
||||||
|
[cols="^.^2m,3m,^.^1m,^.^2m,^.^2m",options="header"]
|
||||||
|
|===
|
||||||
|
| String ^.^| Bytes | Checksum (integer) | Checksum (bytes, little-endian) | Checksum (bytes, big-endian)
|
||||||
|
|
||||||
|
| FooBarBazQuux | 0x466f6f42617242617a51757578 | 983022564 | 0xe4bb973a | 0x3a97bbe4
|
||||||
|
| 0123456789abcdef | 0x30313233343536373839616263646566 | 1757737011 | 0x33f0c468 | 0x68c4f033
|
||||||
|
|===
|
||||||
|
|
||||||
|
[id="hdrs"]
|
||||||
|
== Headers
|
||||||
|
Certain sections are wrapped with an identifying header. Those headers are included below for reference.
|
||||||
|
|
||||||
|
[id="hdrs_respstart"]
|
||||||
|
=== `RESPSTART` Byte Sequence
|
||||||
|
Responses have a <<msg_respstatus>>.footnote:responly[]
|
||||||
|
|
||||||
|
It is either an `ACK` (`0x06`) or `NAK` (`0x15`).
|
||||||
|
|
||||||
|
[id="hdrs_cksum"]
|
||||||
|
=== `CKSUM` Header Prefix
|
||||||
|
A checksum, if provided, will have a prefix header of `ESC` (`0x1b`).
|
||||||
|
|
||||||
|
[id="hdrs_msgstart"]
|
||||||
|
=== `MSGSTART` Header Prefix
|
||||||
|
The message start header indicates a start of a message.
|
||||||
|
|
||||||
|
It is an `SOH` (`0x01`).
|
||||||
|
|
||||||
|
[id="hdrs_bodystart"]
|
||||||
|
=== `BODYSTART` Header Prefix
|
||||||
|
The body start header indicates that actual data/records follows.
|
||||||
|
|
||||||
|
It is an `STX` (`0x02`).
|
||||||
|
|
||||||
|
[id="hdrs_bodyend"]
|
||||||
|
=== `BODYEND` Sequence
|
||||||
|
The body end prefix indicates the end of data/records.
|
||||||
|
|
||||||
|
It is an `ETX` (`0x03`).
|
||||||
|
|
||||||
|
[id="hdrs_msgend"]
|
||||||
|
=== `MSGEND` Sequence
|
||||||
|
The message end prefix indicates that a message in its entirety has ended.
|
||||||
|
|
||||||
|
It is an `EOT` (`0x04`).
|
||||||
|
|
||||||
|
[id="alloc"]
|
||||||
|
== Allocators
|
||||||
|
There are two type of allocators included for each following sequence of bytes: `count allocators` and `size allocators`.
|
||||||
|
|
||||||
|
They can be used by clients to determine the size of destination buffers, and are used by the server to efficiently unpack requests.
|
||||||
|
|
||||||
|
They are usually paired together with the count allocator preceding the size allocator, but not always (e.g. <<msg_grp_rec_kv>> have two <<alloc_size>>).
|
||||||
|
|
||||||
|
All allocators are unsigned 32-bit integers, little-endian-packed.
|
||||||
|
|
||||||
|
[id="alloc_cnt"]
|
||||||
|
=== Count Allocator
|
||||||
|
Count allocators indicate *how many* children objects are contained.
|
||||||
|
|
||||||
|
[id="alloc_size"]
|
||||||
|
=== Size Allocator
|
||||||
|
Size allocators indicate *how much* (in bytes) all children objects are combined together. It includes e.g. separators, etc.
|
||||||
|
|
||||||
|
[id="ref"]
|
||||||
|
== Reference Model and Examples
|
||||||
|
For a more visual explanation, given the following e.g. Golang structs from the https://pkg.go.dev/r00t2.io/wireproto[Golang reference library^] (`wireproto.Request{}` and `wireproto.Response{}`):
|
||||||
|
|
||||||
|
[id="ref_single"]
|
||||||
|
=== Single/Simple
|
||||||
|
|
||||||
|
[id="ref_single_req"]
|
||||||
|
==== Single/Simple Request
|
||||||
|
[%collapsible]
|
||||||
|
.Example Message Structure (Simple Request)
|
||||||
|
====
|
||||||
|
[source,go]
|
||||||
|
----
|
||||||
|
include::https://git.r00t2.io/r00t2/go_wireproto/raw/{lib_ver_ref}/{lib_ver}/test_obj_simple_req.go[]
|
||||||
|
----
|
||||||
|
====
|
||||||
|
|
||||||
|
Would then serialize as (in hex):
|
||||||
|
|
||||||
|
[%collapsible]
|
||||||
|
.Annotated Hex
|
||||||
|
====
|
||||||
|
[source,text]
|
||||||
|
----
|
||||||
|
include::docs/data/request.simple.txt[]
|
||||||
|
----
|
||||||
|
====
|
||||||
|
|
||||||
|
Or, non-annotated:
|
||||||
|
[source,text]
|
||||||
|
----
|
||||||
|
include::docs/data/request.simple.hex[]
|
||||||
|
----
|
||||||
|
|
||||||
|
[id="ref_single_resp"]
|
||||||
|
==== Single/Simple Response
|
||||||
|
[%collapsible]
|
||||||
|
.Example Message Structure (Simple Response)
|
||||||
|
====
|
||||||
|
[source,go]
|
||||||
|
----
|
||||||
|
include::https://git.r00t2.io/r00t2/go_wireproto/raw/{lib_ver_ref}/{lib_ver}/test_obj_simple_resp.go[]
|
||||||
|
----
|
||||||
|
====
|
||||||
|
|
||||||
|
Would then serialize as (in hex):
|
||||||
|
|
||||||
|
[%collapsible]
|
||||||
|
.Annotated Hex
|
||||||
|
====
|
||||||
|
[source,text]
|
||||||
|
----
|
||||||
|
include::docs/data/response.simple.txt[]
|
||||||
|
----
|
||||||
|
====
|
||||||
|
|
||||||
|
Or, non-annotated:
|
||||||
|
[source,text]
|
||||||
|
----
|
||||||
|
include::docs/data/response.simple.hex[]
|
||||||
|
----
|
||||||
|
|
||||||
|
[id="ref_multi"]
|
||||||
|
=== Multiple/Many/Complex
|
||||||
|
Multiple commands, parameters, etc. can be specified in one message.
|
||||||
|
|
||||||
|
[id="ref_multi_req"]
|
||||||
|
==== Complex Request
|
||||||
|
[%collapsible]
|
||||||
|
.Example Message Structure (Multiple/Many Requests, Single Message)
|
||||||
|
====
|
||||||
|
[source,go]
|
||||||
|
----
|
||||||
|
include::https://git.r00t2.io/r00t2/go_wireproto/raw/{lib_ver_ref}/{lib_ver}/test_obj_multi_req.go[]
|
||||||
|
----
|
||||||
|
====
|
||||||
|
|
||||||
|
Would then serialize as (in hex):
|
||||||
|
|
||||||
|
[%collapsible]
|
||||||
|
.Annotated Hex
|
||||||
|
====
|
||||||
|
[source,text]
|
||||||
|
----
|
||||||
|
include::docs/data/request.multi.txt[]
|
||||||
|
----
|
||||||
|
====
|
||||||
|
|
||||||
|
Or, non-annotated:
|
||||||
|
[source,text]
|
||||||
|
----
|
||||||
|
include::docs/data/request.multi.hex[]
|
||||||
|
----
|
||||||
|
|
||||||
|
[id="ref_multi_resp"]
|
||||||
|
==== Complex Response
|
||||||
|
[%collapsible]
|
||||||
|
.Example Message Structure (Response to Multiple/Many Requests, Single Message)
|
||||||
|
====
|
||||||
|
[source,go]
|
||||||
|
----
|
||||||
|
include::https://git.r00t2.io/r00t2/go_wireproto/raw/{lib_ver_ref}/{lib_ver}/test_obj_multi_resp.go[]
|
||||||
|
----
|
||||||
|
====
|
||||||
|
|
||||||
|
Would then serialize as (in hex):
|
||||||
|
|
||||||
|
[%collapsible]
|
||||||
|
.Annotated Hex
|
||||||
|
====
|
||||||
|
[source,text]
|
||||||
|
----
|
||||||
|
include::docs/data/response.multi.txt[]
|
||||||
|
----
|
||||||
|
====
|
||||||
|
|
||||||
|
Or, non-annotated:
|
||||||
|
[source,text]
|
||||||
|
----
|
||||||
|
include::docs/data/response.multi.hex[]
|
||||||
|
----
|
||||||
77
docinfo.html
Normal file
77
docinfo.html
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
<!-- https://stackoverflow.com/a/34481639 -->
|
||||||
|
<!-- Generate a nice TOC -->
|
||||||
|
<script src="https://code.jquery.com/jquery-1.11.3.min.js"></script>
|
||||||
|
<script src="https://code.jquery.com/ui/1.11.4/jquery-ui.min.js"></script>
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/javascripts/jquery.tocify.min.js"></script>
|
||||||
|
<!-- We do not need the tocify CSS because the asciidoc CSS already provides most of what we neeed -->
|
||||||
|
|
||||||
|
<style>
|
||||||
|
.tocify-header {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tocify-subheader {
|
||||||
|
font-style: normal;
|
||||||
|
font-size: 90%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tocify ul {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tocify-focus {
|
||||||
|
color: #7a2518;
|
||||||
|
background-color: rgba(0, 0, 0, 0.1);
|
||||||
|
}
|
||||||
|
|
||||||
|
.tocify-focus > a {
|
||||||
|
color: #7a2518;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(function () {
|
||||||
|
// Add a new container for the tocify toc into the existing toc so we can re-use its
|
||||||
|
// styling
|
||||||
|
$("#toc").append("<div id='generated-toc'></div>");
|
||||||
|
$("#generated-toc").tocify({
|
||||||
|
extendPage: true,
|
||||||
|
context: "#content",
|
||||||
|
highlightOnScroll: true,
|
||||||
|
hideEffect: "slideUp",
|
||||||
|
// Use the IDs that asciidoc already provides so that TOC links and intra-document
|
||||||
|
// links are the same. Anything else might confuse users when they create bookmarks.
|
||||||
|
hashGenerator: function(text, element) {
|
||||||
|
return $(element).attr("id");
|
||||||
|
},
|
||||||
|
// Smooth scrolling doesn't work properly if we use the asciidoc IDs
|
||||||
|
smoothScroll: false,
|
||||||
|
// Set to 'none' to use the tocify classes
|
||||||
|
theme: "none",
|
||||||
|
// Handle book (may contain h1) and article (only h2 deeper)
|
||||||
|
selectors: $( "#content" ).has( "h1" ).size() > 0 ? "h1,h2,h3,h4,h5" : "h2,h3,h4,h5",
|
||||||
|
ignoreSelector: ".discrete"
|
||||||
|
});
|
||||||
|
|
||||||
|
// Switch between static asciidoc toc and dynamic tocify toc based on browser size
|
||||||
|
// This is set to match the media selectors in the asciidoc CSS
|
||||||
|
// Without this, we keep the dynamic toc even if it is moved from the side to preamble
|
||||||
|
// position which will cause odd scrolling behavior
|
||||||
|
var handleTocOnResize = function() {
|
||||||
|
if ($(document).width() < 768) {
|
||||||
|
$("#generated-toc").hide();
|
||||||
|
$(".sectlevel0").show();
|
||||||
|
$(".sectlevel1").show();
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$("#generated-toc").show();
|
||||||
|
$(".sectlevel0").hide();
|
||||||
|
$(".sectlevel1").hide();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$(window).resize(handleTocOnResize);
|
||||||
|
handleTocOnResize();
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
2382
docs/README.html
Normal file
2382
docs/README.html
Normal file
File diff suppressed because it is too large
Load Diff
60
docs/data/parse.py
Executable file
60
docs/data/parse.py
Executable file
@ -0,0 +1,60 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
################################################################################################################################
|
||||||
|
## WireProto Specification © 2024 by Brent Saner is licensed under Creative Commons Attribution-ShareAlike 4.0 International. ##
|
||||||
|
## To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/ ##
|
||||||
|
################################################################################################################################
|
||||||
|
|
||||||
|
import binascii
|
||||||
|
import re
|
||||||
|
import zlib
|
||||||
|
|
||||||
|
prefixes = ('request', 'response')
|
||||||
|
suffixes = ('simple', 'multi')
|
||||||
|
|
||||||
|
linecharlimit = 80
|
||||||
|
linestrp = re.compile(r'^\s*(?P<hex>[A-Fa-f0-9N]+)?(?:\s*//.*)?$')
|
||||||
|
|
||||||
|
|
||||||
|
def parse(text):
|
||||||
|
ret = []
|
||||||
|
bytelen = 0
|
||||||
|
for line in text.splitlines():
|
||||||
|
m = linestrp.search(line)
|
||||||
|
if not m:
|
||||||
|
continue
|
||||||
|
if not m.group('hex'):
|
||||||
|
continue
|
||||||
|
ret.append(m.group('hex'))
|
||||||
|
raw = ''.join(ret)
|
||||||
|
bytelen = int(len(raw) / 2)
|
||||||
|
ret = []
|
||||||
|
block = ''
|
||||||
|
for idx, c in enumerate(raw):
|
||||||
|
block = block + c
|
||||||
|
if len(block) == linecharlimit:
|
||||||
|
ret.append(block)
|
||||||
|
block = ''
|
||||||
|
if block:
|
||||||
|
ret.append(block)
|
||||||
|
return(('\n'.join(ret), bytelen))
|
||||||
|
|
||||||
|
|
||||||
|
for p in prefixes:
|
||||||
|
for s in suffixes:
|
||||||
|
fnamebase = '{0}.{1}'.format(p, s)
|
||||||
|
fname = '{0}.txt'.format(fnamebase)
|
||||||
|
with open(fname, 'r') as fh:
|
||||||
|
raw = fh.read().strip()
|
||||||
|
hexstr, bytelen = parse(raw)
|
||||||
|
with open('{0}.hex'.format(fnamebase), 'w') as fh:
|
||||||
|
fh.write(hexstr)
|
||||||
|
fh.write('\n')
|
||||||
|
b = binascii.unhexlify(hexstr.replace('\n', '').strip().encode('utf-8'))
|
||||||
|
repr = ['0x{0}'.format(format(i, '02x')) for i in b]
|
||||||
|
repr_split = []
|
||||||
|
for i in range(0, len(repr), 16):
|
||||||
|
repr_split.append(repr[i:i + 16])
|
||||||
|
print(fnamebase)
|
||||||
|
for i in repr_split:
|
||||||
|
print(', '.join(i), end = ',\n')
|
||||||
7
docs/data/request.multi.hex
Normal file
7
docs/data/request.multi.hex
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
01000000010200000002000000f00000000200000070000000020000003000000008000000086669
|
||||||
|
656c6441314176616c756541314100000008000000086669656c6441314276616c75654131420000
|
||||||
|
00020000003000000008000000086669656c6441324176616c756541324100000008000000086669
|
||||||
|
656c6441324276616c75654132420000000200000070000000020000003000000008000000086669
|
||||||
|
656c6442314176616c756542314100000008000000086669656c6442314276616c75654231420000
|
||||||
|
00020000003000000008000000086669656c6442324176616c756542324100000008000000086669
|
||||||
|
656c6442324276616c75654232420304
|
||||||
67
docs/data/request.multi.txt
Normal file
67
docs/data/request.multi.txt
Normal file
@ -0,0 +1,67 @@
|
|||||||
|
// REQUEST (Complex)
|
||||||
|
-------- // (No Checksum Present)
|
||||||
|
01 // HDR:MSGSTART
|
||||||
|
00000001 // Protocol Version (1)
|
||||||
|
02 // HDR:BODYSTART
|
||||||
|
00000002 // Record Group Count (2)
|
||||||
|
000000f0 // Record Groups Size (240)
|
||||||
|
// Record Group 1 (120 bytes)
|
||||||
|
00000002 // Record Count (2)
|
||||||
|
00000070 // Record Group Size (112)
|
||||||
|
// Record Group 1, Record 1 (56 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000030 // Record Size (48)
|
||||||
|
// Record Group 1, Record 1, Field/Value 1 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64413141 // "fieldA1A"
|
||||||
|
76616c7565413141 // "valueA1A"
|
||||||
|
// Record Group 1, Record 1, Field/Value 2 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64413142 // "fieldA1B"
|
||||||
|
76616c7565413142 // "valueA1B"
|
||||||
|
// Record Group 1, Record 2 (56 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000030 // Record Size (48)
|
||||||
|
// Record Group 1, Record 2, Field/Value 1 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64413241 // "fieldA2A"
|
||||||
|
76616c7565413241 // "valueA2A"
|
||||||
|
// Record Group 1, Record 2, Field/Value 2 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64413242 // "fieldA2B"
|
||||||
|
76616c7565413242 // "valueA2B"
|
||||||
|
// Record Group 2 (120 bytes)
|
||||||
|
00000002 // Record Count (2)
|
||||||
|
00000070 // Record Group Size (112)
|
||||||
|
// Record Group 2, Record 1 (56 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000030 // Record Size (48)
|
||||||
|
// Record Group 2, Record 1, Field/Value 1 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64423141 // "fieldB1A"
|
||||||
|
76616c7565423141 // "valueB1A"
|
||||||
|
// Record Group 2, Record 1, Field/Value 2 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64423142 // "fieldB1B"
|
||||||
|
76616c7565423142 // "valueB1B"
|
||||||
|
// Record Group 2, Record 2 (56 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000030 // Record Size (48)
|
||||||
|
// Record Group 2, Record 2, Field/Value 1 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64423241 // "fieldB2A"
|
||||||
|
76616c7565423241 // "valueB2A"
|
||||||
|
// Record Group 2, Record 2, Field/Value 2 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64423242 // "fieldB2B"
|
||||||
|
76616c7565423242 // "valueB2B"
|
||||||
|
03 // HDR:BODYEND
|
||||||
|
04 // HDR:MSGEND
|
||||||
2
docs/data/request.simple.hex
Normal file
2
docs/data/request.simple.hex
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
01000000010200000001000000380000000100000030000000020000002800000006000000066669
|
||||||
|
656c643176616c75653100000006000000066669656c643276616c7565320304
|
||||||
25
docs/data/request.simple.txt
Normal file
25
docs/data/request.simple.txt
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
// REQUEST (Simple)
|
||||||
|
-------- // (No Checksum Present)
|
||||||
|
01 // HDR:MSGSTART
|
||||||
|
00000001 // Protocol Version (1)
|
||||||
|
02 // HDR:BODYSTART
|
||||||
|
00000001 // Record Group Count (1)
|
||||||
|
00000038 // Record Groups Size (56)
|
||||||
|
// Record Group 1 (56 bytes)
|
||||||
|
00000001 // Record Count (1)
|
||||||
|
00000030 // Record Group Size (48)
|
||||||
|
// Record Group 1, Record 1 (48 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000028 // Record Size (40)
|
||||||
|
// Record Group 1, Record 1, Field/Value 1 (20 bytes)
|
||||||
|
00000006 // Field Name Size (6)
|
||||||
|
00000006 // Field Value Size (6)
|
||||||
|
6669656c6431 // "field1"
|
||||||
|
76616c756531 // "value1"
|
||||||
|
// Record Group 1, Record 1, Field/Value 2 (20 bytes)
|
||||||
|
00000006 // Field Name Size (6)
|
||||||
|
00000006 // Field Value Size (6)
|
||||||
|
6669656c6432 // "field2"
|
||||||
|
76616c756532 // "value2"
|
||||||
|
03 // HDR:BODYEND
|
||||||
|
04 // HDR:MSGEND
|
||||||
11
docs/data/response.multi.hex
Normal file
11
docs/data/response.multi.hex
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
061bd0ba719f010000000102000000020000019800000002000000c4000000010000001e00000038
|
||||||
|
00000006000000106461746141313c61726269747261727920646174613e00000002000000300000
|
||||||
|
0008000000086669656c6441314176616c756541314100000008000000086669656c644131427661
|
||||||
|
6c7565413142000000010000001e0000003800000006000000106461746141323c61726269747261
|
||||||
|
727920646174613e000000020000003000000008000000086669656c6441324176616c7565413241
|
||||||
|
00000008000000086669656c6441324276616c756541324200000002000000c4000000010000001e
|
||||||
|
0000003800000006000000106461746142313c61726269747261727920646174613e000000020000
|
||||||
|
003000000008000000086669656c6442314176616c756542314100000008000000086669656c6442
|
||||||
|
314276616c7565423142000000010000001e0000003800000006000000106461746142323c617262
|
||||||
|
69747261727920646174613e000000020000003000000008000000086669656c6442324176616c75
|
||||||
|
6542324100000008000000086669656c6442324276616c75654232420304
|
||||||
109
docs/data/response.multi.txt
Normal file
109
docs/data/response.multi.txt
Normal file
@ -0,0 +1,109 @@
|
|||||||
|
// RESPONSE (Complex)
|
||||||
|
06 // HDR:RESPSTART (Status: OK)
|
||||||
|
1b // HDR:CKSUM
|
||||||
|
d0ba719f // Checksum Value (3501879711)
|
||||||
|
01 // HDR:MSGSTART
|
||||||
|
00000001 // Protocol Version (1)
|
||||||
|
02 // HDR:BODYSTART
|
||||||
|
00000002 // Record Group Count (2)
|
||||||
|
00000198 // Record Groups Size (408)
|
||||||
|
// Record Group 1 (204)
|
||||||
|
00000002 // Record Count (2)
|
||||||
|
000000c4 // Record Group Size (196)
|
||||||
|
// Record Group 1, Record 1 (98 bytes)
|
||||||
|
00000001 // Field/Value Count (1)
|
||||||
|
0000001e // Record Size (30)
|
||||||
|
00000038 // Request Record Size (56)
|
||||||
|
// Record Group 1, Record 1, Field/Value 1 (30 bytes)
|
||||||
|
00000006 // Field Name Size (6)
|
||||||
|
00000010 // Field Value Size (16)
|
||||||
|
646174614131 // "dataA1"
|
||||||
|
3c6172626974726172792064 // "<arbitrary data>"
|
||||||
|
6174613e
|
||||||
|
// Record Group 1, Record 1 (REQUEST RECORD) (56 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000030 // Record Size (48)
|
||||||
|
// Record Group 1, Record 1, Field/Value 1 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64413141 // "fieldA1A"
|
||||||
|
76616c7565413141 // "valueA1A"
|
||||||
|
// Record Group 1, Record 1, Field/Value 2 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64413142 // "fieldA1B"
|
||||||
|
76616c7565413142 // "valueA1B"
|
||||||
|
// Record Group 1, Record 2 (98 bytes)
|
||||||
|
00000001 // Field/Value Count (1)
|
||||||
|
0000001e // Record Size (30)
|
||||||
|
00000038 // Request Record Size (56)
|
||||||
|
// Record Group 1, Record 2, Field/Value 1 (30 bytes)
|
||||||
|
00000006 // Field Name Size (6)
|
||||||
|
00000010 // Field Value Size (16)
|
||||||
|
646174614132 // "dataA2"
|
||||||
|
3c6172626974726172792064 // "<arbitrary data>"
|
||||||
|
6174613e
|
||||||
|
// Record Group 1, Record 2 (REQUEST RECORD) (56 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000030 // Record Size (48)
|
||||||
|
// Record Group 1, Record 2, Field/Value 1 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64413241 // "fieldA2A"
|
||||||
|
76616c7565413241 // "valueA2A"
|
||||||
|
// Record Group 1, Record 2, Field/Value 2 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64413242 // "fieldA2B"
|
||||||
|
76616c7565413242 // "valueA2B"
|
||||||
|
// Record Group 2 (204)
|
||||||
|
00000002 // Record Count (2)
|
||||||
|
000000c4 // Record Group Size (196)
|
||||||
|
// Record Group 2, Record 1 (98 bytes)
|
||||||
|
00000001 // Field/Value Count (1)
|
||||||
|
0000001e // Record Size (30)
|
||||||
|
00000038 // Request Record Size (56)
|
||||||
|
// Record Group 2, Record 1, Field/Value 1 (30 bytes)
|
||||||
|
00000006 // Field Name Size (6)
|
||||||
|
00000010 // Field Value Size (16)
|
||||||
|
646174614231 // "dataB1"
|
||||||
|
3c6172626974726172792064 // "<arbitrary data>"
|
||||||
|
6174613e
|
||||||
|
// Record Group 2, Record 1 (REQUEST RECORD) (56 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000030 // Record Size (48)
|
||||||
|
// Record Group 2, Record 1, Field/Value 1 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64423141 // "fieldB1A"
|
||||||
|
76616c7565423141 // "valueB1A"
|
||||||
|
// Record Group 2, Record 1, Field/Value 2 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64423142 // "fieldB1B"
|
||||||
|
76616c7565423142 // "valueB1B"
|
||||||
|
// Record Group 2, Record 2 (98 bytes)
|
||||||
|
00000001 // Field/Value Count (1)
|
||||||
|
0000001e // Record Size (30)
|
||||||
|
00000038 // Request Record Size (56)
|
||||||
|
// Record Group 2, Record 2, Field/Value 1 (30 bytes)
|
||||||
|
00000006 // Field Name Size (6)
|
||||||
|
00000010 // Field Value Size (16)
|
||||||
|
646174614232 // "dataB2"
|
||||||
|
3c6172626974726172792064 // "<arbitrary data>"
|
||||||
|
6174613e
|
||||||
|
// Record Group 2, Record 2 (REQUEST RECORD) (56 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000030 // Record Size (48)
|
||||||
|
// Record Group 2, Record 2, Field/Value 1 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64423241 // "fieldB2A"
|
||||||
|
76616c7565423241 // "valueB2A"
|
||||||
|
// Record Group 2, Record 2, Field/Value 2 (24 bytes)
|
||||||
|
00000008 // Field Name Size (8)
|
||||||
|
00000008 // Field Value Size (8)
|
||||||
|
6669656c64423242 // "fieldB2B"
|
||||||
|
76616c7565423242 // "valueB2B"
|
||||||
|
03 // HDR:BODYEND
|
||||||
|
04 // HDR:MSGEND
|
||||||
3
docs/data/response.simple.hex
Normal file
3
docs/data/response.simple.hex
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
061b5fde82e501000000010200000001000000610000000100000059000000010000001d00000030
|
||||||
|
000000050000001064617461313c61726269747261727920646174613e0000000200000028000000
|
||||||
|
06000000066669656c643176616c75653100000006000000066669656c643276616c7565320304
|
||||||
37
docs/data/response.simple.txt
Normal file
37
docs/data/response.simple.txt
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
// RESPONSE (Simple)
|
||||||
|
06 // HDR:RESPSTART (Status: OK)
|
||||||
|
1b // HDR:CKSUM
|
||||||
|
5fde82e5 // Checksum Value (1608418021)
|
||||||
|
01 // HDR:MSGSTART
|
||||||
|
00000001 // Protocol Version (1)
|
||||||
|
02 // HDR:BODYSTART
|
||||||
|
00000001 // Record Group Count (1)
|
||||||
|
00000061 // Record Groups Size (97)
|
||||||
|
// Record Group 1 (97)
|
||||||
|
00000001 // Record Count (1)
|
||||||
|
00000059 // Record Group Size (89)
|
||||||
|
// Record Group 1, Record 1 (89 bytes)
|
||||||
|
00000001 // Field/Value Count (1)
|
||||||
|
0000001d // Record Size (29)
|
||||||
|
00000030 // Request Record Size (48)
|
||||||
|
// Record Group 1, Record 1, Field/Value 1 (29 bytes)
|
||||||
|
00000005 // Field Name Size (5)
|
||||||
|
00000010 // Field Value Size (16)
|
||||||
|
6461746131 // "data1"
|
||||||
|
3c6172626974726172792064 // "<arbitrary data>"
|
||||||
|
6174613e
|
||||||
|
// Record Group 1, Record 1 (REQUEST RECORD) (48 bytes)
|
||||||
|
00000002 // Field/Value Count (2)
|
||||||
|
00000028 // Record Size (40)
|
||||||
|
// Record Group 1, Record 1, Field/Value 1 (20 bytes)
|
||||||
|
00000006 // Field Name Size (6)
|
||||||
|
00000006 // Field Value Size (6)
|
||||||
|
6669656c6431 // "field1"
|
||||||
|
76616c756531 // "value1"
|
||||||
|
// Record Group 1, Record 1, Field/Value 2 (20 bytes)
|
||||||
|
00000006 // Field Name Size (6)
|
||||||
|
00000006 // Field Value Size (6)
|
||||||
|
6669656c6432 // "field2"
|
||||||
|
76616c756532 // "value2"
|
||||||
|
03 // HDR:BODYEND
|
||||||
|
04 // HDR:MSGEND
|
||||||
Loading…
Reference in New Issue
Block a user