grpc

Documentation

Index

• func Configure(opts ...ClientOption) error
• func DefaultClient() client.Client
• type ClientOption
  • func GetClientOptions(t *shared.GRPCClientTLS) []ClientOption
  • func WithTLSCACert(v string) ClientOption
  • func WithTLSMode(v string) ClientOption
• type ClientOptions
• type Option
  • func Address(a string) Option
  • func Context(ctx context.Context) Option
  • func Flags(flags ...cli.Flag) Option
  • func Logger(l log.Logger) Option
  • func Name(n string) Option
  • func Namespace(n string) Option
  • func TLSCert(c string, k string) Option
  • func TLSEnabled(v bool) Option
  • func Version(v string) Option
• type Options
• type Service
  • func NewService(opts ...Option) (Service, error)

Functions

func Configure

func Configure(opts ...ClientOption) error

Configure configures the default oOCIS grpc client (e.g. TLS settings)

func DefaultClient

func DefaultClient() client.Client

DefaultClient returns a custom oCIS grpc configured client.

Types

type ClientOption

type ClientOption func(opts *ClientOptions)

Option is used to pass client options

func GetClientOptions

func GetClientOptions(t *shared.GRPCClientTLS) []ClientOption

func WithTLSCACert

func WithTLSCACert(v string) ClientOption

WithTLSCACert allows to set the CA Certificate for grpc clients

func WithTLSMode

func WithTLSMode(v string) ClientOption

WithTLSMode allows to set the TLSMode option for grpc clients

type ClientOptions

type ClientOptions struct {
	// contains filtered or unexported fields
}

ClientOptions represent options (e.g. tls settings) for the grpc clients

type Option

type Option func(o *Options)

Option defines a single option function.

func Address

func Address(a string) Option

Address provides a function to set the address option.

func Context

func Context(ctx context.Context) Option

Context provides a function to set the context option.

func Flags

func Flags(flags ...cli.Flag) Option

Flags provides a function to set the flags option.

func Logger

func Logger(l log.Logger) Option

Logger provides a function to set the logger option.

func Name

func Name(n string) Option

Name provides a function to set the name option.

func Namespace

func Namespace(n string) Option

Namespace provides a function to set the namespace option.

func TLSCert

func TLSCert(c string, k string) Option

TLSCert provides a function to set the TLS server certificate and key

func TLSEnabled

func TLSEnabled(v bool) Option

TLSEnabled provides a function to enable/disable TLS

func Version

func Version(v string) Option

Version provides a function to set the version option.

type Options

type Options struct {
	Logger     log.Logger
	Namespace  string
	Name       string
	Version    string
	Address    string
	TLSEnabled bool
	TLSCert    string
	TLSKey     string
	Context    context.Context
	Flags      []cli.Flag
}

Options defines the available options for this package.

type Service

type Service struct {
	micro.Service
}

Service simply wraps the go-micro grpc service.

func NewService

func NewService(opts ...Option) (Service, error)

NewService initializes a new grpc service.