http2-client-grpc: Implement gRPC-over-HTTP2 clients.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

Uses http2-client and proto-lens to generate client code.


[Skip to ReadMe]

Properties

Versions0.1.0.0, 0.2.0.0, 0.2.0.1, 0.3.0.0, 0.4.0.0, 0.4.0.0, 0.5.0.0, 0.5.0.1, 0.5.0.2, 0.5.0.3, 0.5.0.4
Change logNone available
Dependenciesbase (>=4.7 && <5), binary, bytestring, data-default-class, http2, http2-client, http2-grpc-types (>=0.2), proto-lens, proto-lens-protoc, text, tls, zlib [details]
LicenseBSD-3-Clause
Copyright2017 Lucas DiCioccio
AuthorLucas DiCioccio
Maintainerlucas@dicioccio.fr
CategoryNetwork
Home pagehttps://github.com/lucasdicioccio/http2-client-grpc#readme
Source repositoryhead: git clone https://github.com/lucasdicioccio/http2-client-grpc
UploadedWed Aug 29 18:56:37 UTC 2018 by LucasDiCioccio

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for http2-client-grpc-0.4.0.0

[back to package description]

http2-client-grpc

A native HTTP2 gRPC client library using proto-lens and http2-client.

Summary

This project provides a library that leverages the code generated using proto-lens (in particular, proto-lens-protoc) to implement the client-side of gRPC services.

Usage

Prerequisites

In addition to a working Haskell dev environment, you need to:

Adding .proto files to a Haskell package

In order to run gRPC:

A single protoc invocation may be enough for both Proto and GRPC outputs:

protoc  "--plugin=protoc-gen-haskell-protolens=${protolens}" \
    --haskell-protolens_out=./gen \
    -I "${protodir1} \
    -I "${protodir2} \
    ${first.proto} \
    ${second.proto}

A reliable way to list the module names is the following bash invocation:

find gen -name "*.hs" | sed -e 's/gen\///' | sed -e 's/\.hs$//' | tr '/' '.'

Unlike proto-lens, this project does not yet provide a modified Setup.hs. As a result, we cannot automate these steps from within Cabal/Stack. Hence, you'll have to automate these steps outside your Haskell toolchain.

Calling a GRPC service

In short, use http2-client with the Network.GRPC.call function and let the types guide you.

Example

You'll find an example leveraging the awesome grpcb.in service at https://github.com/lucasdicioccio/http2-client-grpc-example .

gRPC service mapping

The Protobuf format specifies the notion of Service which can have one or more RPCs. The gRPC protocal maps these services onto HTTP2 headers and HTTP2 frames. In general, gRPC implementation generate one inlined function per RPC. This implementation differs by decoupling the HTTP2 transport and leveraging generics to provide generic functions. This design allows the Network.GRPC.call to be type safe and multi-usage. For instance, you can wrap this function with whatever metrics/benchmark code and have all your RPC calls be monitored in a uniform way.

Status

This library is currently an early-stage library. Expect breaking changes.

TODOs