Documentation
¶
Overview ¶
Package vine is a pluggable framework for vine services
Index ¶
- Variables
- func NewContext(ctx context.Context, s Service) context.Context
- func Plugins() []plugin.Plugin
- func Register(pl plugin.Plugin) error
- 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 Event
- type Function
- 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 Auth(a auth.Auth) 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 Config(c config.Config) Option
- func Context(ctx context.Context) Option
- func Flags(flags ...cli.Flag) Option
- func HandleSignal(b bool) Option
- func Metadata(md map[string]string) Option
- func Name(n string) Option
- func Profile(p profile.Profile) Option
- func RegisterInterval(t time.Duration) Option
- func RegisterTTL(t time.Duration) Option
- func Registry(r registry.Registry) Option
- func Runtime(r runtime.Runtime) Option
- func Selector(s selector.Selector) Option
- func Server(s server.Server) Option
- func Store(s store.Store) Option
- func Tracer(t trace.Tracer) 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 Service
Constants ¶
This section is empty.
Variables ¶
var (
HeaderPrefix = "Vine-"
)
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 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 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 BeforeStart ¶
BeforeStart run functions before service starts
func Context ¶
Context specifies a context for the service. Can be used to signal shutdown of the service and for extra option values.
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 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 { Auth auth.Auth Broker broker.Broker Cmd cmd.Cmd Client client.Client Config config.Config Server server.Server Store store.Store Registry registry.Registry Runtime runtime.Runtime Transport transport.Transport Profile profile.Profile // 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 Signal bool }
Options for vine service
type Service ¶
type Service interface { // The service name Name() string // Init initialises options Init(...Option) // Options returns the current options Options() Options // Client is used to call services Client() client.Client // Server is for handling requests and events Server() server.Server // Run the service Run() error // The service implementation String() string }
Service is an interface that wraps the lower level libraries within vine. 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 |
---|---|
command
Package command is an interface for defining bot commands
|
Package command is an interface for defining bot commands |
input
Package input is an interface for bot inputs
|
Package input is an interface for bot inputs |
Package auth provides authentication and authorization capability
|
Package auth provides authentication and authorization capability |
Package broker is an interface used for asynchronous messaging Package http provides a http based message broker
|
Package broker is an interface used for asynchronous messaging Package http provides a http based message broker |
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/router
Package router is a network/router selector
|
Package router is a network/router 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 |
loader
Package loader manages loading from multiple sources
|
Package loader manages loading from multiple sources |
secrets
Package secrets is an interface for encrypting and decrypting secrets
|
Package secrets is an interface for encrypting and decrypting secrets |
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 |
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 |
source/file
Package file is a file source.
|
Package file is a file source. |
source/memory
Package memory is a memory source
|
Package memory is a memory source |
Package service provides the service log
|
Package service provides the service log |
handler
Package handler implements service debug handler embedded in vine services
|
Package handler implements service debug handler embedded in vine services |
Package log provides a log interface
|
Package log provides a log interface |
Package network is for creating internetworks
|
Package network is for creating internetworks |
Package plugin provides the ability to load plugins Package plugin provides the ability to load plugins
|
Package plugin provides the ability to load plugins Package plugin provides the ability to load plugins |
Package proxy is a transport proxy built on the vine/server Package proxy is a transport proxy built on the vine/server
|
Package proxy is a transport proxy built on the vine/server Package proxy is a transport proxy built on the vine/server |
grpc
Package grpc transparently forwards the grpc protocol using a vine client.
|
Package grpc transparently forwards the grpc protocol using a vine client. |
http
Package http provides a vine rpc to http proxy Package http provides a vine rpc to http proxy
|
Package http provides a vine rpc to http proxy Package http provides a vine rpc to http proxy |
mucp
Package mucp transparently forwards the incoming request using a vine client.
|
Package mucp transparently forwards the incoming request using a vine client. |
grpc
Package service uses the registry service
|
Package service uses the registry service |
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 |
Package runtime is a service runtime manager
|
Package runtime is a service runtime manager |
local
Package local provides a local runtime
|
Package local provides a local runtime |
local/build
Package build builds a vine runtime package
|
Package build builds a vine runtime package |
local/build/docker
Package docker builds docker images
|
Package docker builds docker images |
local/build/go
Package golang is a go package manager
|
Package golang is a go package manager |
local/process
Package process executes a binary
|
Package process executes a binary |
local/process/os
Package os runs processes locally Package os runs processes locally
|
Package os runs processes locally Package os runs processes locally |
local/source
Package source retrieves source code
|
Package source retrieves source code |
local/source/git
Package git provides a git source
|
Package git provides a git source |
local/source/go
Package golang is a source for Go
|
Package golang is a source for Go |
mucp
Package mucp provides an mucp server
|
Package mucp provides an mucp server |
Package store is an interface for distributed data storage.
|
Package store is an interface for distributed data storage. |
bolt
Package local is a bolt system backed store
|
Package local is a bolt system backed store |
cache
Package cache implements a faulting style read cache on top of multiple vine stores
|
Package cache implements a faulting style read cache on top of multiple vine stores |
cli
Package cli implements the `vine store` subcommands for example: vine store snapshot vine store restore vine store sync
|
Package cli implements the `vine store` subcommands for example: vine store snapshot vine store restore vine store sync |
grpc
Package service implements the store service interface
|
Package service implements the store service interface |
memory
Package memory is a in-memory store store
|
Package memory is a in-memory store store |
postgres
Package postgres implements the postgres store
|
Package postgres implements the postgres store |
Package web provides web based micro services
|
Package web provides web based micro services |