cluster

Documentation

Index

• Constants
• func DaemonAt(idx int) *gubernator.Daemon
• func FindOwningDaemon(name, key string) (*gubernator.Daemon, error)
• func FindOwningPeer(name, key string) (gubernator.PeerInfo, error)
• func GetDaemons() []*gubernator.Daemon
• func GetPeers() []gubernator.PeerInfo
• func GetRandomPeer(dc string) gubernator.PeerInfo
• func ListNonOwningDaemons(name, key string) ([]*gubernator.Daemon, error)
• func NumOfDaemons() int
• func PeerAt(idx int) gubernator.PeerInfo
• func Restart(ctx context.Context) error
• func Start(numInstances int) error
• func StartWith(localPeers []gubernator.PeerInfo, opts ...option) error
• func Stop()
• func WithEventChannel(eventChannel chan<- gubernator.HitEvent) option

Constants

const (
	DataCenterNone = ""
	DataCenterOne  = "datacenter-1"
	DataCenterTwo  = "datacenter-2"
)

Functions

func DaemonAt

func DaemonAt(idx int) *gubernator.Daemon

DaemonAt returns a specific daemon

func FindOwningDaemon

func FindOwningDaemon(name, key string) (*gubernator.Daemon, error)

FindOwningDaemon finds the daemon which owns the rate limit with the provided name and unique key

func FindOwningPeer

func FindOwningPeer(name, key string) (gubernator.PeerInfo, error)

FindOwningPeer finds the peer which owns the rate limit with the provided name and unique key

func GetDaemons

func GetDaemons() []*gubernator.Daemon

GetDaemons returns a list of all daemons in the cluster

func GetPeers

func GetPeers() []gubernator.PeerInfo

GetPeers returns a list of all peers in the cluster

func GetRandomPeer

func GetRandomPeer(dc string) gubernator.PeerInfo

GetRandomPeer returns a random peer from the cluster

func ListNonOwningDaemons

func ListNonOwningDaemons(name, key string) ([]*gubernator.Daemon, error)

ListNonOwningDaemons returns a list of daemons in the cluster that do not own the rate limit for the name and key provided.

func NumOfDaemons

func NumOfDaemons() int

NumOfDaemons returns the number of instances

func PeerAt

func PeerAt(idx int) gubernator.PeerInfo

PeerAt returns a specific peer

func Restart

func Restart(ctx context.Context) error

Restart the cluster

func Start

func Start(numInstances int) error

Start a local cluster of gubernator servers

func StartWith

func StartWith(localPeers []gubernator.PeerInfo, opts ...option) error

StartWith a local cluster with specific addresses

func Stop

func Stop()

Stop all daemons in the cluster

func WithEventChannel

func WithEventChannel(eventChannel chan<- gubernator.HitEvent) option

WithEventChannel sets EventChannel to Gubernator config.