verdant
The verdant package provides a binary protocol for advertising HTTP endpoint
protocol versions.
Features
Description
verdant is a trivial protocol for announcing a set of protocols
exposed by a set of HTTP endpoints.
A client connecting to a root endpoint reads a binary structure delivered with
the content type application/verdant+cedarbridge.
The protocol is specified using the cedarbridge specification language using the canonical binary encoding. Briefly: All values are delivered in big endian byte order. Strings are encoded as a 32-bit unsigned integer representing the number of bytes the string data requires, followed by the UTF-8 encoded bytes of the string. Lists are encoded as a 32-bit unsigned integer representing the number of list elements, followed by the elements of the list.
The structure consists of a sequence of messages, with the first message
being a fixed-size version header VContainerVersion specifying the version of
the verdant protocol. The one and only defined version, at the time of
writing, is version 1.
[record VContainerVersion
[field version IntegerUnsigned32]
]
In version 1 of the protocol, this message will immediately be followed by
a V1ProtocolsSupported message.
[record VProtocolId
[field msb IntegerUnsigned64]
[field lsb IntegerUnsigned64]
]
[record VProtocolSupported
[field id VProtocolId]
[field versionMajor IntegerUnsigned32]
[field versionMinor IntegerUnsigned32]
[field endpointPath String]
]
[record V1ProtocolsSupported
[field supported [List VProtocolSupported]]
]
Each element of type VProtocolSupported specifies a protocol uniquely identified
with a UUID
and a major and minor version. Clients can then navigate to the associated
endpoint path (relative to the current URL) and can expect to converse using
whatever protocol was specified.
Releases & Development Snapshots
Releases
You can subscribe to the atom feed to be notified of project releases.
The most recently released version of the package is 1.0.1.
1.0.1 Release (2024-05-11Z)
- Update commons-io:commons-io:2.15.1 → 2.16.1.
- Update net.jqwik:jqwik-api:1.8.2 → 1.8.4.
- Update logback.version:1.4.14 → 1.5.6.
- Update org.junit.jupiter:junit-jupiter-engine:5.10.1 → 5.10.2.
- Update slf4j.version:2.0.10 → 2.0.13.
- Update org.junit.jupiter:junit-jupiter-api:5.10.1 → 5.10.2.
- Update net.jqwik:jqwik-engine:1.8.2 → 1.8.4.
- Move to new organization.
- Update com.io7m.jbssio.version:2.0.0 → 2.1.0.
The compiled artifacts for the release (and all previous releases) are available on Maven Central.
Maven Modules
<dependency> <group>com.io7m.verdant</group> <artifactId>com.io7m.verdant.core</artifactId> <version>1.0.1</version> </dependency><dependency> <group>com.io7m.verdant</group> <artifactId>com.io7m.verdant.core.cb</artifactId> <version>1.0.1</version> </dependency><dependency> <group>com.io7m.verdant</group> <artifactId>com.io7m.verdant.tests</artifactId> <version>1.0.1</version> </dependency>
Previous Releases
The changelogs for the most recent previous releases are as follows:
1.0.0 Release (2023-06-11Z)
- Initial major release.
Development Snapshots
At the time of writing, the current unstable development version of the package is 1.0.2-SNAPSHOT.
Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.
Manual
This project does not have any user manuals or other documentation beyond what might be present on the page above.
Sources
This project uses Git to manage source code.
Repository: https://www.github.com/io7m-com/verdant
$ git clone --recursive https://www.github.com/io7m-com/verdant
Issues
This project uses GitHub Issues to track issues.
License
Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.