web

package

v1.0.1 Latest Latest Go to latest Published: May 10, 2021 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/NSObjects/go-micro

Links

Open Source Insights

Documentation ¶

Overview ¶

Package web provides web based micro services

Index ¶

Variables
type Option
type Options
type Service
- func NewService(opts ...Option) Service

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// For serving
	DefaultName    = "go-web"
	DefaultVersion = "latest"
	DefaultId      = uuid.New().String()
	DefaultAddress = ":0"

	// for registration
	DefaultRegisterTTL      = time.Minute
	DefaultRegisterInterval = time.Second * 30

	// static directory
	DefaultStaticDir     = "html"
	DefaultRegisterCheck = func(context.Context) error { return nil }
)

Functions ¶

This section is empty.

Types ¶

type Option ¶

type Option func(o *Options)

func Advertise ¶

func Advertise(a string) Option

The address to advertise for discovery - host:port

func AfterStart ¶

func AfterStart(fn func() error) Option

AfterStart is executed after server start.

func BeforeStart ¶

func BeforeStart(fn func() error) Option

BeforeStart is executed before the server starts.

func BeforeStop ¶

func BeforeStop(fn func() error) Option

BeforeStop is executed before the server stops.

func Context ¶

func Context(ctx context.Context) Option

Context specifies a context for the service. Can be used to signal shutdown of the service. Can be used for extra option values.

func HandleSignal ¶

func HandleSignal(b bool) Option

HandleSignal toggles automatic installation of the signal handler that traps TERM, INT, and QUIT. Users of this feature to disable the signal handler, should control liveness of the service through the context.

func Handler ¶

func Handler(h http.Handler) Option

func Icon ¶

func Icon(ico string) Option

Icon specifies an icon url to load in the UI

func Id ¶

func Id(id string) Option

Unique server id

func Metadata ¶

func Metadata(md map[string]string) Option

Metadata associated with the service

func MicroService ¶

func MicroService(s micro.Service) Option

MicroService sets the micro.Service used internally

func Name ¶

func Name(n string) Option

Server name

func RegisterCheck ¶

func RegisterCheck(fn func(context.Context) error) Option

RegisterCheck run func before registry service

func RegisterInterval ¶

func RegisterInterval(t time.Duration) Option

Register the service with at interval

func RegisterTTL ¶

func RegisterTTL(t time.Duration) Option

Register the service with a TTL

func Registry ¶

func Registry(r registry.Registry) Option

Registry used for discovery

func Secure ¶

func Secure(b bool) Option

Secure Use secure communication. If TLSConfig is not specified we use InsecureSkipVerify and generate a self signed cert

func Server ¶

func Server(srv *http.Server) Option

func StaticDir ¶

func StaticDir(d string) Option

StaticDir sets the static file directory. This defaults to ./html

func TLSConfig ¶

func TLSConfig(t *tls.Config) Option

TLSConfig to be used for the transport.

func Version ¶

func Version(v string) Option

Version of the service

type Options ¶

type Options struct {
	Name      string
	Version   string
	Id        string
	Metadata  map[string]string
	Address   string
	Advertise string

	Action func(*cli.Context)
	Flags  []cli.Flag

	RegisterTTL      time.Duration
	RegisterInterval time.Duration

	// RegisterCheck runs a check function before registering the service
	RegisterCheck func(context.Context) error

	Server  *http.Server
	Handler http.Handler

	// Alternative Options
	Context context.Context

	Registry registry.Registry
	Service  micro.Service

	Secure      bool
	TLSConfig   *tls.Config
	BeforeStart []func() error
	BeforeStop  []func() error
	AfterStart  []func() error
	AfterStop   []func() error

	// Static directory
	StaticDir string

	Signal bool
}

type Service ¶

type Service interface {
	Client() *http.Client
	Init(opts ...Option) error
	Options() Options
	Handle(pattern string, handler http.Handler)
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
	Run() error
}

Service is a web service with service discovery built in

func NewService ¶

func NewService(opts ...Option) Service

NewService returns a new web.Service

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

web