grpclb

Documentation

Overview

Package grpclb implements the load balancing protocol defined at https://github.com/grpc/grpc/blob/master/doc/load-balancing.md. The implementation is currently EXPERIMENTAL.

Index

• func Balancer(r naming.Resolver) grpc.Balancer
• type AddressType
• type Metadata

Functions

func Balancer

func Balancer(r naming.Resolver) grpc.Balancer

Balancer creates a grpclb load balancer.

Types

type AddressType

type AddressType uint8

AddressType indicates the address type returned by name resolution.

const (
	// Backend indicates the server is a backend server.
	Backend AddressType = iota
	// GRPCLB indicates the server is a grpclb load balancer.
	GRPCLB
)

type Metadata

type Metadata struct {
	// AddrType is the type of server (grpc load balancer or backend).
	AddrType AddressType
	// ServerName is the name of the grpc load balancer. Used for authentication.
	ServerName string
}

Metadata contains the information the name resolution for grpclb should provide. The name resolver used by grpclb balancer is required to provide this type of metadata in its address updates.