summaryrefslogtreecommitdiffhomepage
path: root/vendor/github.com/containerd/ttrpc/README.md
diff options
context:
space:
mode:
authorbrb-g <45642843+brb-g@users.noreply.github.com>2019-08-29 11:27:49 -0700
committerIan Lewis <ianlewis@google.com>2019-08-29 11:27:49 -0700
commit9ce9ceaf4e0678e06c5b899825f918b72f4d5889 (patch)
tree6c1f8eaf117ac59f3de2a169e4dd342ed1c97eab /vendor/github.com/containerd/ttrpc/README.md
parent462bafb2e7a4d56b788a7467a9e7c05604f55a15 (diff)
Replace pre-go1.11 vendoring with a go1.12 module. (#37)
Diffstat (limited to 'vendor/github.com/containerd/ttrpc/README.md')
-rw-r--r--vendor/github.com/containerd/ttrpc/README.md62
1 files changed, 0 insertions, 62 deletions
diff --git a/vendor/github.com/containerd/ttrpc/README.md b/vendor/github.com/containerd/ttrpc/README.md
deleted file mode 100644
index c345c844e..000000000
--- a/vendor/github.com/containerd/ttrpc/README.md
+++ /dev/null
@@ -1,62 +0,0 @@
-# ttrpc
-
-[![Build Status](https://travis-ci.org/containerd/ttrpc.svg?branch=master)](https://travis-ci.org/containerd/ttrpc)
-
-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`](cmd/protoc-gen-gogottrpc/main.go) for an
-example with the ttrpc plugin enabled.
-
-It's recommended to use [`protobuild`](https://github.com//stevvooe/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:
-
-- [X] Plumb error codes and GRPC status
-- [X] Remove use of any type and dependency on typeurl package
-- [X] 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](./LICENSE).
-As a containerd sub-project, you will find the:
- * [Project governance](https://github.com/containerd/project/blob/master/GOVERNANCE.md),
- * [Maintainers](https://github.com/containerd/project/blob/master/MAINTAINERS),
- * and [Contributing guidelines](https://github.com/containerd/project/blob/master/CONTRIBUTING.md)
-
-information in our [`containerd/project`](https://github.com/containerd/project) repository.