Browse Source

Replace map with array and reorganize sections

master
Alex Williams 7 months ago
parent
commit
e5d4d1753f
Signed by: aw GPG Key ID: 19EE4AAA361A7E2C
1 changed files with 15 additions and 15 deletions
  1. +15
    -15
      README.md

+ 15
- 15
README.md View File

@ -2,7 +2,7 @@
This registry exists to ensure proper cooperation between various [BOAWP](https://git.boawp.org/boawp/boawp) implementations.
The default [headers](#default-headers), and [datatypes](#default-datatypes) apply to _every_ protocol, and are extended in the documents listed below.
The default [datatypes](#default-datatypes) and [headers](#default-headers) apply to _every_ protocol, and are extended in the documents listed below.
# Protocols
@ -12,11 +12,11 @@ The default [headers](#default-headers), and [datatypes](#default-datatypes) app
# Usage
Each protocol contains a table which maps the name of the init, header, or datatype to various representations (decimal, hex, etc).
Each protocol contains a table which maps the name of the init, datatype, or header to various representations (decimal, hex, etc).
When implementing _BOAWP_, it is important to use the **exact same decimal or hex** values assigned in this registry.
The default init, headers, and datatypes listed below must be used in addition to the protocol-specific assigned values.
The default init, datatypes, and header listed below must be used in addition to the protocol-specific assigned values.
# Default init
@ -24,6 +24,18 @@ The default init, headers, and datatypes listed below must be used in addition
| :---- | :----: | :----: | :----: | :---- |
| BOA v01 | 0x424F4130310A | "BOA01\n" | 1 | BOAWP protocol init string |
# Default datatypes
| Name | Decimal | Hex | UTF-8 | BOAWP Version | Description |
| :---- | :----: | :----: | :----: | :----: | :---- |
| null | 110 | 0x6E | "n" | 1 | |
| true | 116 | 0x74 | "t" | 1 | |
| false | 102 | 0x66 | "f" | 1 | |
| integer | 105 | 0x69 | "i" | 1 | signed big-endian integer (2s complement) |
| string | 115 | 0x73 | "s" | 1 | UTF-8 string |
| binary | 98 | 0x62 | "b" | 1 | sequence of raw octets (bytes) |
| array | 97 | 0x61 | "a" | 1 | array of objects |
# Default headers
| Name | Decimal | Hex | UTF-8 | BOAWP Version |
@ -46,18 +58,6 @@ The default init, headers, and datatypes listed below must be used in addition
| timestamp | 79 | 0x4F | "O" | 1 |
| user-agent | 80 | 0x50 | "P" | 1 |
# Standard datatypes
| Name | Decimal | Hex | UTF-8 | BOAWP Version | Description |
| :---- | :----: | :----: | :----: | :----: | :---- |
| null | 110 | 0x6E | "n" | 1 | |
| true | 116 | 0x74 | "t" | 1 | |
| false | 102 | 0x66 | "f" | 1 | |
| integer | 105 | 0x69 | "i" | 1 | signed big-endian integer (2s complement) |
| string | 115 | 0x73 | "s" | 1 | UTF-8 string |
| binary | 98 | 0x62 | "b" | 1 | sequence of raw octets (bytes) |
| map | 109 | 0x6D | "m" | 1 | array of key/value pairs (tuples) |
# Contributing
New protocols can be added on request, simply [create an issue](https://git.boawp.org/boawp/boawp-registry/issues/new) or [pull request](https://git.boawp.org/boawp/boawp-registry/pulls).


Loading…
Cancel
Save