The highest tagged major version is v3.

web

package

v1.18.0 Latest Latest Go to latest Published: Dec 8, 2019 License: Apache-2.0 Imports: 22 Imported by: 116

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/micro/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"
)

Functions ¶

This section is empty.

Types ¶

type Option ¶

type Option func(o *Options)

func Action ¶

func Action(a func(*cli.Context)) Option

Action sets the command action.

func Address ¶

func Address(a string) Option

Address to bind to - host:port

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 AfterStop ¶

func AfterStop(fn func() error) Option

AfterStop is executed after server stop.

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 Flags ¶

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

Flags sets the command flags.

func Handler ¶

func Handler(h http.Handler) Option

func Icon ¶ added in v1.17.0

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 RegisterInterval ¶

func RegisterInterval(t time.Duration) Option

func RegisterTTL ¶

func RegisterTTL(t time.Duration) Option

func Registry ¶

func Registry(r registry.Registry) Option

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

	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
}

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