package mirage-channel

  1. Overview
  2. Docs
Buffered channels for MirageOS FLOW types

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (6)

Authors

  1. A
    Anil Madhavapeddy
  2. M
    Mindy Preston
  3. T
    Thomas Gazagnaire

Maintainers

  1. A
    Anil Madhavapeddy <anil@recoil.org>

Sources

mirage-channel-v4.0.1.tbz
sha256=ecbaed5f601c9d33b86222523f07ad0cae149ad7ec6af63a3a165d1fe117ab72
sha512=c73abf66fa476a3202af01b7ab2ef95362deae5718fa2656f3165e39a601ac3088e65b4714de5341c8073f9f61194d48b756812e1e9c761fd94eb4c37dad2444

doc/README.html

mirage-channel — Buffered channels for MirageOS FLOW types

v4.0.1

Channels are buffered reader/writers built on top of unbuffered FLOW implementations.

Example:

module Channel = Channel.Make(Flow)
...
Channel.read_exactly ~len:16 t
>>= fun bufs -> (* read header of message *)
let payload_length = Cstruct.(LE.get_uint16 (concat bufs) 0) in
Channel.read_exactly ~len:payload_length t
>>= fun bufs -> (* payload of message *)

(* process message *)

Channel.write_buffer t header;
Channel.write_buffer t payload;
Channel.flush t
>>= fun () ->

mirage-channel is distributed under the ISC license.

Installation

mirage-channel can be installed with opam:

opam install channel

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online and there is a generated version in the doc directory of the distribution.

Sample programs

If you installed mirage-channel with opam sample programs are located in the directory opam config var channel:doc.

In the distribution sample programs and tests are located in the test directory of the distribution. They can be built with:

./build test

The resulting binaries are in _build/test.

  • test.native tests the library, nothing should fail.