2015-05-26 23:39:48 +02:00
|
|
|
package server
|
|
|
|
|
|
|
|
import (
|
2018-03-03 13:53:52 +02:00
|
|
|
"context"
|
2020-02-15 17:10:26 +02:00
|
|
|
"crypto/tls"
|
2019-05-27 15:17:57 +02:00
|
|
|
"sync"
|
2016-01-27 01:32:27 +02:00
|
|
|
"time"
|
|
|
|
|
2021-10-12 13:55:53 +02:00
|
|
|
"go-micro.dev/v4/broker"
|
|
|
|
"go-micro.dev/v4/codec"
|
|
|
|
"go-micro.dev/v4/debug/trace"
|
2022-09-29 16:44:53 +02:00
|
|
|
"go-micro.dev/v4/logger"
|
2021-10-12 13:55:53 +02:00
|
|
|
"go-micro.dev/v4/registry"
|
|
|
|
"go-micro.dev/v4/transport"
|
2015-05-26 23:39:48 +02:00
|
|
|
)
|
|
|
|
|
2022-09-29 16:44:53 +02:00
|
|
|
type RouterOptions struct {
|
|
|
|
Logger logger.Logger
|
|
|
|
}
|
|
|
|
|
|
|
|
type RouterOption func(o *RouterOptions)
|
|
|
|
|
2022-10-20 13:00:50 +02:00
|
|
|
func NewRouterOptions(opt ...RouterOption) RouterOptions {
|
2022-09-29 16:44:53 +02:00
|
|
|
opts := RouterOptions{
|
|
|
|
Logger: logger.DefaultLogger,
|
|
|
|
}
|
|
|
|
|
|
|
|
for _, o := range opt {
|
|
|
|
o(&opts)
|
|
|
|
}
|
|
|
|
|
|
|
|
return opts
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// WithRouterLogger sets the underline router logger.
|
2022-09-29 16:44:53 +02:00
|
|
|
func WithRouterLogger(l logger.Logger) RouterOption {
|
|
|
|
return func(o *RouterOptions) {
|
|
|
|
o.Logger = l
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-12-31 20:11:46 +02:00
|
|
|
type Options struct {
|
2022-07-30 11:56:14 +02:00
|
|
|
Codecs map[string]codec.NewCodec
|
|
|
|
Broker broker.Broker
|
|
|
|
Registry registry.Registry
|
|
|
|
Tracer trace.Tracer
|
|
|
|
Transport transport.Transport
|
|
|
|
Metadata map[string]string
|
|
|
|
Name string
|
|
|
|
Address string
|
|
|
|
Advertise string
|
|
|
|
Id string
|
|
|
|
Version string
|
|
|
|
HdlrWrappers []HandlerWrapper
|
|
|
|
SubWrappers []SubscriberWrapper
|
|
|
|
ListenOptions []transport.ListenOption
|
2022-09-29 16:44:53 +02:00
|
|
|
Logger logger.Logger
|
2015-12-31 20:11:46 +02:00
|
|
|
|
2019-05-13 00:39:42 +02:00
|
|
|
// RegisterCheck runs a check function before registering the service
|
|
|
|
RegisterCheck func(context.Context) error
|
2019-01-08 22:32:47 +02:00
|
|
|
// The register expiry time
|
2016-01-27 14:23:18 +02:00
|
|
|
RegisterTTL time.Duration
|
2019-01-24 15:22:17 +02:00
|
|
|
// The interval on which to register
|
|
|
|
RegisterInterval time.Duration
|
2016-01-27 14:23:18 +02:00
|
|
|
|
2019-01-08 22:32:47 +02:00
|
|
|
// The router for requests
|
|
|
|
Router Router
|
|
|
|
|
2020-02-15 17:10:26 +02:00
|
|
|
// TLSConfig specifies tls.Config for secure serving
|
|
|
|
TLSConfig *tls.Config
|
|
|
|
|
2016-01-06 18:25:12 +02:00
|
|
|
// Other options for implementations of the interface
|
|
|
|
// can be stored in a context
|
|
|
|
Context context.Context
|
2015-12-31 20:11:46 +02:00
|
|
|
}
|
|
|
|
|
2022-10-20 13:00:50 +02:00
|
|
|
// NewOptions creates new server options.
|
|
|
|
func NewOptions(opt ...Option) Options {
|
2015-12-31 20:11:46 +02:00
|
|
|
opts := Options{
|
2019-09-23 18:59:34 +02:00
|
|
|
Codecs: make(map[string]codec.NewCodec),
|
|
|
|
Metadata: map[string]string{},
|
|
|
|
RegisterInterval: DefaultRegisterInterval,
|
|
|
|
RegisterTTL: DefaultRegisterTTL,
|
2022-09-29 16:44:53 +02:00
|
|
|
Logger: logger.DefaultLogger,
|
2015-11-25 21:50:05 +02:00
|
|
|
}
|
2015-05-26 23:39:48 +02:00
|
|
|
|
|
|
|
for _, o := range opt {
|
|
|
|
o(&opts)
|
|
|
|
}
|
|
|
|
|
2015-12-31 20:11:46 +02:00
|
|
|
if opts.Broker == nil {
|
|
|
|
opts.Broker = broker.DefaultBroker
|
2015-06-12 20:52:27 +02:00
|
|
|
}
|
|
|
|
|
2015-12-31 20:11:46 +02:00
|
|
|
if opts.Registry == nil {
|
|
|
|
opts.Registry = registry.DefaultRegistry
|
2015-06-01 19:55:27 +02:00
|
|
|
}
|
|
|
|
|
2015-12-31 20:11:46 +02:00
|
|
|
if opts.Transport == nil {
|
|
|
|
opts.Transport = transport.DefaultTransport
|
2015-05-26 23:39:48 +02:00
|
|
|
}
|
|
|
|
|
2019-05-13 00:39:42 +02:00
|
|
|
if opts.RegisterCheck == nil {
|
|
|
|
opts.RegisterCheck = DefaultRegisterCheck
|
|
|
|
}
|
|
|
|
|
2015-12-31 20:11:46 +02:00
|
|
|
if len(opts.Address) == 0 {
|
|
|
|
opts.Address = DefaultAddress
|
2015-05-26 23:39:48 +02:00
|
|
|
}
|
|
|
|
|
2015-12-31 20:11:46 +02:00
|
|
|
if len(opts.Name) == 0 {
|
|
|
|
opts.Name = DefaultName
|
2015-05-26 23:39:48 +02:00
|
|
|
}
|
|
|
|
|
2015-12-31 20:11:46 +02:00
|
|
|
if len(opts.Id) == 0 {
|
|
|
|
opts.Id = DefaultId
|
2015-05-26 23:39:48 +02:00
|
|
|
}
|
|
|
|
|
2015-12-31 20:11:46 +02:00
|
|
|
if len(opts.Version) == 0 {
|
|
|
|
opts.Version = DefaultVersion
|
2015-06-03 02:25:37 +02:00
|
|
|
}
|
|
|
|
|
2015-05-26 23:39:48 +02:00
|
|
|
return opts
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Server name.
|
2015-06-03 02:25:37 +02:00
|
|
|
func Name(n string) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Name = n
|
2015-06-03 02:25:37 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Unique server id.
|
2015-06-03 02:25:37 +02:00
|
|
|
func Id(id string) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Id = id
|
2015-06-03 02:25:37 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Version of the service.
|
2015-06-03 02:25:37 +02:00
|
|
|
func Version(v string) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Version = v
|
2015-06-03 02:25:37 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Address to bind to - host:port.
|
2015-06-03 02:25:37 +02:00
|
|
|
func Address(a string) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Address = a
|
2015-06-03 02:25:37 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// The address to advertise for discovery - host:port.
|
2015-11-11 20:22:04 +02:00
|
|
|
func Advertise(a string) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Advertise = a
|
2015-11-11 20:22:04 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Broker to use for pub/sub.
|
2015-06-12 20:52:27 +02:00
|
|
|
func Broker(b broker.Broker) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Broker = b
|
2015-06-12 20:52:27 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Codec to use to encode/decode requests for a given content type.
|
2015-11-28 13:22:29 +02:00
|
|
|
func Codec(contentType string, c codec.NewCodec) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Codecs[contentType] = c
|
2015-11-25 21:50:05 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-12-05 18:37:03 +02: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
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Registry used for discovery.
|
2015-06-03 02:25:37 +02:00
|
|
|
func Registry(r registry.Registry) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Registry = r
|
2015-06-03 02:25:37 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Tracer mechanism for distributed tracking.
|
2020-01-29 17:45:11 +02:00
|
|
|
func Tracer(t trace.Tracer) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.Tracer = t
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Transport mechanism for communication e.g http, rabbitmq, etc.
|
2015-06-03 02:25:37 +02:00
|
|
|
func Transport(t transport.Transport) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Transport = t
|
2015-06-03 02:25:37 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Metadata associated with the server.
|
2015-06-03 02:25:37 +02:00
|
|
|
func Metadata(md map[string]string) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Metadata = md
|
2015-06-03 02:25:37 +02:00
|
|
|
}
|
|
|
|
}
|
2015-12-02 02:47:52 +02:00
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// RegisterCheck run func before registry service.
|
2019-05-13 00:39:42 +02:00
|
|
|
func RegisterCheck(fn func(context.Context) error) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.RegisterCheck = fn
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Register the service with a TTL.
|
2016-01-27 14:23:18 +02:00
|
|
|
func RegisterTTL(t time.Duration) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.RegisterTTL = t
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Register the service with at interval.
|
2019-01-24 15:22:17 +02:00
|
|
|
func RegisterInterval(t time.Duration) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.RegisterInterval = t
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// TLSConfig specifies a *tls.Config.
|
2020-02-15 17:10:26 +02:00
|
|
|
func TLSConfig(t *tls.Config) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
// set the internal tls
|
|
|
|
o.TLSConfig = t
|
2020-02-17 11:28:48 +02:00
|
|
|
|
|
|
|
// set the default transport if one is not
|
|
|
|
// already set. Required for Init call below.
|
|
|
|
if o.Transport == nil {
|
|
|
|
o.Transport = transport.DefaultTransport
|
|
|
|
}
|
|
|
|
|
2020-02-15 17:10:26 +02:00
|
|
|
// set the transport tls
|
|
|
|
o.Transport.Init(
|
|
|
|
transport.Secure(true),
|
|
|
|
transport.TLSConfig(t),
|
|
|
|
)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// WithRouter sets the request router.
|
2019-01-08 22:32:47 +02:00
|
|
|
func WithRouter(r Router) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.Router = r
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// WithLogger sets the underline logger.
|
2022-09-29 16:44:53 +02:00
|
|
|
func WithLogger(l logger.Logger) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.Logger = l
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-05-31 20:47:50 +02:00
|
|
|
// Wait tells the server to wait for requests to finish before exiting
|
2019-05-27 15:17:57 +02:00
|
|
|
// 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 20:47:50 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
if o.Context == nil {
|
|
|
|
o.Context = context.Background()
|
|
|
|
}
|
2019-05-27 15:17:57 +02:00
|
|
|
if wg == nil {
|
|
|
|
wg = new(sync.WaitGroup)
|
|
|
|
}
|
2022-10-20 13:00:50 +02:00
|
|
|
o.Context = context.WithValue(o.Context, wgKey{}, wg)
|
2017-05-31 20:47:50 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Adds a handler Wrapper to a list of options passed into the server.
|
2015-12-02 13:54:36 +02:00
|
|
|
func WrapHandler(w HandlerWrapper) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.HdlrWrappers = append(o.HdlrWrappers, w)
|
2015-12-02 02:47:52 +02:00
|
|
|
}
|
|
|
|
}
|
2015-12-02 13:54:36 +02:00
|
|
|
|
2022-09-30 16:27:07 +02:00
|
|
|
// Adds a subscriber Wrapper to a list of options passed into the server.
|
2015-12-02 13:54:36 +02:00
|
|
|
func WrapSubscriber(w SubscriberWrapper) Option {
|
2015-12-31 20:11:46 +02:00
|
|
|
return func(o *Options) {
|
|
|
|
o.SubWrappers = append(o.SubWrappers, w)
|
2015-12-02 13:54:36 +02:00
|
|
|
}
|
|
|
|
}
|
2022-07-30 11:56:14 +02:00
|
|
|
|
|
|
|
// Add transport.ListenOption to the ListenOptions list, when using it, it will be passed to the
|
2022-09-30 16:27:07 +02:00
|
|
|
// httpTransport.Listen() method.
|
2022-07-30 11:56:14 +02:00
|
|
|
func ListenOption(option transport.ListenOption) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.ListenOptions = append(o.ListenOptions, option)
|
|
|
|
}
|
|
|
|
}
|