smf4go

README

smf4go

(smf4go) The Service Mesh Facade for Golang

Documentation

Index

• Variables
• type Extension
• type MeshBuilder
  • func Builder() MeshBuilder
  • func NewMeshBuilder() MeshBuilder
• type Runnable
• type Service
• type ServiceRegisterEntry

Variables

var (
	ErrInternal = errors.New("the internal error", errors.WithVendor(errVendor))
	ErrAgent    = errors.New("agent implement not found", errors.WithVendor(errVendor))
	ErrExists   = errors.New("target resource exists", errors.WithVendor(errVendor))
	ErrNotFound = errors.New("target resource not found", errors.WithVendor(errVendor))
)

errors

Types

type Extension

type Extension interface {
	Name() string // extension name
	Begin(config scf4go.Config, builder MeshBuilder) error
	CreateSerivce(serviceName string, config scf4go.Config) (Service, error)
	End() error
}

Extension smf4go service handle extension

type MeshBuilder

type MeshBuilder interface {
	RegisterService(extensionName string, serviceName string) error
	RegisterExtension(extension Extension) error
	Start(config scf4go.Config) error
	FindService(name string, service interface{})
}

MeshBuilder .

func Builder

func Builder() MeshBuilder

Builder get mesh builder instance

func NewMeshBuilder

func NewMeshBuilder() MeshBuilder

NewMeshBuilder create new mesh builder

type Runnable

type Runnable interface {
	Service
	Start() error
}

Runnable smf4go service base interface has nothing

type Service

type Service interface{}

Service smf4go service base interface has nothing

type ServiceRegisterEntry

type ServiceRegisterEntry struct {
	Name    string  // service name
	Service Service // service impl
}

ServiceRegisterEntry .