Documentation ¶
Overview ¶
Package vine is a pluggable framework for vine services
Index ¶
- 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 Context
- type Event
- type Option
- func Action(a func(*cli.Context) error) Option
- func Address(addr string) 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 Cache(c cache.Cache) Option
- func Client(c client.Client) Option
- func Cmd(c cmd.Cmd) Option
- func Config(c config.Config) Option
- func Dialect(d dao.Dialect) Option
- func Flags(flags ...cli.Flag) Option
- func HandleSignal(b bool) Option
- func Id(id string) Option
- func Metadata(md map[string]string) Option
- func Name(n string) Option
- func PutContext(ctx context.Context) 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 Tracer(t trace.Tracer) 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 Service
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 Context ¶
type Context struct { context.Context App *cli.App Broker broker.Broker Client client.Client Config config.Config Trace trace.Tracer Dialect dao.Dialect Cache cache.Cache Registry registry.Registry Scheduler gscheduler.Scheduler }
Context be used when vine service handling request
func InitContext ¶ added in v1.4.2
type Event ¶
type Event interface { // Publish publishes a message to the event topic Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error }
Event is used to publish messages to topic
type Option ¶
type Option func(*Options)
func AfterStart ¶
AfterStart run functions after service starts
func BeforeStart ¶
BeforeStart run functions before service starts
func BeforeStop ¶
BeforeStop run functions before service stops
func HandleSignal ¶
HandleSignal toggle automatic installation of the signal handler that traps TERM, INT, and QUIT. Users of this future to disable the signal handler, should control liveness of the service through the context
func PutContext ¶ added in v1.4.2
PutContext specifies a context for the service. Can be used to signal shutdown of the service and 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 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 Config config.Config Server server.Server Trace trace.Tracer Dialect dao.Dialect Cache cache.Cache Registry registry.Registry Scheduler gscheduler.Scheduler // Before and After functions 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 Signal bool }
Options for vine service
type Service ¶
type Service interface { // Name The service name Name() string // Init initialises options Init(...Option) // Options returns the current options Options() Options // Server is for handling requests and events Server() server.Server // Client is used to call services Client() client.Client // Run the service Run() error // String The service implementation String() string }
Service is an interface that wraps the lower level libraries within vine. It's 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.
Directories ¶
Path | Synopsis |
---|---|
cmd
|
|
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. |
generator/internal/remap
Package remap handles tracking the locations of Go tokens in a source text across a rewrite by the Go formatter.
|
Package remap handles tracking the locations of Go tokens in a source text across a rewrite by the Go formatter. |
protoc-gen-cli
protoc-gen-cli is a plugin for the Google protocol buffer compiler to generate Go code.
|
protoc-gen-cli is a plugin for the Google protocol buffer compiler to generate Go code. |
protoc-gen-dao
protoc-gen-dao is a plugin for the Google protocol buffer compiler to generate Go code.
|
protoc-gen-dao is a plugin for the Google protocol buffer compiler to generate Go code. |
protoc-gen-deepcopy
protoc-gen-deepcopy is a plugin for the Google protocol buffer compiler to generate Go code.
|
protoc-gen-deepcopy is a plugin for the Google protocol buffer compiler to generate Go code. |
protoc-gen-go
Package main define the proto-gen-go binary we use to generate out proto go file,
|
Package main define the proto-gen-go binary we use to generate out proto go file, |
protoc-gen-gogo
Package main define the proto-gen-gogo binary we use to generate out proto go file,
|
Package main define the proto-gen-gogo binary we use to generate out proto go file, |
protoc-gen-gogo/plugin
The marshalto plugin generates a Marshal and MarshalTo method for each message.
|
The marshalto plugin generates a Marshal and MarshalTo method for each message. |
protoc-gen-validator
protoc-gen-validator is a plugin for the Google protocol buffer compiler to generate Go code.
|
protoc-gen-validator is a plugin for the Google protocol buffer compiler to generate Go code. |
protoc-gen-vine
protoc-gen-vine is a plugin for the Google protocol buffer compiler to generate Go code.
|
protoc-gen-vine is a plugin for the Google protocol buffer compiler to generate Go code. |
vine/app/api
Package api is an API Gateway
|
Package api is an API Gateway |
vine/app/cli/mg
Package mg new generates vine service templates
|
Package mg new generates vine service templates |
vine/app/cli/util
Package cliutil contains methods used across all cli commands @todo: get rid of os.Exits and use errors instread
|
Package cliutil contains methods used across all cli commands @todo: get rid of os.Exits and use errors instread |
vine/client/resolver/api
Package api provides a vine rpc resolver which prefixes a namespace
|
Package api provides a vine rpc resolver which prefixes a namespace |
vine/client/web
Package web is a web dashboard
|
Package web is a web dashboard |
core
|
|
broker
Package broker is an interface used for asynchronous messaging
|
Package broker is an interface used for asynchronous messaging |
broker/http
Package http provides a http based message broker
|
Package http provides a http based message broker |
client/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 |
client/selector/dns
Package dns provides a dns SRV selector
|
Package dns provides a dns SRV selector |
client/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 |
codec/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 |
codec/grpc
Package grpc provides a grpc codec
|
Package grpc provides a grpc codec |
registry/mdns
Package mdns provides a multicast dns registry
|
Package mdns provides a multicast dns registry |
registry/memory
Package memory provides an in-memory registry
|
Package memory provides an in-memory registry |
lib
|
|
api/handler
Package handler provides http handlers
|
Package handler provides http handlers |
api/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 |
api/handler/event
Package event provides a handler which publishes an event
|
Package event provides a handler which publishes an event |
api/handler/http
Package http is a http reverse proxy handler
|
Package http is a http reverse proxy handler |
api/handler/rpc
Package rpc is a vine rpc handler.
|
Package rpc is a vine rpc handler. |
api/handler/web
Package web contains the web handler including websocket support
|
Package web contains the web handler including websocket support |
api/resolver
Package resolver resolves a http request to an endpoint
|
Package resolver resolves a http request to an endpoint |
api/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 |
api/resolver/host
Package host resolves using http host
|
Package host resolves using http host |
api/resolver/path
Package path resolves using http path
|
Package path resolves using http path |
api/resolver/vpath
Package vpath resolves using http path and recognised versioned urls
|
Package vpath resolves using http path and recognised versioned urls |
api/router
Package router provides api service routing
|
Package router provides api service routing |
api/router/registry
Package registry provides a dynamic api service router
|
Package registry provides a dynamic api service router |
api/server
Package server provides an API gateway server which handles inbound requests
|
Package server provides an API gateway server which handles inbound requests |
api/server/http
Package http provides a http server with features; acme, cors, etc
|
Package http provides a http server with features; acme, cors, etc |
cache
Package cache is an interface for distributed data cache.
|
Package cache is an interface for distributed data cache. |
cache/memory
Package memory is a in-memory cache cache
|
Package memory is a in-memory cache cache |
config/loader
Package loader manages loading from multiple sources
|
Package loader manages loading from multiple sources |
config/secrets
Package secrets is an interface for encrypting and decrypting secrets
|
Package secrets is an interface for encrypting and decrypting secrets |
config/secrets/box
Package box is an asymmetric implementation of config/secrets using nacl/box
|
Package box is an asymmetric implementation of config/secrets using nacl/box |
config/secrets/secretbox
Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification
|
Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification |
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 |
logger
Package logger provides a log interface
|
Package logger provides a log interface |
logger/log
Package log provides debug logging
|
Package log provides debug logging |
logger/log/memory
Package memory provides an in memory log buffer
|
Package memory provides an in memory log buffer |
sync
Package sync is an interface for distributed synchronization
|
Package sync is an interface for distributed synchronization |
sync/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 |
trace
Package trace provides an interface for distributed tracing
|
Package trace provides an interface for distributed tracing |
web
Package web provides web based vine services
|
Package web provides web based vine services |
util
|
|
context/metadata
Package metadata is a way of defining message headers
|
Package metadata is a way of defining message headers |
jsonpb
Package jsonpb provides marshaling and unmarshaling between protocol buffers and JSON.
|
Package jsonpb provides marshaling and unmarshaling between protocol buffers and JSON. |
qson
Package qson implmenets decoding of URL query params into JSON and Go values (using JSON struct tags).
|
Package qson implmenets decoding of URL query params into JSON and Go values (using JSON struct tags). |
ring
Package ring provides a simple ring buffer for storing local data
|
Package ring provides a simple ring buffer for storing local data |
version
Package version
|
Package version |
yamlpb
Package yamlpb provides marshaling and unmarshaling between protocol buffers and YAML.
|
Package yamlpb provides marshaling and unmarshaling between protocol buffers and YAML. |