MCPcopy Index your code
hub / github.com/containerd/ttrpc

github.com/containerd/ttrpc @v1.2.8

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.2.8 ↗ · + Follow
450 symbols 1,293 edges 38 files 64 documented · 14% 80 cross-repo links
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

ttrpc

Build Status

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.

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: * Project governance, * Maintainers, * and Contributing guidelines

information in our containerd/project repository.

Extension points exported contracts — how you extend this code

ClientStream (Interface)
ClientStream is used to send or recv messages on the underlying stream [1 implementers]
client.go
Unmarshaler (FuncType)
Unmarshaler contains the server request data and allows it to be unmarshaled into a concrete type
interceptor.go
ServerOpt (FuncType)
ServerOpt for configuring a ttrpc server
config.go
StreamServer (Interface)
(no doc) [2 implementers]
stream_server.go
Handshaker (Interface)
Handshaker defines the interface for connection handshakes performed on the server or client when first connecting.
handshake.go
UnixCredentialsFunc (FuncType)
(no doc)
unixcreds_linux.go
Method (FuncType)
(no doc)
services.go
ClientOpts (FuncType)
ClientOpts configures a client
client.go

Core symbols most depended-on inside this repo

Close
called by 34
server.go
Error
called by 23
errors.go
NewServer
called by 22
server.go
Serve
called by 22
server.go
RecvMsg
called by 19
client.go
Call
called by 18
client.go
Set
called by 15
metadata.go
Shutdown
called by 14
server.go

Shape

Method 236
Function 120
Struct 58
Interface 20
FuncType 12
TypeAlias 4

Languages

Go100%

Modules by API surface

integration/streaming/test_ttrpc.pb.go86 symbols
request.pb.go38 symbols
client.go29 symbols
integration/streaming/test.pb.go27 symbols
example/example.pb.go27 symbols
server_test.go26 symbols
server.go25 symbols
internal/test.pb.go21 symbols
services.go20 symbols
integration/streaming_test.go20 symbols
interceptor.go12 symbols
metadata_test.go11 symbols

For agents

$ claude mcp add ttrpc \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact