The Go language implementation of gRPC. HTTP/2 based RPC
Go to file
dfawley 365770fcbd
streams: Stop cleaning up after orphaned streams (#1854)
This change introduces some behavior changes that should not impact users that
are following the proper stream protocol. Specifically, one of the following
conditions must be satisfied:

1. The user calls Close on the ClientConn.
2. The user cancels the context provided to NewClientStream, or its deadline
    expires. (Note that it if the context is no longer needed before the deadline
    expires, it is still recommended to call cancel to prevent bloat.) It is always
    recommended to cancel contexts when they are no longer needed, and to
    never use the background context directly, so all users should always be
    doing this.
3. The user calls RecvMsg (or Recv in generated code) until a non-nil error is
    returned.
4. The user receives any error from Header or SendMsg (or Send in generated
    code) besides io.EOF.  If none of the above happen, this will leak a goroutine
    and a context, and grpc will not call the optionally-configured stats handler
    with a stats.End message.

Before this change, if a user created a stream and the server ended the stream,
the stats handler would be invoked with a stats.End containing the final status
of the stream. Subsequent calls to RecvMsg would then trigger the stats handler
with InPayloads, which may be unexpected by stats handlers.
2018-02-08 10:51:16 -08:00
.github Create ISSUE_TEMPLATE 2017-05-30 20:03:09 -07:00
Documentation encoding: Introduce new method for registering and choosing codecs (#1813) 2018-01-23 11:39:40 -08:00
balancer Notify parent ClientConn to re-resolve in grpclb (#1699) 2017-12-18 15:36:55 -08:00
benchmark encoding: Introduce new method for registering and choosing codecs (#1813) 2018-01-23 11:39:40 -08:00
codes update const order (#1770) 2018-01-04 15:44:29 -08:00
connectivity Add and use connectivity package for states (#1430) 2017-08-09 10:31:12 -07:00
credentials credentials: return Unavailable instead of Internal for per-RPC creds errors (#1776) 2018-01-03 09:47:07 -08:00
encoding Fix lint error and typo (#1843) 2018-02-01 11:38:14 -08:00
examples Use keyed fields for struct initializers (#1829) 2018-01-24 10:45:49 -08:00
grpclb Add dial option to set balancer (#1697) 2017-12-18 15:35:42 -08:00
grpclog Fix missing and wrong license (#1422) 2017-08-04 13:46:18 -07:00
health *: replace deprecated grpc.Errorf calls with status.Errorf (#1651) 2017-11-06 10:24:20 -08:00
internal status: add Code convenience function (#1754) 2017-12-18 15:00:50 -08:00
interop status: add Code convenience function (#1754) 2017-12-18 15:00:50 -08:00
keepalive autofix license notice 2017-06-08 14:42:19 +02:00
metadata Documentation: update broken wire.html link in metadata package. (#1791) 2018-01-10 10:25:54 -08:00
naming naming: Fix build constraints for go1.6 and go1.7 (#1718) 2017-12-07 12:43:58 -08:00
peer autofix license notice 2017-06-08 14:42:19 +02:00
reflection *: replace deprecated grpc.Errorf calls with status.Errorf (#1651) 2017-11-06 10:24:20 -08:00
resolver Revert "Add WithResolverUserOptions for custom resolver build options" (#1839) 2018-02-05 12:52:35 -08:00
stats streams: Stop cleaning up after orphaned streams (#1854) 2018-02-08 10:51:16 -08:00
status status: add Code convenience function (#1754) 2017-12-18 15:00:50 -08:00
stress *: replace deprecated grpc.Errorf calls with status.Errorf (#1651) 2017-11-06 10:24:20 -08:00
tap Update ServerInHandle comments (#1437) 2017-08-14 10:05:02 -07:00
test streams: Stop cleaning up after orphaned streams (#1854) 2018-02-08 10:51:16 -08:00
testdata Add testdata package and unify testdata to only one dir (#1297) 2017-07-25 10:24:45 -07:00
transport transport: support stats.Handler in serverHandlerTransport (#1840) 2018-02-06 10:11:40 -08:00
.travis.yml travis: fix GOARCH=386 and add misspell check (#1658) 2017-11-08 13:40:05 -08:00
AUTHORS add AUTHORS and LICENSE 2017-06-08 14:37:28 +02:00
CONTRIBUTING.md Update CONTRIBUTING.md to CNCF CLA 2017-12-11 09:04:48 -08:00
LICENSE Make Apache 2.0 LICENSE file a verbatim copy (#1329) 2017-06-21 10:20:47 -07:00
Makefile reduce timeout for tests to 5m (7m for testrace) (#1635) 2017-10-31 14:07:09 -07:00
README.md Re-add support for Go1.6 (#1603) 2017-10-20 12:05:20 -07:00
backoff.go Remove single-entry var blocks (#1589) 2017-10-18 09:59:23 -07:00
backoff_test.go add license for some files (#1296) 2017-06-12 18:10:06 -07:00
balancer.go grpc: fix deprecation comments to conform to standard (#1691) 2017-12-18 09:23:42 -08:00
balancer_conn_wrappers.go Notify parent ClientConn to re-resolve in grpclb (#1699) 2017-12-18 15:36:55 -08:00
balancer_switching_test.go Add dial option to set balancer (#1697) 2017-12-18 15:35:42 -08:00
balancer_test.go status: add Code convenience function (#1754) 2017-12-18 15:00:50 -08:00
balancer_v1_wrapper.go grpc: fix deprecation comments to conform to standard (#1691) 2017-12-18 09:23:42 -08:00
call.go Implement unary functionality using streams (#1835) 2018-02-05 12:54:13 -08:00
call_test.go status: add Code convenience function (#1754) 2017-12-18 15:00:50 -08:00
clientconn.go streams: Stop cleaning up after orphaned streams (#1854) 2018-02-08 10:51:16 -08:00
clientconn_test.go Revert "Add WithResolverUserOptions for custom resolver build options" (#1839) 2018-02-05 12:52:35 -08:00
codec.go encoding: Introduce new method for registering and choosing codecs (#1813) 2018-01-23 11:39:40 -08:00
codec_test.go encoding: Introduce new method for registering and choosing codecs (#1813) 2018-01-23 11:39:40 -08:00
codegen.sh FIX: use /usr/bin/env bash in shebang 2016-12-17 20:45:30 +01:00
doc.go Fix missing and wrong license (#1422) 2017-08-04 13:46:18 -07:00
go16.go streams: Stop cleaning up after orphaned streams (#1854) 2018-02-08 10:51:16 -08:00
go17.go streams: Stop cleaning up after orphaned streams (#1854) 2018-02-08 10:51:16 -08:00
grpclb.go grpclb: Remove duplicate init() (#1764) 2017-12-22 13:43:22 -08:00
grpclb_picker.go New grpclb implementation (#1558) 2017-11-27 11:16:26 -08:00
grpclb_remote_balancer.go Add dial option to set balancer (#1697) 2017-12-18 15:35:42 -08:00
grpclb_util.go Notify parent ClientConn to re-resolve in grpclb (#1699) 2017-12-18 15:36:55 -08:00
interceptor.go autofix license notice 2017-06-08 14:42:19 +02:00
picker_wrapper.go New grpclb implementation (#1558) 2017-11-27 11:16:26 -08:00
picker_wrapper_test.go fix misspell (#1592) 2017-10-19 09:34:07 -07:00
pickfirst.go Add dial option to set balancer (#1697) 2017-12-18 15:35:42 -08:00
pickfirst_test.go Add dial option to set balancer (#1697) 2017-12-18 15:35:42 -08:00
proxy.go Re-add support for Go1.6 (#1603) 2017-10-20 12:05:20 -07:00
proxy_test.go Skip proxy_test in race mode (#1584) 2017-10-17 11:26:58 -07:00
resolver_conn_wrapper.go Revert "Add WithResolverUserOptions for custom resolver build options" (#1839) 2018-02-05 12:52:35 -08:00
resolver_conn_wrapper_test.go Fix parseTarget for unix socket address without scheme (#1611) 2017-10-23 16:34:03 -07:00
rpc_util.go encoding: Introduce new method for registering and choosing codecs (#1813) 2018-01-23 11:39:40 -08:00
rpc_util_test.go encoding: Introduce new method for registering and choosing codecs (#1813) 2018-01-23 11:39:40 -08:00
server.go transport: support stats.Handler in serverHandlerTransport (#1840) 2018-02-06 10:11:40 -08:00
server_test.go grpc: fix deprecation comments to conform to standard (#1691) 2017-12-18 09:23:42 -08:00
service_config.go Change parseTimeout to not handle non-second durations (#1706) 2017-12-05 10:04:04 -08:00
service_config_test.go Change parseTimeout to not handle non-second durations (#1706) 2017-12-05 10:04:04 -08:00
stream.go streams: Stop cleaning up after orphaned streams (#1854) 2018-02-08 10:51:16 -08:00
trace.go Truncate payload trace string, and turn trace off by default (#1509) 2017-09-08 11:13:41 -07:00
vet.sh vet: run golint on _string files (#1749) 2017-12-18 10:58:57 -08:00

README.md

gRPC-Go

Build Status GoDoc GoReportCard

The Go implementation of gRPC: A high performance, open source, general RPC framework that puts mobile and HTTP/2 first. For more information see the gRPC Quick Start: Go guide.

Installation

To install this package, you need to install Go and setup your Go workspace on your computer. The simplest way to install the library is to run:

$ go get -u google.golang.org/grpc

Prerequisites

This requires Go 1.6 or later. Go 1.7 will be required as of the next gRPC-Go release (1.8).

Constraints

The grpc package should only depend on standard Go packages and a small number of exceptions. If your contribution introduces new dependencies which are NOT in the list, you need a discussion with gRPC-Go authors and consultants.

Documentation

See API documentation for package and API descriptions and find examples in the examples directory.

Performance

See the current benchmarks for some of the languages supported in this dashboard.

Status

General Availability Google Cloud Platform Launch Stages.

FAQ

Compiling error, undefined: grpc.SupportPackageIsVersion

Please update proto package, gRPC package and rebuild the proto files:

  • go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
  • go get -u google.golang.org/grpc
  • protoc --go_out=plugins=grpc:. *.proto