examples/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/grpc/grpc-go

Links

Open Source Insights

README ¶

gRPC in 3 minutes (Go)

BACKGROUND

For this sample, we've already generated the server and client stubs from helloworld.proto.

PREREQUISITES

This requires Go 1.9 or later
Requires that GOPATH is set

$ go help gopath
$ # ensure the PATH contains $GOPATH/bin
$ export PATH=$PATH:$GOPATH/bin

INSTALL

$ go get -u google.golang.org/grpc/examples/helloworld/greeter_client
$ go get -u google.golang.org/grpc/examples/helloworld/greeter_server

TRY IT!

Run the server
```
$ greeter_server &
```
Run the client
```
$ greeter_client
```

OPTIONAL - Rebuilding the generated code

Install protobuf compiler

Install the protoc Go plugin

$ go get -u github.com/golang/protobuf/protoc-gen-go

Rebuild the generated Go code

$ go generate google.golang.org/grpc/examples/helloworld/...

Or run protoc command (with the grpc plugin)

$ protoc -I helloworld/ helloworld/helloworld.proto --go_out=plugins=grpc:helloworld

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
features
authentication/client The client demonstrates how to supply an OAuth2 token for every RPC.	The client demonstrates how to supply an OAuth2 token for every RPC.
authentication/server The server demonstrates how to consume and validate OAuth2 tokens provided by clients for each RPC.	The server demonstrates how to consume and validate OAuth2 tokens provided by clients for each RPC.
cancellation/client Binary client is an example client.	Binary client is an example client.
cancellation/server Binary server is an example server.	Binary server is an example server.
compression/client Binary client is an example client.	Binary client is an example client.
compression/server Binary server is an example server.	Binary server is an example server.
deadline/client Binary client is an example client.	Binary client is an example client.
deadline/server Binary server is an example server.	Binary server is an example server.
debugging/client Binary client is an example client.	Binary client is an example client.
debugging/server Binary server is an example server.	Binary server is an example server.
encryption/ALTS/client Binary client is an example client.	Binary client is an example client.
encryption/ALTS/server Binary server is an example server.	Binary server is an example server.
encryption/TLS/client Binary client is an example client.	Binary client is an example client.
encryption/TLS/server Binary server is an example server.	Binary server is an example server.
errors/client Binary client is an example client.	Binary client is an example client.
errors/server Binary server is an example server.	Binary server is an example server.
interceptor/client Binary client is an example client.	Binary client is an example client.
interceptor/server Binary server is an example server.	Binary server is an example server.
keepalive/client Binary client is an example client.	Binary client is an example client.
keepalive/server Binary server is an example server.	Binary server is an example server.
load_balancing/client Binary client is an example client.	Binary client is an example client.
load_balancing/server Binary server is an example server.	Binary server is an example server.
metadata/client Binary client is an example client.	Binary client is an example client.
metadata/server Binary server is an example server.	Binary server is an example server.
multiplex/client Binary client is an example client.	Binary client is an example client.
multiplex/server Binary server is an example server.	Binary server is an example server.
name_resolving/client Binary client is an example client.	Binary client is an example client.
name_resolving/server Binary server is an example server.	Binary server is an example server.
profiling/client Binary client is an example client.	Binary client is an example client.
profiling/server Binary server is an example server.	Binary server is an example server.
proto Package proto is for go generate.	Package proto is for go generate.
proto/echo
reflection/server Binary server is an example server.	Binary server is an example server.
retry/client Binary client is an example client.	Binary client is an example client.
retry/server Binary server is an example server.	Binary server is an example server.
wait_for_ready Binary wait_for_ready is an example for "wait for ready".	Binary wait_for_ready is an example for "wait for ready".
xds/client Package main implements a client for Greeter service.	Package main implements a client for Greeter service.
xds/server Package main starts Greeter service that will response with the hostname.	Package main starts Greeter service that will response with the hostname.
observability Module
helloworld
greeter_client Package main implements a client for Greeter service.	Package main implements a client for Greeter service.
greeter_server Package main implements a server for Greeter service.	Package main implements a server for Greeter service.
mock_helloworld
route_guide
client Package main implements a simple gRPC client that demonstrates how to use gRPC-Go libraries to perform unary, client streaming, server streaming and full duplex RPCs.	Package main implements a simple gRPC client that demonstrates how to use gRPC-Go libraries to perform unary, client streaming, server streaming and full duplex RPCs.
mock_routeguide
routeguide
server Package main implements a simple gRPC server that demonstrates how to use gRPC-Go libraries to perform unary, client streaming, server streaming and full duplex RPCs.	Package main implements a simple gRPC server that demonstrates how to use gRPC-Go libraries to perform unary, client streaming, server streaming and full duplex RPCs.