Go to file
Derek McGowan 6f33ccebed Update protocol for closed data messages
Add flag to indicate that a data message used with a close flag
is not sending any data. This clears up any ambiguity over whether the
final data message is transmitting a zero length data message or no
data at all.

Signed-off-by: Derek McGowan <derek@mcg.dev>
2022-04-07 17:11:40 -07:00
.github/workflows Add integration test to github actions 2022-04-07 17:11:40 -07:00
cmd Add streaming support to go-ttrpc generator 2022-04-07 17:11:40 -07:00
example Add makefile and update protoc version 2022-03-04 18:17:11 -08:00
integration Add integration test package 2022-04-07 17:11:40 -07:00
internal Add stream tests 2022-04-07 17:11:40 -07:00
plugin Add apache license to files 2018-06-27 17:49:06 -04:00
proto Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
script Add makefile and update protoc version 2022-03-04 18:17:11 -08:00
.gitattributes Use CR+LF instead of LF regardless of OS 2022-02-21 23:47:19 +00:00
.gitignore Add makefile and update protoc version 2022-03-04 18:17:11 -08:00
.golangci.yml Fix lint issues 2022-01-21 12:04:30 -08:00
channel_test.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
channel.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
client_test.go Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
client.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
codec.go Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
config.go replace pkg/errors from vendor 2021-09-25 22:46:36 +08:00
doc.go Add ttrpc protocol definition 2022-03-02 11:42:10 -08:00
go.mod Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
go.sum Add protoc-gen-go-ttrpc 2021-10-26 10:03:23 -07:00
handshake.go Fix lint issues 2022-01-21 12:04:30 -08:00
interceptor.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
LICENSE Initial commit 2017-11-13 14:12:46 -08:00
Makefile Update github actions ci to use Makefile 2022-03-04 18:17:11 -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
Protobuild.toml Add integration test package 2022-04-07 17:11:40 -07:00
PROTOCOL.md Update protocol for closed data messages 2022-04-07 17:11:40 -07:00
README.md Add ttrpc protocol definition 2022-03-02 11:42:10 -08:00
request.pb.go Add makefile and update protoc version 2022-03-04 18:17:11 -08:00
request.proto Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
server_linux_test.go Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
server_test.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
server.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
services_test.go Fix method full name generation 2019-08-23 13:28:19 -07:00
services.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
stream_server.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
stream_test.go Add stream tests 2022-04-07 17:11:40 -07:00
stream.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
test.proto Add stream tests 2022-04-07 17:11:40 -07:00
unixcreds_linux.go Merge pull request #100 from tklauser/ucred-wrap-err 2022-01-21 15:00:05 -08: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.

Protocol

See the protocol specification.

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

TODO:

  • 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.