slbKit

Documentation

Index

• Constants
• Variables
• type Backend
  • func NewBackend(urlStr string) (*Backend, error)
  • func (be *Backend) Disable(reason string, a ...any)
  • func (be *Backend) Enable(reason string, a ...any)
  • func (be *Backend) HandleRequest(w http.ResponseWriter, r *http.Request) error
  • func (be *Backend) HealthCheck()
  • func (be *Backend) IsAlive() (alive bool)
  • func (be *Backend) String() string
• type LoadBalancer
  • func NewLoadBalancer(logger *zap.Logger) (lb *LoadBalancer)
  • func (lb *LoadBalancer) AddBackend(be *Backend) (err error)
  • func (lb *LoadBalancer) Dispose()
  • func (lb *LoadBalancer) HandleRequest(w http.ResponseWriter, r *http.Request) (err error)
  • func (lb *LoadBalancer) Start() error
• type Status

Constants

const (
	// HealthCheckInterval 健康检查的周期
	HealthCheckInterval = time.Second * 10

	// HealthCheckTimeout 健康检查的超时时间
	HealthCheckTimeout = time.Second * 3
)

Variables

var (
	HaveNotBeenStartedError = errorKit.Newf("have not been started")

	AlreadyStartedError = errorKit.Newf("already started")

	AlreadyDisposedError = errorKit.Newf("already disposed")

	NoAccessBackendError = errorKit.Newf("no access backend")

	NoBackendAddedError = errorKit.Newf("no backend added")
)

Types

type Backend

type Backend struct {
	gmutex.Mutex
	// contains filtered or unexported fields
}

Backend 后端节点.

func NewBackend

func NewBackend(urlStr string) (*Backend, error)

func (*Backend) Disable

func (be *Backend) Disable(reason string, a ...any)

func (*Backend) Enable

func (be *Backend) Enable(reason string, a ...any)

func (*Backend) HandleRequest

func (be *Backend) HandleRequest(w http.ResponseWriter, r *http.Request) error

func (*Backend) HealthCheck

func (be *Backend) HealthCheck()

HealthCheck 健康检查（此方法会修改 alive 字段）.

@return 后端服务是否可用？

func (*Backend) IsAlive

func (be *Backend) IsAlive() (alive bool)

func (*Backend) String

func (be *Backend) String() string

type LoadBalancer

type LoadBalancer struct {
	gmutex.RWMutex
	// contains filtered or unexported fields
}

LoadBalancer 负载均衡器.

!!!: 创建实例后，需要先调用 Start.

func NewLoadBalancer

func NewLoadBalancer(logger *zap.Logger) (lb *LoadBalancer)

NewLoadBalancer

PS: 返回的*LoadBalancer实例，需要手动调用 Start 以启动.

@param logger 可以为nil，默认输出到控制台

func (*LoadBalancer) AddBackend

func (lb *LoadBalancer) AddBackend(be *Backend) (err error)

func (*LoadBalancer) Dispose

func (lb *LoadBalancer) Dispose()

Dispose 手动中止.

func (*LoadBalancer) HandleRequest

func (lb *LoadBalancer) HandleRequest(w http.ResponseWriter, r *http.Request) (err error)

func (*LoadBalancer) Start

func (lb *LoadBalancer) Start() error

Start 手动启动.

type Status

type Status string

const (
	StatusInitialized Status = "initialized"

	StatusStarted Status = "started"

	StatusDisposed Status = "disposed"
)