Go to file
Sebastiaan van Stijn 4640e2792c
go.mod: google.golang.org/grpc v1.27.1
Matching the version that containerd is pinning in its "replace" rule;
https://github.com/containerd/containerd/blob/v1.5.0-beta.3/go.mod#L75
https://github.com/containerd/containerd/blob/v1.5.0-beta.3/vendor/modules.txt#L395-L396

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-16 09:39:20 +01:00
.github/workflows Use GitHub Actions for CI 2021-02-08 12:10:17 +01:00
cmd/protoc-gen-gogottrpc Add apache license to files 2018-06-27 17:49:06 -04:00
example metadata as KeyValue type 2019-06-13 18:06:27 +00:00
plugin Add apache license to files 2018-06-27 17:49:06 -04:00
.gitignore Initial commit 2017-11-13 14:12:46 -08:00
channel_test.go Revert "Copy codes and status from grpc project" 2019-10-28 14:46:51 -04:00
channel.go Revert "Copy codes and status from grpc project" 2019-10-28 14:46:51 -04:00
client_test.go client: add UserOnCloseWait function 2020-09-07 23:09:55 +08:00
client.go client: add UserOnCloseWait function 2020-09-07 23:09:55 +08:00
codec.go Add apache license to files 2018-06-27 17:49:06 -04:00
config.go Add godocs for interceptors 2019-06-12 20:26:36 +00:00
go.mod go.mod: google.golang.org/grpc v1.27.1 2021-03-16 09:39:20 +01:00
go.sum go.mod: google.golang.org/grpc v1.27.1 2021-03-16 09:39:20 +01:00
handshake.go Add apache license to files 2018-06-27 17:49:06 -04:00
interceptor.go Add godocs for interceptors 2019-06-12 20:26:36 +00:00
LICENSE Initial commit 2017-11-13 14:12:46 -08:00
metadata_test.go metadata as KeyValue type 2019-06-13 18:06:27 +00:00
metadata.go metadata as KeyValue type 2019-06-13 18:06:27 +00:00
README.md CI: add codecov badge to readme 2021-02-09 17:44:41 +01:00
server_test.go client: add UserOnCloseWait function 2020-09-07 23:09:55 +08:00
server.go server: add a connections leak unit test 2020-04-21 11:20:11 +08:00
services_test.go Fix method full name generation 2019-08-23 13:28:19 -07:00
services.go Revert "Copy codes and status from grpc project" 2019-10-28 14:46:51 -04:00
types.go metadata as KeyValue type 2019-06-13 18:06:27 +00:00
unixcreds_linux.go Add apache license to files 2018-06-27 17:49:06 -04:00

ttrpc

Build Status codecov

GRPC for low-memory environments.

The existing grpc-go project requires a lot of memory overhead for importing packages and at runtime. While this is great for many services with low density requirements, this can be a problem when running a large number of services on a single machine or on a machine with a small amount of memory.

Using the same GRPC definitions, this project reduces the binary size and protocol overhead required. We do this by eliding the net/http, net/http2 and grpc package used by grpc replacing it with a lightweight framing protocol. The result are smaller binaries that use less resident memory with the same ease of use as GRPC.

Please note that while this project supports generating either end of the protocol, the generated service definitions will be incompatible with regular GRPC services, as they do not speak the same protocol.

Usage

Create a gogo vanity binary (see cmd/protoc-gen-gogottrpc/main.go for an example with the ttrpc plugin enabled.

It's recommended to use protobuild to build the protobufs for this project, but this will work with protoc directly, if required.

Differences from GRPC

  • The protocol stack has been replaced with a lighter protocol that doesn't require http, http2 and tls.
  • The client and server interface are identical whereas in GRPC there is a client and server interface that are different.
  • The Go stdlib context package is used instead.
  • No support for streams yet.

Status

Very new. YMMV.

TODO:

  • Plumb error codes and GRPC status
  • Remove use of any type and dependency on typeurl package
  • Ensure that protocol can support streaming in the future
  • Document protocol layout
  • Add testing under concurrent load to ensure
  • Verify connection error handling

Project details

ttrpc is a containerd sub-project, licensed under the Apache 2.0 license. As a containerd sub-project, you will find the:

information in our containerd/project repository.