Documentation ¶
Overview ¶
Package stack is a pluggable framework for microservices
Index ¶
- func Action(a func(*cli.Context)) service.Option
- func Address(addr string) service.Option
- func AfterStart(fn func() error) service.Option
- func AfterStop(fn func() error) service.Option
- func BeforeStart(fn func() error) service.Option
- func BeforeStop(fn func() error) service.Option
- func Broker(b broker.Broker) service.Option
- func Client(c client.Client) service.Option
- func Cmd(c cmd.Cmd) service.Option
- func Config(c config.Config) service.Option
- func Context(ctx context.Context) service.Option
- func Flags(flags ...cli.Flag) service.Option
- func FromContext(ctx context.Context) (service.Service, bool)
- func HandleSignal(b bool) service.Option
- func Id(id string) service.Option
- func Logger(l logger.Logger) service.Option
- func Metadata(md map[string]string) service.Option
- func Name(n string) service.Option
- func NewContext(ctx context.Context, s service.Service) context.Context
- func NewGRPCService(opts ...service.Option) service.Service
- func NewService(opts ...service.Option) service.Service
- func NewWebService(opts ...service.Option) service.Service
- func Profile(p profile.Profile) service.Option
- func RegisterHandler(s server.Server, h interface{}, opts ...server.HandlerOption) error
- func RegisterInterval(t time.Duration) service.Option
- func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error
- func RegisterTTL(t time.Duration) service.Option
- func Registry(r registry.Registry) service.Option
- func Selector(s selector.Selector) service.Option
- func Server(s server.Server) service.Option
- func Transport(t transport.Transport) service.Option
- func Version(v string) service.Option
- func WebHandleFuncs(funcs ...web.HandlerFunc) service.Option
- func WebRootPath(rootPath string) service.Option
- func WebStaticDir(route, dir string) service.Option
- func WrapCall(w ...client.CallWrapper) service.Option
- func WrapClient(w ...client.Wrapper) service.Option
- func WrapHandler(w ...server.HandlerWrapper) service.Option
- func WrapSubscriber(w ...server.SubscriberWrapper) service.Option
- type Publisher
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AfterStart ¶
func BeforeStart ¶
func BeforeStop ¶
func Context ¶
Context specifies a context for the service. Can be used to signal shutdown of the service. Can be used for extra service.Option values.
func FromContext ¶
FromContext retrieves a Service from the Context.
func HandleSignal ¶
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 NewContext ¶
NewContext returns a new Context with the Service embedded within it.
func NewGRPCService ¶
NewGRPCService creates and returns a new web Service based on the packages within.
func NewService ¶
NewService creates and returns a new Service based on the packages within.
func NewWebService ¶
NewWebService creates and returns a new web Service based on the packages within.
func RegisterHandler ¶
func RegisterHandler(s server.Server, h interface{}, opts ...server.HandlerOption) error
RegisterHandler is syntactic sugar for registering a handler
func RegisterInterval ¶
RegisterInterval specifies the interval on which to re-register
func RegisterSubscriber ¶
func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error
RegisterSubscriber is syntactic sugar for registering a subscriber
func RegisterTTL ¶
RegisterTTL specifies the TTL to use when registering the service
func WebHandleFuncs ¶
func WebHandleFuncs(funcs ...web.HandlerFunc) service.Option
func WebRootPath ¶
func WebStaticDir ¶
func WrapCall ¶
func WrapCall(w ...client.CallWrapper) service.Option
WrapCall is a convenience method for wrapping a Client CallFunc
func WrapClient ¶
WrapClient is a convenience method for wrapping a Client with some middleware component. A list of wrappers can be provided. Wrappers are applied in reverse order so the last is executed first.
func WrapHandler ¶
func WrapHandler(w ...server.HandlerWrapper) service.Option
WrapHandler adds a handler Wrapper to a list of service.Options passed into the server
func WrapSubscriber ¶
func WrapSubscriber(w ...server.SubscriberWrapper) service.Option
WrapSubscriber adds a subscriber Wrapper to a list of service.Options passed into the server
Types ¶
Directories ¶
Path | Synopsis |
---|---|
handler
Package handler provides http handlers
|
Package handler provides http handlers |
handler/api
Package api provides an http-rpc handler which provides the entire http request over rpc
|
Package api provides an http-rpc handler which provides the entire http request over rpc |
handler/broker
Package broker provides a stack/broker handler
|
Package broker provides a stack/broker handler |
handler/cloudevents
Package cloudevents provides a cloudevents handler publishing the event using the stack/client
|
Package cloudevents provides a cloudevents handler publishing the event using the stack/client |
handler/event
Package event provides a handler which publishes an event
|
Package event provides a handler which publishes an event |
handler/file
Package file serves file relative to the current directory
|
Package file serves file relative to the current directory |
handler/http
Package http is a http reverse proxy handler
|
Package http is a http reverse proxy handler |
handler/registry
Package registry is a stack/registry handler
|
Package registry is a stack/registry handler |
handler/rpc
Package rpc is a stack rpc handler.
|
Package rpc is a stack rpc handler. |
handler/udp
Package udp reads and write from a udp connection
|
Package udp reads and write from a udp connection |
handler/unix
Package unix reads from a unix socket expecting it to be in /tmp/path
|
Package unix reads from a unix socket expecting it to be in /tmp/path |
handler/web
Package web contains the web handler including websocket support
|
Package web contains the web handler including websocket support |
resolver
Package resolver resolves a http request to an endpoint
|
Package resolver resolves a http request to an endpoint |
resolver/grpc
Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service
|
Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service |
resolver/host
Package host resolves using http host
|
Package host resolves using http host |
resolver/path
Package path resolves using http path
|
Package path resolves using http path |
resolver/stack
Package stack provides a stack rpc resolver which prefixes a namespace
|
Package stack provides a stack rpc resolver which prefixes a namespace |
resolver/vpath
Package vpath resolves using http path and recognised versioned urls
|
Package vpath resolves using http path and recognised versioned urls |
router
Package router provides api service routing
|
Package router provides api service routing |
router/registry
Package registry provides a dynamic api service router
|
Package registry provides a dynamic api service router |
server
Package server provides an API gateway server which handles inbound requests
|
Package server provides an API gateway server which handles inbound requests |
server/acme
Package acme abstracts away various ACME libraries
|
Package acme abstracts away various ACME libraries |
server/acme/autocert
Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config.
|
Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config. |
server/acme/certmagic
Package certmagic is the ACME provider from github.com/mholt/certmagic
|
Package certmagic is the ACME provider from github.com/mholt/certmagic |
server/http
Package http provides a http server with features; acme, cors, etc
|
Package http provides a http server with features; acme, cors, etc |
Package auth provides authentication and authorization capability
|
Package auth provides authentication and authorization capability |
Package broker is an interface used for asynchronous messaging
|
Package broker is an interface used for asynchronous messaging |
memory
Package memory provides a memory broker
|
Package memory provides a memory broker |
service
Package service provides the broker service client
|
Package service provides the broker service client |
Package client is an interface for an RPC client
|
Package client is an interface for an RPC client |
grpc
Package grpc provides a gRPC client Package grpc provides a gRPC options
|
Package grpc provides a gRPC client Package grpc provides a gRPC options |
http
Package http provides a http client
|
Package http provides a http client |
mock
Package mock provides a mock client for testing
|
Package mock provides a mock client for testing |
pool
Package pool is a connection pool
|
Package pool is a connection pool |
selector
Package selector is a way to pick a list of service nodes
|
Package selector is a way to pick a list of service nodes |
selector/dns
Package dns provides a dns SRV selector
|
Package dns provides a dns SRV selector |
selector/static
Package static provides a static resolver which returns the name/ip passed in without any change
|
Package static provides a static resolver which returns the name/ip passed in without any change |
Package cmd is an interface for parsing the command line
|
Package cmd is an interface for parsing the command line |
Package codec is an interface for encoding messages
|
Package codec is an interface for encoding messages |
bytes
Package bytes provides a bytes codec which does not encode or decode anything
|
Package bytes provides a bytes codec which does not encode or decode anything |
grpc
Package grpc provides a grpc codec
|
Package grpc provides a grpc codec |
json
Package json provides a json codec
|
Package json provides a json codec |
jsonrpc
Package jsonrpc provides a json-rpc 1.0 codec
|
Package jsonrpc provides a json-rpc 1.0 codec |
proto
Package proto provides a proto codec
|
Package proto provides a proto codec |
protorpc
Package proto is a generated protocol buffer package.
|
Package proto is a generated protocol buffer package. |
text
Package text reads any text/* content-type
|
Package text reads any text/* content-type |
Package debug provides stack debug packages
|
Package debug provides stack debug packages |
buffer
Package buffer provides a simple ring buffer for storing local data
|
Package buffer provides a simple ring buffer for storing local data |
handler
Package handler implements service debug handler embedded in go-micro services
|
Package handler implements service debug handler embedded in go-micro services |
log
Package log provides debug logging
|
Package log provides debug logging |
log/memory
Package memory provides an in memory log buffer
|
Package memory provides an in memory log buffer |
profile
Package profile is for profilers
|
Package profile is for profilers |
profile/pprof
Package pprof provides a pprof profiler
|
Package pprof provides a pprof profiler |
service/handler
Pacjage handler implements service debug handler
|
Pacjage handler implements service debug handler |
stats
Package stats provides runtime stats
|
Package stats provides runtime stats |
trace
Package trace provides an interface for distributed tracing
|
Package trace provides an interface for distributed tracing |
examples
module
|
|
Package log provides a log interface
|
Package log provides a log interface |
Package monitor monitors service health
|
Package monitor monitors service health |
pkg
|
|
cli
Package cli provides a minimal framework for creating and organizing command line Go applications.
|
Package cli provides a minimal framework for creating and organizing command line Go applications. |
config
Package config is an interface for dynamic configuration.
|
Package config is an interface for dynamic configuration. |
config/encoder
Package encoder handles source encoding formats
|
Package encoder handles source encoding formats |
config/loader
package loader manages loading from multiple sources
|
package loader manages loading from multiple sources |
config/reader
Package reader parses change sets and provides config values
|
Package reader parses change sets and provides config values |
config/source
Package source is the interface for sources
|
Package source is the interface for sources |
config/source/file
Package file is a file source.
|
Package file is a file source. |
config/source/memory
Package memory is a memory source
|
Package memory is a memory source |
metadata
Package metadata is a way of defining message headers
|
Package metadata is a way of defining message headers |
broker/nats
Module
|
|
config/source/apollo
Module
|
|
logger/logrus
Module
|
|
registry/consul
Module
|
|
registry/etcd
Module
|
|
registry/zookeeper
Module
|
|
service/stackway
Module
|
|
Package proxy is a transparent proxy built on the stack/server
|
Package proxy is a transparent proxy built on the stack/server |
grpc
Package grpc transparently forwards the grpc protocol using a stack client.
|
Package grpc transparently forwards the grpc protocol using a stack client. |
http
Package http provides a stack rpc to http proxy
|
Package http provides a stack rpc to http proxy |
mucp
Package mucp transparently forwards the incoming request using a stack client.
|
Package mucp transparently forwards the incoming request using a stack client. |
Package registry is an interface for service discovery
|
Package registry is an interface for service discovery |
cache
Package cache provides a registry cache
|
Package cache provides a registry cache |
mdns
Package mdns is a multicast dns registry Package mdns provides a multicast dns registry
|
Package mdns is a multicast dns registry Package mdns provides a multicast dns registry |
memory
Package memory provides an in-memory registry
|
Package memory provides an in-memory registry |
service
Package service uses the registry service
|
Package service uses the registry service |
Package router provides a network routing control plane
|
Package router provides a network routing control plane |
Package server is an interface for a stack server
|
Package server is an interface for a stack server |
grpc
Package grpc provides a grpc server
|
Package grpc provides a grpc server |
http
Package http implements a go-micro.Server
|
Package http implements a go-micro.Server |
Package store is an interface for distribute data storage.
|
Package store is an interface for distribute data storage. |
memory
Package memory is a in-memory store store
|
Package memory is a in-memory store store |
service
Package service implements the store service interface
|
Package service implements the store service interface |
Package sync is a distributed synchronization framework
|
Package sync is a distributed synchronization framework |
event
Package event provides a distributed log interface
|
Package event provides a distributed log interface |
leader
Package leader provides leader election
|
Package leader provides leader election |
lock
Package lock provides distributed locking
|
Package lock provides distributed locking |
lock/http
Package http adds a http lock implementation
|
Package http adds a http lock implementation |
lock/http/server
Package server implements the sync http server
|
Package server implements the sync http server |
lock/memory
Package memory provides a sync.Mutex implementation of the lock for local use
|
Package memory provides a sync.Mutex implementation of the lock for local use |
task
Package task provides an interface for distributed jobs
|
Package task provides an interface for distributed jobs |
task/broker
Package broker provides a distributed task manager built on the stack broker
|
Package broker provides a distributed task manager built on the stack broker |
task/local
Package local provides a local task runner
|
Package local provides a local task runner |
time
Package time provides clock synchronization
|
Package time provides clock synchronization |
time/local
Package local provides a local clock
|
Package local provides a local clock |
time/ntp
Package ntp provides ntp synchronized time
|
Package ntp provides ntp synchronized time |
test
|
|
client/http/test
Package test is a generated protocol buffer package.
|
Package test is a generated protocol buffer package. |
Package transport is an interface for synchronous connection based communication
|
Package transport is an interface for synchronous connection based communication |
grpc
Package grpc provides a grpc transport
|
Package grpc provides a grpc transport |
memory
Package memory is an in-memory transport
|
Package memory is an in-memory transport |
quic
Package quic provides a QUIC based transport
|
Package quic provides a QUIC based transport |
util
|
|
errors
Package errors provides a way to return detailed information for an RPC request error.
|
Package errors provides a way to return detailed information for an RPC request error. |
io
Package io is for io management
|
Package io is for io management |
log
Package log is a global internal logger
|
Package log is a global internal logger |
options
Package options provides a way to initialise options
|
Package options provides a way to initialise options |
protoc-gen-stack
protoc-gen-stack is a plugin for the Google protocol buffer compiler to generate Go code.
|
protoc-gen-stack is a plugin for the Google protocol buffer compiler to generate Go code. |
protoc-gen-stack/generator
The code generator for the plugin for the Google protocol buffer compiler.
|
The code generator for the plugin for the Google protocol buffer compiler. |
ring
Package ring provides a simple ring buffer for storing local data
|
Package ring provides a simple ring buffer for storing local data |
socket
Package socket provides a pseudo socket
|
Package socket provides a pseudo socket |
stackctl/new
Package new generates stack service templates
|
Package new generates stack service templates |