micro/server/options.go

278 lines
5.7 KiB
Go
Raw Normal View History

2015-05-27 00:39:48 +03:00
package server
import (
2018-03-03 14:53:52 +03:00
"context"
"crypto/tls"
"sync"
2016-01-27 02:32:27 +03:00
"time"
"github.com/micro/go-micro/v3/auth"
"github.com/micro/go-micro/v3/broker"
"github.com/micro/go-micro/v3/broker/http"
"github.com/micro/go-micro/v3/codec"
"github.com/micro/go-micro/v3/debug/trace"
"github.com/micro/go-micro/v3/registry"
"github.com/micro/go-micro/v3/registry/mdns"
"github.com/micro/go-micro/v3/transport"
2015-05-27 00:39:48 +03:00
)
type Options struct {
Codecs map[string]codec.NewCodec
Broker broker.Broker
Registry registry.Registry
2020-01-29 18:45:11 +03:00
Tracer trace.Tracer
Auth auth.Auth
Transport transport.Transport
Metadata map[string]string
Name string
Address string
Advertise string
Id string
Namespace string
Version string
HdlrWrappers []HandlerWrapper
SubWrappers []SubscriberWrapper
// RegisterCheck runs a check function before registering the service
RegisterCheck func(context.Context) error
2019-01-08 23:32:47 +03:00
// The register expiry time
2016-01-27 15:23:18 +03:00
RegisterTTL time.Duration
2019-01-24 16:22:17 +03:00
// The interval on which to register
RegisterInterval time.Duration
2016-01-27 15:23:18 +03:00
2019-01-08 23:32:47 +03:00
// The router for requests
Router Router
// TLSConfig specifies tls.Config for secure serving
TLSConfig *tls.Config
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
}
func newOptions(opt ...Option) Options {
opts := Options{
Codecs: make(map[string]codec.NewCodec),
Metadata: map[string]string{},
RegisterInterval: DefaultRegisterInterval,
RegisterTTL: DefaultRegisterTTL,
2015-11-25 22:50:05 +03:00
}
2015-05-27 00:39:48 +03:00
for _, o := range opt {
o(&opts)
}
if opts.Broker == nil {
opts.Broker = http.NewBroker()
}
if opts.Registry == nil {
opts.Registry = mdns.NewRegistry()
}
if opts.Transport == nil {
opts.Transport = transport.DefaultTransport
2015-05-27 00:39:48 +03:00
}
if opts.RegisterCheck == nil {
opts.RegisterCheck = DefaultRegisterCheck
}
if len(opts.Address) == 0 {
opts.Address = DefaultAddress
2015-05-27 00:39:48 +03:00
}
if len(opts.Name) == 0 {
opts.Name = DefaultName
2015-05-27 00:39:48 +03:00
}
if len(opts.Id) == 0 {
opts.Id = DefaultId
2015-05-27 00:39:48 +03:00
}
if len(opts.Version) == 0 {
opts.Version = DefaultVersion
}
2015-05-27 00:39:48 +03:00
return opts
}
2015-11-26 03:23:36 +03:00
// Server name
func Name(n string) Option {
return func(o *Options) {
o.Name = n
}
}
// Namespace to register handlers in
func Namespace(n string) Option {
return func(o *Options) {
o.Namespace = n
}
}
2015-11-26 03:23:36 +03:00
// Unique server id
func Id(id string) Option {
return func(o *Options) {
o.Id = id
}
}
2015-11-26 03:23:36 +03:00
// Version of the service
func Version(v string) Option {
return func(o *Options) {
o.Version = v
}
}
2015-11-26 03:23:36 +03:00
// Address to bind to - host:port
func Address(a string) Option {
return func(o *Options) {
o.Address = a
}
}
2015-11-26 03:23:36 +03:00
// The address to advertise for discovery - host:port
2015-11-11 21:22:04 +03:00
func Advertise(a string) Option {
return func(o *Options) {
o.Advertise = a
2015-11-11 21:22:04 +03:00
}
}
2015-11-26 03:23:36 +03:00
// Broker to use for pub/sub
func Broker(b broker.Broker) Option {
return func(o *Options) {
o.Broker = b
}
}
2015-11-26 03:23:36 +03:00
// Codec to use to encode/decode requests for a given content type
func Codec(contentType string, c codec.NewCodec) Option {
return func(o *Options) {
o.Codecs[contentType] = c
2015-11-25 22:50:05 +03:00
}
}
// Context specifies a context for the service.
// Can be used to signal shutdown of the service
// Can be used for extra option values.
func Context(ctx context.Context) Option {
return func(o *Options) {
o.Context = ctx
}
}
2015-11-26 03:23:36 +03:00
// Registry used for discovery
func Registry(r registry.Registry) Option {
return func(o *Options) {
o.Registry = r
}
}
2020-01-29 18:45:11 +03:00
// Tracer mechanism for distributed tracking
func Tracer(t trace.Tracer) Option {
return func(o *Options) {
o.Tracer = t
}
}
// Auth mechanism for role based access control
func Auth(a auth.Auth) Option {
return func(o *Options) {
o.Auth = a
}
}
2015-11-26 03:23:36 +03:00
// Transport mechanism for communication e.g http, rabbitmq, etc
func Transport(t transport.Transport) Option {
return func(o *Options) {
o.Transport = t
}
}
2015-11-26 03:23:36 +03:00
// Metadata associated with the server
func Metadata(md map[string]string) Option {
return func(o *Options) {
o.Metadata = md
}
}
// RegisterCheck run func before registry service
func RegisterCheck(fn func(context.Context) error) Option {
return func(o *Options) {
o.RegisterCheck = fn
}
}
2016-01-27 15:23:18 +03:00
// Register the service with a TTL
func RegisterTTL(t time.Duration) Option {
return func(o *Options) {
o.RegisterTTL = t
}
}
2019-01-24 16:22:17 +03:00
// Register the service with at interval
func RegisterInterval(t time.Duration) Option {
return func(o *Options) {
o.RegisterInterval = t
}
}
// TLSConfig specifies a *tls.Config
func TLSConfig(t *tls.Config) Option {
return func(o *Options) {
// set the internal tls
o.TLSConfig = t
// set the default transport if one is not
// already set. Required for Init call below.
if o.Transport == nil {
o.Transport = transport.DefaultTransport
}
// set the transport tls
o.Transport.Init(
transport.Secure(true),
transport.TLSConfig(t),
)
}
}
2019-01-08 23:32:47 +03:00
// WithRouter sets the request router
func WithRouter(r Router) Option {
return func(o *Options) {
o.Router = r
}
}
2017-05-31 21:47:50 +03:00
// Wait tells the server to wait for requests to finish before exiting
// If `wg` is nil, server only wait for completion of rpc handler.
// For user need finer grained control, pass a concrete `wg` here, server will
// wait against it on stop.
func Wait(wg *sync.WaitGroup) Option {
2017-05-31 21:47:50 +03:00
return func(o *Options) {
if o.Context == nil {
o.Context = context.Background()
}
if wg == nil {
wg = new(sync.WaitGroup)
}
o.Context = context.WithValue(o.Context, "wait", wg)
2017-05-31 21:47:50 +03:00
}
}
// Adds a handler Wrapper to a list of options passed into the server
2015-12-02 14:54:36 +03:00
func WrapHandler(w HandlerWrapper) Option {
return func(o *Options) {
o.HdlrWrappers = append(o.HdlrWrappers, w)
}
}
2015-12-02 14:54:36 +03:00
// Adds a subscriber Wrapper to a list of options passed into the server
func WrapSubscriber(w SubscriberWrapper) Option {
return func(o *Options) {
o.SubWrappers = append(o.SubWrappers, w)
2015-12-02 14:54:36 +03:00
}
}