oor

Documentation

Overview

Package oor implements an opinionated standalone listener which can be used by load balancer to take the server instance out of rotation or bring it back in rotation. The instance will go out of rotation on receiving SIGUSR1 and can be brought back in rotation by sending SIGUSR2.

Index

• type Handler
  • func NewHandler(inRotation bool) *Handler
  • func (h *Handler) InRotation() bool

Types

type Handler

type Handler struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Handler represents OOR handler.

func NewHandler

func NewHandler(inRotation bool) *Handler

NewHandler returns an OOR Handler. Initial state is defined by caller, and subsequent states are handled via SIGUSR1 and SIGUSR2

func (*Handler) InRotation

func (h *Handler) InRotation() bool

InRotation returns true if the server instance is ready to serve traffic.