grpc

README

GRPC Server

The grpc server is a micro.Server compatible server.

Overview

The server makes use of the google.golang.org/grpc framework for the underlying server but continues to use micro handler signatures and protoc-gen-micro generated code.

Usage

Specify the server to your micro service

import (
        "github.com/micro/go-micro"
        "github.com/micro/go-plugins/server/grpc"
)

func main() {
        service := micro.NewService(
                // This needs to be first as it replaces the underlying server
                // which causes any configuration set before it
                // to be discarded
                micro.Server(grpc.NewServer()),
                micro.Name("greeter"),
        )
}

NOTE: Setting the gRPC server and/or client causes the underlying the server/client to be replaced which causes any previous configuration set on that server/client to be discarded. It is therefore recommended to set gRPC server/client before any other configuration

Documentation

Overview

Package grpc provides a grpc server

Index

• Variables
• func AuthTLS(t *tls.Config) server.Option
• func Codec(contentType string, c encoding.Codec) server.Option
• func MaxMsgSize(s int) server.Option
• func NewServer(opts ...server.Option) server.Server
• func Options(opts ...grpc.ServerOption) server.Option

Variables

var (
	// DefaultMaxMsgSize define maximum message size that server can send
	// or receive.  Default value is 4MB.
	DefaultMaxMsgSize = 1024 * 1024 * 4
)

Functions

func AuthTLS

func AuthTLS(t *tls.Config) server.Option

AuthTLS should be used to setup a secure authentication using TLS

func Codec

func Codec(contentType string, c encoding.Codec) server.Option

gRPC Codec to be used to encode/decode requests for a given content type

func MaxMsgSize

func MaxMsgSize(s int) server.Option

MaxMsgSize set the maximum message in bytes the server can receive and send. Default maximum message size is 4 MB.

func NewServer

func NewServer(opts ...server.Option) server.Server

func Options

func Options(opts ...grpc.ServerOption) server.Option

Options to be used to configure gRPC options