https://github.com/akka/akka-grpc

Akka gRPC
https://github.com/akka/akka-grpc

akka akka-http grpc hacktoberfest java reactive reactive-streams rpc scala streaming

Last synced: 23 days ago
JSON representation

Akka gRPC

• Host: GitHub
• URL: https://github.com/akka/akka-grpc
• Owner: akka
• License: other
• Created: 2018-02-08T16:28:56.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-22T10:23:49.000Z (7 months ago)
• Last Synced: 2024-04-22T11:34:57.857Z (7 months ago)
• Topics: akka, akka-http, grpc, hacktoberfest, java, reactive, reactive-streams, rpc, scala, streaming
• Language: Scala
• Homepage: https://doc.akka.io/docs/akka-grpc/
• Size: 4.14 MB
• Stars: 429
• Watchers: 20
• Forks: 124
• Open Issues: 170
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Akka gRPC

Support for building streaming gRPC servers and clients on top

of Akka Streams.

This library is meant to be used as a building block in projects using the Akka

toolkit.

The Akka family of projects is managed by teams at [Lightbend](https://lightbend.com/) with help from the community.

## Documentation

- [Akka gRPC reference](https://doc.akka.io/libraries/akka-grpc/current/) documentation 

## Project Status

This library is ready to be used in production

The API on both sides (Client and Server) is a simple Akka Streams-based one.

The client side is currently implemented on top of [io.grpc:grpc-netty-shaded](https://mvnrepository.com/artifact/io.grpc/grpc-netty-shaded) with an [Akka HTTP](https://doc.akka.io/libraries/akka-http/current) client 

backend alternative available.

As for performance, we are currently relying on the JVM TLS implementation,

which is sufficient for many use cases, but is planned to be replaced with

[conscrypt](https://github.com/google/conscrypt) or [netty-tcnative](https://netty.io/wiki/forked-tomcat-native.html).

## General overview

gRPC is a schema-first RPC framework, where your protocol is declared in a

protobuf definition, and requests and responses will be streamed over an HTTP/2

connection.

Based on a protobuf service definition, akka-grpc can generate:

* Model classes (using plain protoc for Java or scalapb for Scala)

* The API (as an interface for Java or a trait for Scala), expressed in Akka Streams `Source`s

* On the server side, code to create an Akka HTTP route based on your implementation of the API

* On the client side, a client for the API.

## Project structure

The project is split up in a number of subprojects:

* codegen: code generation shared among plugins

* runtime: run-time utilities used by the generated code

* sbt-plugin: the sbt plugin

* scalapb-protoc-plugin: the scalapb Scala model code generation packaged as a protoc plugin, to be used from gradle

* [interop-tests](interop-tests/README.md)

Additionally, 'plugin-tester-java' and 'plugin-tester-scala' contain an example

project in Java and Scala respectively, with both sbt and Gradle configurations.

## License

Akka gRPC is licensed under the Business Source License 1.1, please see the [Akka License FAQ](https://www.lightbend.com/akka/license-faq).

Tests and documentation are under a separate license, see the LICENSE file in each documentation and test root directory for details.