package grpc
All checked builds passInstall
dune-project
Dependency
Authors
Maintainers
Sources
md5=69aa501b131e2f1c19c9e742b1173c3b
sha512=03bf7448330346959fe581822fdd0580279f5042b3b51acc220950b0fa78764e64a0ead7dda0bcad22374e6e4d77870ff8e70431d233832912278a4ae5ad0390
Description
This library builds some of the signatures and implementations of gRPC functionality. This is used in the more specialised package grpc-lwt which has more machinery, however this library can also be used to do some bits yourself.
README
OCaml gRPC
Pure OCaml implementation of gRPC over HTTP2.
Supported features:
- RPCs: unary, server streaming, client streaming, bidirectional streaming
- Client (Eio, Lwt and Async), server (Eio, Lwt and Async)
Getting Started
To get started, browse the documentation and the examples:
examples/greeter-{client,server}-{async,lwt,eio}implements a basic "Hello world" service usingocaml-protoc-pluginfor Protobuf serializationexamples/greeter-{client-tls-async,server-ssl-lwt}showcases the greeter service over a secure connectionexamples/etcdinterfaces with an externaletcdserver and shows how to useocaml-protoc-pluginfor Protobuf serializationexamples/routeguideimplements the "Route Guide" service using Eio andocaml-protoc-pluginfor Protobuf serialisation.examples/routeguide-{client,server}-{async,lwt}showcases the Route Guide service using Async and LWT.
Tutorials
- The helloworld tutorial provides a basic example of using gRPC with LWT, perfect for first time users!
- The routeguide tutorial provides a complete example of using gRPC with Eio and all its features.
Acknowledgments
This MVP version of this library was built by @jeffa5. Andrew gratiously passed the baton to our team to develop it into a full fledged production-ready implementation.
Dependencies (5)
- ppx_deriving
-
h2
>= "0.9.0" & < "0.13.0" -
uri
>= "4.0.0" -
ocaml
>= "4.08" -
dune
>= "3.7"
Dev Dependencies (1)
-
odoc
with-doc
Optional Dependencies
None
Used by (4)
-
grpc-async
>= "0.2.0" - grpc-bench
- grpc-eio
-
grpc-lwt
>= "0.2.0"
Conflicts
None
Build status
Results of building grpc with each compiler on check.ci.ocaml.org, run of against opam-repository 7cdc698. All results for this package.
Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.
| Version | OCaml 4.11 | OCaml 4.14 | OCaml 5.2 | OCaml 5.4 | OCaml 5.5 |
|---|---|---|---|---|---|
| 0.2.0 (this version) | good | good | good | good | good |
- good Package successfully built
- partial One of the dependencies failed to build
- bad Package failed to build
- n/a Package is not available in this environment
- internal Internal failure