service

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 24, 2020 License: Apache-2.0 Imports: 42 Imported by: 0

Documentation

Overview

Package vine is a pluggable framework for vine services

Index

Constants

This section is empty.

Variables

View Source 
var (
	HeaderPrefix = "Vine-"
)

Functions

func NewContext 

func NewContext(ctx context.Context, s Service) context.Context

NewContext returns a new Context with the Service embedded within it.

func Plugins 

func Plugins() []plugin.Plugin

Plugins lists the service plugins

func Register 

func Register(pl plugin.Plugin) error

Register registers an service plugin

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

func NewEvent 

func NewEvent(topic string, c client.Client) Event

NewEvent creates a new event pulisher

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 

func NewFunction(opts ...Option) Function

NewFunction returns a new Function for a one time executing Service

type Option 

type Option func(*Options)

func Action 

func Action(a func(*cli.Context) error) Option

Action can be used to parse user provided cli options

func Address 

func Address(addr string) Option

Address sets the address of the server

func AfterStart 

func AfterStart(fn func() error) Option

AfterStart run funcs after service starts

func AfterStop 

func AfterStop(fn func() error) Option

AfterStop run funcs after service stops

func Auth 

func Auth(a auth.Auth) Option

Auth sets the auth for the service

func BeforeStart 

func BeforeStart(fn func() error) Option

BeforeStart run functions before service starts

func BeforeStop 

func BeforeStop(fn func() error) Option

BeforeStop run funcs before service stops

func Broker 

func Broker(b broker.Broker) Option

Broker to be used for service

func Client 

func Client(c client.Client) Option

Client to be used for service

func Cmd 

func Cmd(c cmd.Cmd) Option

func Config 

func Config(c config.Config) Option

Config sets the config for the service

func Context 

func Context(ctx context.Context) Option

Context specifies a context for the service. Can be used to signal shutdown of the service and for extra option values.

func Flags 

func Flags(flags ...cli.Flag) Option

Flags that can be passed to service

func HandleSignal 

func HandleSignal(b bool) Option

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 Metadata 

func Metadata(md map[string]string) Option

Metadata associated with the service

func Name 

func Name(n string) Option

Name of the service

func Profile 

func Profile(p profile.Profile) Option

Profile to be used for debug profile

func RegisterInterval 

func RegisterInterval(t time.Duration) Option

RegisterInterval specifies the interval on which to re-register

func RegisterTTL 

func RegisterTTL(t time.Duration) Option

RegisterTTL specifies the TTL to use when registering the service

func Registry 

func Registry(r registry.Registry) Option

Registry sets the registry for the service and the underlying components

func Runtime 

func Runtime(r runtime.Runtime) Option

Runtime sets the runtime

func Selector 

func Selector(s selector.Selector) Option

Selector sets the selector for the service client

func Server 

func Server(s server.Server) Option

Server to be used for service

func Store 

func Store(s store.Store) Option

Store sets the store to use

func Tracer 

func Tracer(t trace.Tracer) Option

Tracer sets the tracer for the service

func Transport 

func Transport(t transport.Transport) Option

Transport sets the transport for the service and the underlying components

func Version 

func Version(v string) Option

Version of the service

func WrapCall 

func WrapCall(w ...client.CallWrapper) Option

WrapCall is a convenience method for wrapping a Client CallFunc

func WrapClient 

func WrapClient(w ...client.Wrapper) Option

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 

func FromContext(ctx context.Context) (Service, bool)

FromContext retrieves a Service from the Context.

func NewService 

func NewService(opts ...Option) Service

NewService creates and returns a new Service based on the packages within.

Source Files

View all 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
input/discord
input/slack
input/telegram
Package auth provides authentication and authorization capability
 Package auth provides authentication and authorization capability
grpc
noop
Package broker is an interface used for asynchronous messaging
 Package broker is an interface used for asynchronous messaging
grpc
http
memory
grpc
mucp
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/registry
Package registry uses the vine registry for selection
 Package registry uses the vine registry for selection
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
cmd
encoder
encoder/hcl
encoder/json
encoder/toml
encoder/xml
encoder/yaml
loader
Package loader manages loading from multiple sources
 Package loader manages loading from multiple sources
loader/memory
reader
reader/json
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
source/cli
source/env
source/file
Package file is a file source.
 Package file is a file source.
source/flag
source/memory
Package memory is a memory source
 Package memory is a memory source
source/service
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 health is a healthchecking sidecar
 Package health is a healthchecking sidecar
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.
cache
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
grpc
handler
registry
Package runtime is a service runtime manager
 Package runtime is a service runtime manager
grpc
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/git
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
grpc
grpc/proto
mock
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
cli/snapshot
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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.