Categorygithub.com/containerd/ttrpc
modulepackage
1.2.7
Repository: https://github.com/containerd/ttrpc.git
Documentation: pkg.go.dev

# 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:

information in our containerd/project repository.

# Packages

No description provided by the author
Code generated by protoc-gen-go-ttrpc.
No description provided by the author
No description provided by the author

# Functions

GetMetadata retrieves metadata from context.Context (previously attached with WithMetadata).
GetMetadataValue gets a specific metadata value by name from context.Context.
NewClient creates a new ttrpc client using the given connection.
No description provided by the author
OversizedMessageError returns an OversizedMessageErr error for the given message length if it exceeds the allowed maximum.
No description provided by the author
UnixSocketRequireSameUser resolves the current effective unix user and returns a UnixCredentialsFunc that will validate incoming unix connections against the current credentials.
UnixSocketRequireUidGid requires specific *effective* UID/GID, rather than the real UID/GID.
WithChainUnaryClientInterceptor sets the provided chain of client interceptors.
WithChainUnaryServerInterceptor sets the provided chain of server interceptors.
WithMetadata attaches metadata map to a context.Context.
WithOnClose sets the close func whenever the client's Close() method is called.
WithServerHandshaker can be passed to NewServer to ensure that the handshaker is called before every connection attempt.
WithUnaryClientInterceptor sets the provided client interceptor.
WithUnaryServerInterceptor sets the provided interceptor on the server.

# Variables

ErrClosed is returned by client methods when the underlying connection is closed.
ErrProtocol is a general error in the handling the protocol.
ErrServerClosed is returned when the Server has closed its connection.
ErrStreamClosed is when the streaming connection is closed.
No description provided by the author

# Structs

Client for a ttrpc server.
No description provided by the author
OversizedMessageErr is used to indicate refusal to send an oversized message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StreamDesc describes the stream properties, whether the stream has a streaming client, a streaming server, or both.
StreamServerInfo provides information about the server request.
No description provided by the author
UnaryClientInfo provides information about the client request.
UnaryServerInfo provides information about the server request.

# Interfaces

ClientStream is used to send or recv messages on the underlying stream.
Handshaker defines the interface for connection handshakes performed on the server or client when first connecting.
No description provided by the author

# Type aliases

ClientOpts configures a client.
Invoker invokes the client's request and response from the ttrpc server.
MD is the user type for ttrpc metadata.
No description provided by the author
ServerOpt for configuring a ttrpc server.
No description provided by the author
No description provided by the author
No description provided by the author
UnaryClientInterceptor specifies the interceptor function for client request/response.
UnaryServerInterceptor specifies the interceptor function for server request/response.
No description provided by the author
Unmarshaler contains the server request data and allows it to be unmarshaled into a concrete type.