package protocol_version_header

  1. Overview
  2. Docs
Protocol versioning

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (7)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

protocol_version_header-v0.16.0.tar.gz
sha256=9c3c81bd6e378b7a33ede28b6b1691512ee8a299a65387da03b9eb2adabcb25f

Description

This library offers a lightweight way for applications protocols to version themselves. The more protocols that add themselves to [Known_protocol], the nicer error messages we will get when connecting to a service while using the wrong protocol.

Published: 14 Jun 2023

README

README.org

* Protocol_version_header - protocol-aware version negotiation

Protocol_version_header is a small library that houses magic numbers for various
protocols. It exposes a =negotiate= function that is magic number aware,
returning human readable error messages when negotiation fails.

This library is used directly by =Rpc= and =Krb= so the common mistake of
mismatching clients and servers can be detected.

Dependencies (4)

  1. dune >= "2.0.0"
  2. ppx_jane >= "v0.16" & < "v0.17"
  3. core >= "v0.16" & < "v0.17"
  4. ocaml >= "4.14.0"

Dev Dependencies

None

Used by (2)

  1. async_rpc_kernel >= "v0.16.0"
  2. krb >= "v0.16.0"

Conflicts

None