Decorative site banner
Project icon

com.io7m.cedarbridge

  • About
  • Releases
  • Manual
  • Sources
  • License
  • Issues
Maven Central Version Maven Snapshot Code Coverage

cedarbridge

The cedarbridge package implements an efficient, strongly-typed, platform-independent, binary message protocol language based around sum and product types, and strong versioning.

[documentation ChatCommandJoin "Join the chat room."] [record ChatCommandJoin [field name cb:String] [documentation name "The username with which to join."]] [documentation Chat "The chat protocol."] [protocol Chat [version 1 [types-added ChatCommandJoin ChatCommandSpeak ChatEventJoined ChatEventLeft ChatEventSpoke ChatEventError]]] ...

Features

  • A carefully written language specification.
  • A minimal data definition language based on algebraic sum and product types.
  • Strong versioning as a core aspect of the language.
  • A small, easily auditable codebase with a heavy use of modularity for correctness.
  • Generates simple, readable, reflection-free Java code.
  • A small footprint; the generated Java code consists of trivial record definitions and incredibly simple and straightforward code to serialize and deserialize values.
  • Platform independence. No platform-dependent code is included in any form.
  • Suitable for use in security-critical environments: Serialization code is immune to the usual serialization vulnerabilities such as type confusion, resource exhaustion, exponential parse times, and etc.
  • An extensive automated test suite with high coverage.
  • OSGi-ready.
  • JPMS-ready.
  • ISC license.

Usage

See the documentation and language specification.

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 2.0.0.

2.0.0 Release (2024-05-10Z)

  • Update org.junit.jupiter:junit-jupiter-engine:5.10.1 → 5.10.2
  • Update org.slf4j:slf4j-api:2.0.10 → 2.0.12
  • Update ch.qos.logback:logback-classic:1.4.14 → 1.5.3
  • Update nl.jqno.equalsverifier:equalsverifier:3.15.5 → 3.15.8
  • Update org.mockito:mockito-core:5.8.0 → 5.11.0
  • Update net.bytebuddy:byte-buddy-agent:1.14.11 → 1.14.12
  • Update net.bytebuddy:byte-buddy:1.14.11 → 1.14.12
  • Update org.apache.maven.plugin-tools:maven-plugin-annotations:3.10.2 → 3.11.0
  • Update org.immutables:value:2.10.0 → 2.10.1
  • Update net.jqwik:jqwik-api:1.8.2 → 1.8.4
  • Update net.jqwik:jqwik-engine:1.8.2 → 1.8.4
  • Update com.io7m.quarrel:com.io7m.quarrel.core:1.4.0 → 1.6.0
  • Update com.io7m.quarrel:com.io7m.quarrel.ext.logback:1.4.0 → 1.6.0
  • Update com.io7m.quarrel:com.io7m.quarrel.ext.xstructural:1.4.0 → 1.6.0
  • Update net.bytebuddy:byte-buddy:1.14.12 → 1.14.13.
  • Update org.apache.maven.plugins:maven-plugin-plugin:3.11.0 → 3.12.0.
  • Update org.slf4j:slf4j-api:2.0.12 → 2.0.13.
  • Update net.bytebuddy:byte-buddy-agent:1.14.12 → 1.14.13.
  • Update ch.qos.logback:logback-classic:1.5.3 → 1.5.5.
  • Update nl.jqno.equalsverifier:equalsverifier:3.15.8 → 3.16.1.
  • Update org.apache.tika:tika-core:2.9.1 → 2.9.2.
  • Update commons-io:commons-io:2.15.1 → 2.16.1.
  • Update ch.qos.logback:logback-classic:1.5.5 → 1.5.6.
  • Update net.bytebuddy:byte-buddy-agent:1.14.13 → 1.14.14.
  • Update net.bytebuddy:byte-buddy:1.14.13 → 1.14.14.
  • Update com.io7m.jaffirm:com.io7m.jaffirm.core:4.0.0 → 4.0.1.
  • Update org.apache.maven.plugins:maven-plugin-plugin:3.12.0 → 3.13.0.
  • Update com.io7m.jlexing:com.io7m.jlexing.core:3.1.0 → 3.2.0.
  • Update net.bytebuddy:byte-buddy:1.14.14 → 1.14.15.
  • Update net.bytebuddy:byte-buddy-agent:1.14.14 → 1.14.15.
  • Update com.io7m.xstructural.version:1.8.0 → 1.8.1.
  • Require JDK 21. (Backwards incompatible)
  • Update com.io7m.jbssio.version:2.0.0 → 2.1.0.
  • Update com.io7m.quarrel.version:1.6.0 → 1.6.1.
  • Update com.io7m.jeucreader:com.io7m.jeucreader.core:3.0.0 → 3.0.1.

The compiled artifacts for the release (and all previous releases) are available on Maven Central.

Maven Modules

<dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.bridgedoc.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.bridgedoc.spi</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.bridgedoc.xhtml</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.cmdline</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.codegen.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.codegen.javastatic</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.codegen.spi</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.documentation</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.errors</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.examples</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.exprsrc.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.exprsrc</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.maven_plugin</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.runtime.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.runtime.bssio</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.runtime.container_protocol</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.runtime.convenience</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.runtime.time</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.ast</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.binder.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.binder</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.compiled</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.compiler.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.compiler</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.core_types</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.loader.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.names</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.parser.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.parser</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.time</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.typer.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.schema.typer</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.specification</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.strings.api</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.tests</artifactId> <version>2.0.0</version> </dependency><dependency> <group>com.io7m.cedarbridge</group> <artifactId>com.io7m.cedarbridge.version</artifactId> <version>2.0.0</version> </dependency>

Previous Releases

The changelogs for the most recent previous releases are as follows:

1.2.0 Release (2023-06-02Z)

  • The time package was not being loaded by the Maven plugin when generating documentation.

1.1.0 Release (2023-06-02Z)

  • Classes in the time package were not implementing CBSerializableType.

1.0.0 Release (2023-06-02Z)

  • Initial major release.

Development Snapshots

At the time of writing, the current unstable development version of the package is 2.0.1-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

User Manual

  • XHTML - One page per section
  • XHTML - Single page

Specification

  • XHTML - One page per section
  • XHTML - Single page

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/cedarbridge

$ git clone --recursive https://www.github.com/io7m-com/cedarbridge

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.

Last Updated 2025-08-09T12:38:51Z