commit bb26abd4071d65aecf9c27b77aa3d0528c1518da · anil.recoil.org/opam-repository

+61
packages/mirage-channel/mirage-channel.4.1.0/opam
···

       1
       1
       +
       opam-version: "2.0"

     

       2
       2
       +
       maintainer: "Anil Madhavapeddy <anil@recoil.org>"

     

       3
       3
       +
       authors: ["Anil Madhavapeddy" "Mindy Preston" "Thomas Gazagnaire"]

     

       4
       4
       +
       license: "ISC"

     

       5
       5
       +
       tags: "org:mirage"

     

       6
       6
       +
       homepage: "https://github.com/mirage/mirage-channel"

     

       7
       7
       +
       doc: "https://mirage.github.io/mirage-channel/"

     

       8
       8
       +
       bug-reports: "https://github.com/mirage/mirage-channel/issues"

     

       9
       9
       +
       depends: [

     

       10
       10
       +
         "ocaml" {>= "4.07.0"}

     

       11
       11
       +
         "dune" {>= "1.0"}

     

       12
       12
       +
         "mirage-flow" {>= "2.0.0"}

     

       13
       13
       +
         "lwt" {>= "4.0.0"}

     

       14
       14
       +
         "cstruct" {>= "6.0.0"}

     

       15
       15
       +
         "logs"

     

       16
       16
       +
         "alcotest" {with-test}

     

       17
       17
       +
         "mirage-flow-combinators" {with-test & >= "2.0.0"}

     

       18
       18
       +
       ]

     

       19
       19
       +
       conflicts: [

     

       20
       20
       +
         "tcpip" {< "3.0.0"}

     

       21
       21
       +
       ]

     

       22
       22
       +
       build: [

     

       23
       23
       +
         ["dune" "subst"] {dev}

     

       24
       24
       +
         ["dune" "build" "-p" name "-j" jobs]

     

       25
       25
       +
       ]

     

       26
       26
       +
       dev-repo: "git+https://github.com/mirage/mirage-channel.git"

     

       27
       27
       +
       synopsis: "Buffered channels for MirageOS FLOW types"

     

       28
       28
       +
       description: """

     

       29
       29
       +
       Channels are buffered reader/writers built on top of unbuffered `FLOW`

     

       30
       30
       +
       implementations.

     

       31
       31
       +
       

     

       32
       32
       +
       Example:

     

       33
       33
       +
       

     

       34
       34
       +
       ```ocaml

     

       35
       35
       +
       module Channel = Channel.Make(Flow)

     

       36
       36
       +
       ...

     

       37
       37
       +
       Channel.read_exactly ~len:16 t

     

       38
       38
       +
       >>= fun bufs -> (* read header of message *)

     

       39
       39
       +
       let payload_length = Cstruct.(LE.get_uint16 (concat bufs) 0) in

     

       40
       40
       +
       Channel.read_exactly ~len:payload_length t

     

       41
       41
       +
       >>= fun bufs -> (* payload of message *)

     

       42
       42
       +
       

     

       43
       43
       +
       (* process message *)

     

       44
       44
       +
       

     

       45
       45
       +
       Channel.write_buffer t header;

     

       46
       46
       +
       Channel.write_buffer t payload;

     

       47
       47
       +
       Channel.flush t

     

       48
       48
       +
       >>= fun () ->

     

       49
       49
       +
       ```

     

       50
       50
       +
       

     

       51
       51
       +
       mirage-channel is distributed under the ISC license.

     

       52
       52
       +
       """

     

       53
       53
       +
       url {

     

       54
       54
       +
         src:

     

       55
       55
       +
           "https://github.com/mirage/mirage-channel/releases/download/v4.1.0/mirage-channel-4.1.0.tbz"

     

       56
       56
       +
         checksum: [

     

       57
       57
       +
           "sha256=b0176851d4ddf5978d7072b420118178e6030ea50b33b1185fe3f3d9fda72100"

     

       58
       58
       +
           "sha512=d6e085cc7c61387fa651757704dd0c76d2fee728725e06174ea8a1c47e63b13217d3683094939a3862fe2f23f18f74dfcdbe4577ba0e9e45609c15d1539edd10"

     

       59
       59
       +
         ]

     

       60
       60
       +
       }

     

       61
       61
       +
       x-commit-hash: "7e6729e3e06de402526f7a27be18279e5449257f"