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.3.0

Oct 25, 2024

Changes in this version

type Router

+ HealthyBackendCount func() int

type ScoreBasedRouter

+ func (router *ScoreBasedRouter) HealthyBackendCount() int

type StaticRouter

+ func (r *StaticRouter) HealthyBackendCount() int

v1.2.0

Aug 15, 2024

v1.1.0

Jun 25, 2024

Changes in this version

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

+ type BackendInst interface

+ Addr func() string

+ Healthy func() bool

+ Local func() bool

+ type BackendSelector struct

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

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

+ 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 RedirectableConn interface

+ ConnectionID func() uint64

+ Redirect func(backend BackendInst) 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(ctx context.Context, ob observer.BackendObserver, ...)

+ func (router *ScoreBasedRouter) Close()

+ func (router *ScoreBasedRouter) ConnCount() int

+ func (router *ScoreBasedRouter) GetBackendSelector() BackendSelector

+ 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 StaticBackend struct

+ func NewStaticBackend(addr string) *StaticBackend

+ func (b *StaticBackend) Addr() string

+ func (b *StaticBackend) Healthy() bool

+ func (b *StaticBackend) Local() bool

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

+ type StaticRouter struct

+ func NewStaticRouter(addrs []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