Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

router

package

Go to main page

Versions in this module

v1

v1.0.0

Mar 20, 2024

Changes in this version

+ var ErrNoBackend = errors.New("no available backend")

+ type StaticBackend struct

+ func NewStaticBackend(addr string) *StaticBackend

+ func (b *StaticBackend) Addr() string

+ func (b *StaticBackend) Healthy() bool

+ func (b *StaticBackend) SetHealthy(healthy bool)

v0

v0.2.0

Jan 16, 2024

Changes in this version

+ type BackendHealth struct

+ PingErr error

+ ServerVersion string

+ Status BackendStatus

+ func (bh *BackendHealth) String() string

+ type BackendInst interface

+ Addr func() string

+ Healthy func() bool

+ type DefaultHealthCheck struct

+ func NewDefaultHealthCheck(httpCli *http.Client, cfg *config.HealthCheck, logger *zap.Logger) *DefaultHealthCheck

+ func (dhc *DefaultHealthCheck) Check(ctx context.Context, addr string, info *BackendInfo) *BackendHealth

+ type HealthCheck interface

+ Check func(ctx context.Context, addr string, info *BackendInfo) *BackendHealth

v0.1.2

Nov 8, 2023

Changes in this version

+ var ErrNoInstanceToSelect = errors.New("no instances to route")

+ type BackendEventReceiver interface

+ OnBackendChanged func(backends map[string]*backendHealth, err error)

+ type BackendFetcher interface

+ GetBackendList func(context.Context) (map[string]*BackendInfo, error)

+ type BackendInfo struct

+ IP string

+ StatusPort uint

+ type BackendObserver struct

+ func NewBackendObserver(logger *zap.Logger, eventReceiver BackendEventReceiver, httpCli *http.Client, ...) (*BackendObserver, error)

+ func StartBackendObserver(logger *zap.Logger, eventReceiver BackendEventReceiver, httpCli *http.Client, ...) (*BackendObserver, error)

+ func (bo *BackendObserver) Close()

+ func (bo *BackendObserver) Refresh()

+ func (bo *BackendObserver) Start()

+ type BackendSelector struct

+ func (bs *BackendSelector) Finish(conn RedirectableConn, succeed bool)

+ func (bs *BackendSelector) Next() (string, error)

+ func (bs *BackendSelector) Reset()

+ type BackendStatus int

+ const StatusCannotConnect

+ const StatusHealthy

+ const StatusMemoryHigh

+ const StatusRunSlow

+ const StatusSchemaOutdated

+ func (bs *BackendStatus) String() string

+ func (bs *BackendStatus) ToScore() int

+ type ConnEventReceiver interface

+ OnConnClosed func(addr string, conn RedirectableConn) error

+ OnRedirectFail func(from, to string, conn RedirectableConn) error

+ OnRedirectSucceed func(from, to string, conn RedirectableConn) error

+ type PDFetcher struct

+ func NewPDFetcher(tpFetcher TopologyFetcher, logger *zap.Logger, config *config.HealthCheck) *PDFetcher

+ func (pf *PDFetcher) GetBackendList(ctx context.Context) (map[string]*BackendInfo, error)

+ type RedirectableConn interface

+ ConnectionID func() uint64

+ NotifyBackendStatus func(status BackendStatus)

+ Redirect func(addr string) bool

+ SetEventReceiver func(receiver ConnEventReceiver)

+ SetValue func(key, val any)

+ Value func(key any) any

+ type Router interface

+ Close func()

+ ConnCount func() int

+ GetBackendSelector func() BackendSelector

+ RedirectConnections func() error

+ RefreshBackend func()

+ ServerVersion func() string

+ type ScoreBasedRouter struct

+ func NewScoreBasedRouter(logger *zap.Logger) *ScoreBasedRouter

+ func (r *ScoreBasedRouter) Init(httpCli *http.Client, fetcher BackendFetcher, cfg *config.HealthCheck) error

+ func (router *ScoreBasedRouter) Close()

+ func (router *ScoreBasedRouter) ConnCount() int

+ func (router *ScoreBasedRouter) GetBackendSelector() BackendSelector

+ func (router *ScoreBasedRouter) OnBackendChanged(backends map[string]*backendHealth, err error)

+ func (router *ScoreBasedRouter) OnConnClosed(addr string, conn RedirectableConn) error

+ func (router *ScoreBasedRouter) OnRedirectFail(from, to string, conn RedirectableConn) error

+ func (router *ScoreBasedRouter) OnRedirectSucceed(from, to string, conn RedirectableConn) error

+ func (router *ScoreBasedRouter) RedirectConnections() error

+ func (router *ScoreBasedRouter) RefreshBackend()

+ func (router *ScoreBasedRouter) ServerVersion() string

+ type StaticFetcher struct

+ func NewStaticFetcher(staticAddrs []string) *StaticFetcher

+ func (sf *StaticFetcher) GetBackendList(context.Context) (map[string]*BackendInfo, error)

+ type StaticRouter struct

+ func NewStaticRouter(addr []string) *StaticRouter

+ func (r *StaticRouter) Close()

+ func (r *StaticRouter) ConnCount() int

+ func (r *StaticRouter) GetBackendSelector() BackendSelector

+ func (r *StaticRouter) OnConnClosed(addr string, conn RedirectableConn) error

+ func (r *StaticRouter) OnRedirectFail(from, to string, conn RedirectableConn) error

+ func (r *StaticRouter) OnRedirectSucceed(from, to string, conn RedirectableConn) error

+ func (r *StaticRouter) RedirectConnections() error

+ func (r *StaticRouter) RefreshBackend()

+ func (r *StaticRouter) ServerVersion() string

+ type TopologyFetcher interface

+ GetTiDBTopology func(ctx context.Context) (map[string]*infosync.TiDBInfo, error)

v0.1.2-alpha.2

Nov 6, 2023

v0.1.2-alpha.1

Oct 20, 2023