protoc-gen-go-grpc

command
Version: v1.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2021 License: MIT Imports: 7 Imported by: 0

README

protoc-gen-go-grpc

base on 52a707c0dafe4ac6c0443c3d83dfdeeb9b828684

This tool generates Go language bindings of services in protobuf definition files for gRPC. For usage information, please see our quick start guide.

Future-proofing services

By default, to register services using the methods generated by this tool, the service implementations must embed the corresponding Unimplemented<ServiceName>Server for future compatibility. This is a behavior change from the grpc code generator previously included with protoc-gen-go. To restore this behavior, set the option require_unimplemented_servers=false. E.g.:

  protoc --go-grpc_out=require_unimplemented_servers=false[,other options...]:. \

Note that this is not recommended, and the option is only provided to restore backward compatibility with previously-generated code.

Documentation

Overview

protoc-gen-go-grpc is a plugin for the Google protocol buffer compiler to generate Go code. Install it by building this program and making it accessible within your PATH with the name:

protoc-gen-go-grpc

The 'go-grpc' suffix becomes part of the argument for the protocol compiler, such that it can be invoked as:

protoc --go-grpc_out=. path/to/file.proto

This generates Go service definitions for the protocol buffer defined by file.proto. With that input, the output will be written to:

path/to/file_grpc.pb.go

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL