package grpc
Install
Dune 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-plugin
for Protobuf serializationexamples/greeter-{client-tls-async,server-ssl-lwt}
showcases the greeter service over a secure connectionexamples/etcd
interfaces with an externaletcd
server and shows how to useocaml-protoc-plugin
for Protobuf serializationexamples/routeguide
implements the "Route Guide" service using Eio andocaml-protoc-plugin
for 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
Used by (4)
-
grpc-async
>= "0.2.0"
- grpc-bench
- grpc-eio
-
grpc-lwt
>= "0.2.0"
Conflicts
None