Documentation ¶
Overview ¶
Package micro is a pluggable framework for microservices
Index ¶
- Variables
- func NewContext(ctx context.Context, s Service) context.Context
- func RegisterHandler(s server.Server, h interface{}, opts ...server.HandlerOption) error
- func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error
- type Function
- type Option
- func Action(a func(*cli.Context)) Option
- func AfterStart(fn func() error) Option
- func AfterStop(fn func() error) Option
- func BeforeStart(fn func() error) Option
- func BeforeStop(fn func() error) Option
- func Broker(b broker.Broker) Option
- func Client(c client.Client) Option
- func Cmd(c cmd.Cmd) Option
- func Context(ctx context.Context) Option
- func Flags(flags ...cli.Flag) Option
- func Metadata(md map[string]string) Option
- func Name(n string) Option
- func RegisterInterval(t time.Duration) Option
- func RegisterTTL(t time.Duration) Option
- func Registry(r registry.Registry) Option
- func Selector(s selector.Selector) Option
- func Server(s server.Server) Option
- func Transport(t transport.Transport) Option
- func Version(v string) Option
- func WrapCall(w ...client.CallWrapper) Option
- func WrapClient(w ...client.Wrapper) Option
- func WrapHandler(w ...server.HandlerWrapper) Option
- func WrapSubscriber(w ...server.SubscriberWrapper) Option
- type Options
- type Publisher
- type Service
Constants ¶
This section is empty.
Variables ¶
var (
HeaderPrefix = "Micro-"
)
Functions ¶
func NewContext ¶
NewContext returns a new Context with the Service embedded within it.
func RegisterHandler ¶
func RegisterHandler(s server.Server, h interface{}, opts ...server.HandlerOption) error
RegisterHandler is syntactic sugar for registering a handler
func RegisterSubscriber ¶
func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error
RegisterSubscriber is syntactic sugar for registering a subscriber
Types ¶
type Function ¶
type Function interface { // Inherits Service interface Service // Done signals to complete execution Done() error // Handle registers an RPC handler Handle(v interface{}) error // Subscribe registers a subscriber Subscribe(topic string, v interface{}) error }
Function is a one time executing Service
func NewFunction ¶
NewFunction returns a new Function for a one time executing Service
type Option ¶
type Option func(*Options)
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 option values.
func RegisterInterval ¶
RegisterInterval specifies the interval on which to re-register
func RegisterTTL ¶
RegisterTTL specifies the TTL to use when registering the service
func WrapCall ¶
func WrapCall(w ...client.CallWrapper) 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) Option
WrapHandler adds a handler Wrapper to a list of options passed into the server
func WrapSubscriber ¶
func WrapSubscriber(w ...server.SubscriberWrapper) Option
WrapSubscriber adds a subscriber Wrapper to a list of options passed into the server
type Options ¶
type Options struct { Broker broker.Broker Cmd cmd.Cmd Client client.Client Server server.Server Registry registry.Registry Transport transport.Transport // Before and After funcs BeforeStart []func() error BeforeStop []func() error AfterStart []func() error AfterStop []func() error // Other options for implementations of the interface // can be stored in a context Context context.Context }
type Publisher ¶
type Publisher interface {
Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error
}
Publisher is syntactic sugar for publishing
type Service ¶
type Service interface { Init(...Option) Options() Options Client() client.Client Server() server.Server Run() error String() string }
Service is an interface that wraps the lower level libraries within go-micro. Its a convenience method for building and initialising services.
func FromContext ¶
FromContext retrieves a Service from the Context.
func NewService ¶
NewService creates and returns a new Service based on the packages within.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
api
module
|
|
handler
Module
|
|
handler/api
Module
|
|
handler/event
Module
|
|
handler/http
Module
|
|
handler/rpc
Module
|
|
handler/web
Module
|
|
internal
Module
|
|
internal/proto
Module
|
|
proto
Module
|
|
resolver
Module
|
|
resolver/grpc
Module
|
|
resolver/host
Module
|
|
resolver/path
Module
|
|
resolver/vpath
Module
|
|
router
Module
|
|
router/registry
Module
|
|
router/static
Module
|
|
router/util
Module
|
|
server
Module
|
|
server/acme
Module
|
|
server/acme/autocert
Module
|
|
server/cors
Module
|
|
server/http
Module
|
|
auth
module
|
|
Package broker is an interface used for asynchronous messaging
|
Package broker is an interface used for asynchronous messaging |
http
Package http provides a http based message broker
|
Package http provides a http based message broker |
memory
Package memory provides a memory broker
|
Package memory provides a memory broker |
cache
module
|
|
Package client is an interface for an RPC client
|
Package client is an interface for an RPC client |
mock
Package mock provides a mock client for testing
|
Package mock provides a mock client for testing |
rpc
Package rpc provides an rpc client
|
Package rpc provides an rpc client |
Package cmd is an interface for parsing the command line
|
Package cmd is an interface for parsing the command line |
dashboard
Module
|
|
dashboard/config
Module
|
|
dashboard/handler
Module
|
|
dashboard/handler/account
Module
|
|
dashboard/handler/client
Module
|
|
dashboard/handler/registry
Module
|
|
dashboard/handler/route
Module
|
|
dashboard/handler/statistics
Module
|
|
dashboard/util
Module
|
|
dashboard/web
Module
|
|
micro
Module
|
|
micro/cli
Module
|
|
micro/cli/call
Module
|
|
micro/cli/describe
Module
|
|
micro/cli/generate
Module
|
|
micro/cli/new
Module
|
|
micro/cli/run
Module
|
|
micro/cli/services
Module
|
|
micro/cli/stream
Module
|
|
micro/debug
Module
|
|
micro/debug/trace
Module
|
|
micro/debug/trace/jaeger
Module
|
|
micro/generator
Module
|
|
micro/generator/template
Module
|
|
protoc-gen-micro
Module
|
|
protoc-gen-micro/examples
Module
|
|
protoc-gen-micro/generator
Module
|
|
protoc-gen-micro/plugin
Module
|
|
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
Module
|
|
config
module
|
|
encoder
Module
|
|
encoder/json
Module
|
|
loader
Module
|
|
loader/memory
Module
|
|
reader
Module
|
|
reader/json
Module
|
|
secrets
Module
|
|
secrets/box
Module
|
|
secrets/secretbox
Module
|
|
source
Module
|
|
source/cli
Module
|
|
source/env
Module
|
|
source/file
Module
|
|
source/flag
Module
|
|
source/memory
Module
|
|
debug
module
|
|
handler
Module
|
|
log
Module
|
|
log/memory
Module
|
|
log/noop
Module
|
|
profile
Module
|
|
profile/http
Module
|
|
profile/pprof
Module
|
|
proto
Module
|
|
stats
Module
|
|
trace
Module
|
|
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. |
events
module
|
|
examples
module
|
|
broker
Module
|
|
broker/consumer
Module
|
|
broker/producer
Module
|
|
cache
Module
|
|
cache/handler
Module
|
|
cache/proto
Module
|
|
client
Module
|
|
client/codegen
Module
|
|
client/dc_filter
Module
|
|
client/dc_selector
Module
|
|
client/pub
Module
|
|
client/selector
Module
|
|
client/wrapper
Module
|
|
config
Module
|
|
config/file
Module
|
|
config/grpc
Module
|
|
config/grpc/client
Module
|
|
config/grpc/srv
Module
|
|
config/modify
Module
|
|
config/yaml
Module
|
|
event
Module
|
|
event/srv
Module
|
|
event/srv/proto
Module
|
|
filter
Module
|
|
filter/version
Module
|
|
flags
Module
|
|
function
Module
|
|
function/proto
Module
|
|
gateway
Module
|
|
gateway/proto
Module
|
|
gateway/proto/hello
Module
|
|
getip
Module
|
|
getip/proto
Module
|
|
graceful
Module
|
|
greeter
Module
|
|
greeter/cli
Module
|
|
greeter/cli/sidecar
Module
|
|
greeter/srv
Module
|
|
greeter/srv/proto
Module
|
|
greeter/srv/proto/hello
Module
|
|
heartbeat
Module
|
|
helloworld
Module
|
|
helloworld/proto
Module
|
|
http
Module
|
|
http/cli
Module
|
|
http/rpccli
Module
|
|
http/srv
Module
|
|
metadata
Module
|
|
metadata/cli
Module
|
|
metadata/srv
Module
|
|
mocking
Module
|
|
mocking/mock
Module
|
|
noproto
Module
|
|
noproto/client
Module
|
|
pubsub
Module
|
|
pubsub/cli
Module
|
|
pubsub/srv
Module
|
|
pubsub/srv/proto
Module
|
|
redirect
Module
|
|
roundrobin
Module
|
|
secure
Module
|
|
secure/cli
Module
|
|
secure/srv
Module
|
|
secure/srv/proto
Module
|
|
secure/srv/proto/hello
Module
|
|
server
Module
|
|
server/codegen
Module
|
|
server/handler
Module
|
|
server/proto
Module
|
|
server/proto/example
Module
|
|
server/subscriber
Module
|
|
server/wrapper
Module
|
|
service
Module
|
|
service/proto
Module
|
|
sharding
Module
|
|
shutdown
Module
|
|
stream
Module
|
|
stream/grpc
Module
|
|
stream/grpc/client
Module
|
|
stream/grpc/proto
Module
|
|
stream/grpc/server
Module
|
|
stream/rpc
Module
|
|
stream/rpc/client
Module
|
|
stream/rpc/server
Module
|
|
stream/rpc/server/proto
Module
|
|
waitgroup
Module
|
|
wrapper
Module
|
|
wrapper/cli
Module
|
|
grpc
module
|
|
http
module
|
|
logger
module
|
|
Package metadata is a way of defining message headers
|
Package metadata is a way of defining message headers |
mock
module
|
|
mucp
module
|
|
options
module
|
|
plugins
module
|
|
acme
Module
|
|
acme/certmagic
Module
|
|
auth
Module
|
|
auth/jwt
Module
|
|
auth/jwt/token
Module
|
|
broker
Module
|
|
broker/gocloud
Module
|
|
broker/googlepubsub
Module
|
|
broker/grpc
Module
|
|
broker/grpc/proto
Module
|
|
broker/http
Module
|
|
broker/kafka
Module
|
|
broker/memory
Module
|
|
broker/mqtt
Module
|
|
broker/nats
Module
|
|
broker/nsq
Module
|
|
broker/proxy
Module
|
|
broker/rabbitmq
Module
|
|
broker/redis
Module
|
|
broker/segmentio
Module
|
|
broker/snssqs
Module
|
|
broker/sqs
Module
|
|
broker/stan
Module
|
|
broker/stomp
Module
|
|
client
Module
|
|
client/grpc
Module
|
|
client/http
Module
|
|
client/http/test
Module
|
|
client/mock
Module
|
|
client/mucp
Module
|
|
codec
Module
|
|
codec/bsonrpc
Module
|
|
codec/json-iterator
Module
|
|
codec/jsonrpc2
Module
|
|
codec/msgpackrpc
Module
|
|
codec/segmentio
Module
|
|
config
Module
|
|
config/encoder
Module
|
|
config/encoder/cue
Module
|
|
config/encoder/hcl
Module
|
|
config/encoder/toml
Module
|
|
config/encoder/xml
Module
|
|
config/encoder/yaml
Module
|
|
config/source
Module
|
|
config/source/configmap
Module
|
|
config/source/consul
Module
|
|
config/source/etcd
Module
|
|
config/source/grpc
Module
|
|
config/source/grpc/proto
Module
|
|
config/source/mucp
Module
|
|
config/source/mucp/proto
Module
|
|
config/source/nacos
Module
|
|
config/source/pkger
Module
|
|
config/source/runtimevar
Module
|
|
config/source/url
Module
|
|
config/source/vault
Module
|
|
events
Module
|
|
events/nats
Module
|
|
events/redis
Module
|
|
logger
Module
|
|
logger/apex
Module
|
|
logger/logrus
Module
|
|
logger/windowseventlog
Module
|
|
logger/zap
Module
|
|
logger/zerolog
Module
|
|
proxy
Module
|
|
proxy/http
Module
|
|
registry
Module
|
|
registry/cache
Module
|
|
registry/consul
Module
|
|
registry/etcd
Module
|
|
registry/eureka
Module
|
|
registry/eureka/mock
Module
|
|
registry/gossip
Module
|
|
registry/gossip/proto
Module
|
|
registry/kubernetes
Module
|
|
registry/kubernetes/client
Module
|
|
registry/mdns
Module
|
|
registry/memory
Module
|
|
registry/multi
Module
|
|
registry/nacos
Module
|
|
registry/nats
Module
|
|
registry/proxy
Module
|
|
registry/zookeeper
Module
|
|
selector
Module
|
|
selector/dns
Module
|
|
selector/label
Module
|
|
selector/registry
Module
|
|
selector/shard
Module
|
|
selector/static
Module
|
|
server
Module
|
|
server/grpc
Module
|
|
server/grpc/proto
Module
|
|
server/http
Module
|
|
server/mucp
Module
|
|
store
Module
|
|
store/cockroach
Module
|
|
store/consul
Module
|
|
store/file
Module
|
|
store/memcached
Module
|
|
store/memory
Module
|
|
store/mysql
Module
|
|
store/redis
Module
|
|
sync
Module
|
|
sync/consul
Module
|
|
sync/etcd
Module
|
|
sync/memory
Module
|
|
transport
Module
|
|
transport/grpc
Module
|
|
transport/grpc/proto
Module
|
|
transport/http
Module
|
|
transport/memory
Module
|
|
transport/nats
Module
|
|
transport/quic
Module
|
|
transport/rabbitmq
Module
|
|
transport/tcp
Module
|
|
transport/utp
Module
|
|
wrapper
Module
|
|
wrapper/breaker
Module
|
|
wrapper/breaker/gobreaker
Module
|
|
wrapper/breaker/hystrix
Module
|
|
wrapper/endpoint
Module
|
|
wrapper/monitoring
Module
|
|
wrapper/ratelimiter
Module
|
|
wrapper/ratelimiter/uber
Module
|
|
wrapper/select
Module
|
|
wrapper/select/roundrobin
Module
|
|
wrapper/select/shard
Module
|
|
wrapper/select/version
Module
|
|
wrapper/service
Module
|
|
wrapper/trace
Module
|
|
wrapper/trace/awsxray
Module
|
|
wrapper/trace/datadog
Module
|
|
wrapper/trace/opencensus
Module
|
|
wrapper/trace/opentracing
Module
|
|
wrapper/validator
Module
|
|
pool
module
|
|
Package mdns is a multicast dns registry Package registry is an interface for service discovery
|
Package mdns is a multicast dns registry Package registry is an interface for service discovery |
gossip
Package Gossip provides a gossip registry based on hashicorp/memberlist
|
Package Gossip provides a gossip registry based on hashicorp/memberlist |
gossip/proto
Package gossip is a generated protocol buffer package.
|
Package gossip is a generated protocol buffer package. |
mdns
Package mdns provides 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 |
cache
Module
|
|
rpc
module
|
|
runtime
module
|
|
kubernetes
Module
|
|
local
Module
|
|
local/build
Module
|
|
local/build/docker
Module
|
|
local/build/go
Module
|
|
local/git
Module
|
|
local/process
Module
|
|
local/process/os
Module
|
|
local/source
Module
|
|
local/source/git
Module
|
|
local/source/go
Module
|
|
Package selector is a way to pick a list of service nodes
|
Package selector is a way to pick a list of service nodes |
dns
Package dns provides a dns SRV selector
|
Package dns provides a dns SRV selector |
registry
Package registry uses the go-micro registry for selection
|
Package registry uses the go-micro registry for selection |
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 server is an interface for a micro server
|
Package server is an interface for a micro server |
debug/proto
Package debug is a generated protocol buffer package.
|
Package debug is a generated protocol buffer package. |
rpc
Package rpc provides an rpc server
|
Package rpc provides an rpc server |
proto
Module
|
|
services
module
|
|
address
Module
|
|
answer
Module
|
|
cache
Module
|
|
crypto
Module
|
|
currency
Module
|
|
db
Module
|
|
email
Module
|
|
emoji
Module
|
|
evchargers
Module
|
|
file
Module
|
|
forex
Module
|
|
function
Module
|
|
geocoding
Module
|
|
gifs
Module
|
|
google
Module
|
|
helloworld
Module
|
|
holidays
Module
|
|
id
Module
|
|
image
Module
|
|
ip
Module
|
|
location
Module
|
|
notes
Module
|
|
otp
Module
|
|
postcode
Module
|
|
prayer
Module
|
|
qr
Module
|
|
quran
Module
|
|
routing
Module
|
|
rss
Module
|
|
sentiment
Module
|
|
sms
Module
|
|
stock
Module
|
|
stream
Module
|
|
sunnah
Module
|
|
thumbnail
Module
|
|
time
Module
|
|
twitter
Module
|
|
url
Module
|
|
user
Module
|
|
vehicle
Module
|
|
weather
Module
|
|
youtube
Module
|
|
store
module
|
|
sync
module
|
|
Package transport is an interface for synchronous communication
|
Package transport is an interface for synchronous communication |
http
Package http returns a http2 transport using net/http
|
Package http returns a http2 transport using net/http |
memory
Package memory is an in-memory transport
|
Package memory is an in-memory transport |
util
module
|
|
addr
Module
|
|
backoff
Module
|
|
buf
Module
|
|
ctx
Module
|
|
file
Module
|
|
file/proto
Module
|
|
grpc
Module
|
|
http
Module
|
|
io
Module
|
|
jitter
Module
|
|
kubernetes
Module
|
|
kubernetes/api
Module
|
|
kubernetes/client
Module
|
|
log
Module
|
|
mdns
Module
|
|
net
Module
|
|
pki
Module
|
|
pool
Module
|
|
qson
Module
|
|
registry
Module
|
|
ring
Module
|
|
signal
Module
|
|
socket
Module
|
|
stream
Module
|
|
sync
Module
|
|
test
Module
|
|
tls
Module
|
|
wrapper
Module
|
|
web
module
|