Hackage :: [Package]

warp-grpc: A minimal gRPC server on top of Warp.

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] [Publish]

Please see the README on Github at https://github.com/haskell-grpc-native/http2-grpc-haskell/blob/master/warp-grpc/README.md

[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.4.0.0, 0.4.0.1
Change log ChangeLog.md
Dependencies async (>=2.2.1 && <3), base (>=4.10 && <5), binary (>=0.8.5 && <0.9), bytestring (>=0.10.8 && <0.11), case-insensitive (>=1.2.0 && <1.3), http-types (>=0.12 && <0.13), http2 (>=1.6 && <3), http2-grpc-types (>=0.5 && <0.6), unliftio-core (>=0.1 && <0.3), wai (>=3.2 && <3.4), warp (>=3.2.23 && <3.4), warp-tls (>=3.2 && <3.4) [details]
License BSD-3-Clause
Copyright 2017 - 2020 Lucas DiCioccio, Alejandro Serrano
Author Lucas DiCioccio, Alejandro Serrano
Maintainer lucas@dicioccio.fr
Category Networking
Home page https://github.com/haskell-grpc-native/http2-grpc-haskell#readme
Bug tracker https://github.com/haskell-grpc-native/http2-grpc-haskell/issues
Source repo head: git clone https://github.com/haskell-grpc-native/http2-grpc-haskell
Uploaded by AlejandroSerrano at 2020-03-20T13:05:08Z

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Readme for warp-grpc-0.4.0.0

[back to package description]

warp-grpc

A gRPC server implementation on top of Warp's HTTP2 handler. The lib also contains a demo sever using the awesome grpcb.in Proto. The current release is an advanced technical demo, expect a few breaking changes.

Design

The library implements gRPC using a WAI middleware for a set of gRPC endpoints. Endpoint handlers differ depending of the streaming/unary-ty of individual RPCs. Bidirectional streams will be supported next.

There is little specification around the expected allowed observable states in gRPC, hence the types this library presents make conservative choices: unary RPCs expect an input before providing an output. Client stream allows to return an output only when the client has stopped streaming. Server streams wait for an input before starting to iterate sending outputs.

Usage

Generate some proto-lens code from .proto files, ideally in a separate library. Import this library and the generated proto-lens code to implement handlers for the service stanzas defined in the .proto files (see Haddocks). Finally, serve warp over TLS`.

Example

Please refer to https://github.com/lucasdicioccio/warp-grpc-example for an example.

TODO(ldicioccio): migrate this example to the new monorepo.

Next steps

Limitations