Documentation
¶
Overview ¶
Package vine is a pluggable framework for vine services
Index ¶
- func AddJob(job *gscheduler.Job) error
- func GetJob(id string) (*gscheduler.Job, error)
- func GetJobs() ([]*gscheduler.Job, error)
- 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
- func RemoveJob(job *gscheduler.Job) error
- func UpdateJob(job *gscheduler.Job) error
- 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 Client(c client.Client) Option
- func Cmd(c cmd.Cmd) Option
- func Config(c config.Config) Option
- func Context(ctx context.Context) 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 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 ¶
This section is empty.
Functions ¶
func AddJob ¶ added in v0.12.0
func AddJob(job *gscheduler.Job) error
func GetJobs ¶ added in v0.12.0
func GetJobs() ([]*gscheduler.Job, error)
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
func RemoveJob ¶ added in v0.12.0
func RemoveJob(job *gscheduler.Job) error
func UpdateJob ¶ added in v0.12.0
func UpdateJob(job *gscheduler.Job) error
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 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 { Broker broker.Broker Cmd cmd.Cmd Client client.Client Config config.Config Server server.Server Trace trace.Tracer Dialect dao.Dialect Store store.Store Registry registry.Registry Runtime runtime.Runtime Transport transport.Transport Profile profile.Profile Scheduler gscheduler.Scheduler // 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 { // Name 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 // String 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.
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
Package cli is a command line interface
|
Package cli is a command line interface |
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/bot
Package bot is a Hubot style bot that sits a vineservice environment
|
Package bot is a Hubot style bot that sits a vineservice environment |
vine/client/proxy
Package proxy is a cli proxy
|
Package proxy is a cli proxy |
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 |
vine/service
Package service provides a vine service
|
Package service provides a vine service |
vine/service/broker
Package broker is the vine broker
|
Package broker is the vine broker |
vine/service/debug
Package debug implements metrics/logging/introspection/...
|
Package debug implements metrics/logging/introspection/... |
vine/service/debug/stats
Package stats is the handler for the `vine debug stats` service
|
Package stats is the handler for the `vine debug stats` service |
vine/service/debug/trace
Package trace the handler for the `vine debug trace` service
|
Package trace the handler for the `vine debug trace` service |
vine/service/health
Package health is a healthchecking sidecar
|
Package health is a healthchecking sidecar |
vine/service/network
package network implements vine network node
|
package network implements vine network node |
vine/service/network/api
Package api is the network api
|
Package api is the network api |
vine/service/network/dns
Package dns provides a DNS registration service for autodiscovery of core network nodes.
|
Package dns provides a DNS registration service for autodiscovery of core network nodes. |
vine/service/network/dns/handler
Package handler is the handler for the `vine network dns` command
|
Package handler is the handler for the `vine network dns` command |
vine/service/network/dns/provider
Package provider lets you abstract away any number of DNS providers
|
Package provider lets you abstract away any number of DNS providers |
vine/service/network/dns/provider/cloudflare
Package cloudflare is a dns Provider for cloudflare
|
Package cloudflare is a dns Provider for cloudflare |
vine/service/network/handler
Package handler implements network RPC handler
|
Package handler implements network RPC handler |
vine/service/registry
Package registry is the vine registry
|
Package registry is the vine registry |
vine/service/runtime
Package runtime is the vine runtime Package runtime is the vine runtime
|
Package runtime is the vine runtime Package runtime is the vine runtime |
vine/service/runtime/profile
Package profile is for specific profiles @todo this package is the definition of cruft and should be rewritten in a more elegant way
|
Package profile is for specific profiles @todo this package is the definition of cruft and should be rewritten in a more elegant way |
vine/service/runtime/scheduler
Package scheduler is a file server notifer
|
Package scheduler is a file server notifer |
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/router
Package router is a network/router selector
|
Package router is a network/router 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/grpc
Package grpc service uses the registry service
|
Package grpc service uses the registry service |
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 |
server/mucp
Package mucp provides an mucp server
|
Package mucp provides an mucp server |
transport
Package transport is an interface for synchronous connection based communication
|
Package transport is an interface for synchronous connection based communication |
transport/grpc
Package grpc provides a grpc transport
|
Package grpc provides a grpc transport |
transport/memory
Package memory is an in-memory transport
|
Package memory is an in-memory transport |
transport/quic
Package quic provides a QUIC based transport
|
Package quic provides a QUIC based transport |
lib
|
|
agent/command
Package command is an interface for defining bot commands
|
Package command is an interface for defining bot commands |
agent/input
Package input is an interface for bot inputs
|
Package input is an interface for bot inputs |
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 |
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 |
debug
Package service provides the service log
|
Package service provides the service log |
debug/handler
Package handler implements service debug handler embedded in vine services
|
Package handler implements service debug handler embedded in vine services |
debug/log
Package log provides debug logging
|
Package log provides debug logging |
debug/log/memory
Package memory provides an in memory log buffer
|
Package memory provides an in memory log buffer |
debug/profile
Package profile is for profilers
|
Package profile is for profilers |
debug/profile/http
Package http enables the http profiler
|
Package http enables the http profiler |
debug/profile/pprof
Package pprof provides a pprof profiler
|
Package pprof provides a pprof profiler |
debug/stats
Package stats provides runtime stats
|
Package stats provides runtime stats |
debug/trace
Package trace provides an interface for distributed tracing
|
Package trace provides an interface for distributed tracing |
logger
Package log provides a log interface
|
Package log provides a log interface |
network
Package network is for creating internetworks
|
Package network is for creating internetworks |
network/resolver
Package resolver resolves network names to addresses
|
Package resolver resolves network names to addresses |
network/resolver/dns
Package dns resolves names to dns records
|
Package dns resolves names to dns records |
network/resolver/dnssrv
Package dns svc resolves names to dns svc records
|
Package dns svc resolves names to dns svc records |
network/resolver/http
Package http resolves names to network addresses using a http request
|
Package http resolves names to network addresses using a http request |
network/resolver/registry
Package registry resolves names using the vine registry
|
Package registry resolves names using the vine registry |
network/resolver/static
Package static is a static resolver
|
Package static is a static resolver |
network/tunnel
Package tunnel provides gre network tunnelling
|
Package tunnel provides gre network tunnelling |
network/tunnel/broker
Package broker is a tunnel broker
|
Package broker is a tunnel broker |
network/tunnel/transport
Package transport provides a tunnel transport
|
Package transport provides a tunnel transport |
proxy
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 |
proxy/grpc
Package grpc transparently forwards the grpc protocol using a vine client.
|
Package grpc transparently forwards the grpc protocol using a vine client. |
proxy/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 |
proxy/mucp
Package mucp transparently forwards the incoming request using a vine client.
|
Package mucp transparently forwards the incoming request using a vine client. |
runtime
Package runtime is a service runtime manager
|
Package runtime is a service runtime manager |
runtime/local
Package local provides a local runtime
|
Package local provides a local runtime |
runtime/local/build
Package build builds a vine runtime package
|
Package build builds a vine runtime package |
runtime/local/build/docker
Package docker builds docker images
|
Package docker builds docker images |
runtime/local/build/go
Package golang is a go package manager
|
Package golang is a go package manager |
runtime/local/process
Package process executes a binary
|
Package process executes a binary |
runtime/local/process/os
Package os runs processes locally Package os runs processes locally
|
Package os runs processes locally Package os runs processes locally |
runtime/local/source
Package source retrieves source code
|
Package source retrieves source code |
runtime/local/source/git
Package git provides a git source
|
Package git provides a git source |
runtime/local/source/go
Package golang is a source for Go
|
Package golang is a source for Go |
store
Package store is an interface for distributed data storage.
|
Package store is an interface for distributed data storage. |
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 |
store/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 |
store/grpc
Package grpc implements the store service interface
|
Package grpc implements the store service interface |
store/memory
Package memory is a in-memory store store
|
Package memory is a in-memory store store |
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 |
web
Package web provides web based vine services
|
Package web provides web based vine services |
proto
|
|
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. |
muxer
Package mux provides proxy muxing
|
Package mux provides proxy muxing |
proto
Package proto contains utility functions for working with protobufs
|
Package proto contains utility functions for working with protobufs |
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 |
socket
Package socket provides a pseudo socket
|
Package socket provides a pseudo socket |
usage
Package usage tracks vine usage
|
Package usage tracks vine usage |
version
Package version
|
Package version |