Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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
- API
  
  Reference documentation for the pkg.go.dev API
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

ringpop

package module

Go to main page

Versions in this module

v0

v0.1.2

Oct 29, 2026

v0.1.1

Oct 21, 2026

v0.1.0

Jul 24, 2026

Changes in this version

+ const StatPeriodDefault

+ const StatPeriodNever

+ var ErrChannelNotListening = errors.New("tchannel is not listening")

+ var ErrEphemeralAddress = errors.New("unable to resolve this node's address from channel that is not yet listening")

+ var ErrInvalidIdentity = errors.New("a hostport is not valid as an identity")

+ var ErrNotBootstrapped = errors.New("ringpop is not bootstrapped")

+ func DeserializeThrift(ctx context.Context, b []byte, s athrift.TStruct) error

+ func SerializeThrift(ctx context.Context, s athrift.TStruct) ([]byte, error)

+ type AddressResolver func() (string, error)

+ type Arg struct

+ type Interface interface

+ AddListener func(events.EventListener) bool

+ App func() string

+ Bootstrap func(opts *swim.BootstrapOptions) ([]string, error)

+ Checksum func() (uint32, error)

+ CountReachableMembers func(predicates ...swim.MemberPredicate) (int, error)

+ Destroy func()

+ Forward func(dest string, keys []string, request []byte, service, endpoint string, ...) ([]byte, error)

+ GetReachableMemberObjects func(predicates ...swim.MemberPredicate) ([]swim.Member, error)

+ GetReachableMembers func(predicates ...swim.MemberPredicate) ([]string, error)

+ HandleOrForward func(key string, request []byte, response *[]byte, service, endpoint string, ...) (bool, error)

+ Labels func() (*swim.NodeLabels, error)

+ Lookup func(key string) (string, error)

+ LookupN func(key string, n int) ([]string, error)

+ RegisterListener func(events.EventListener)

+ RegisterSelfEvictHook func(hooks swim.SelfEvictHook) error

+ RemoveListener func(events.EventListener) bool

+ SelfEvict func() error

+ Uptime func() (time.Duration, error)

+ WhoAmI func() (string, error)

+ type Option func(*Ringpop) error

+ func Address(address string) Option

+ func AddressResolverFunc(resolver AddressResolver) Option

+ func Channel(ch shared.TChannel) Option

+ func Clock(c clock.Clock) Option

+ func FaultyPeriod(period time.Duration) Option

+ func HashRingConfig(c *hashring.Configuration) Option

+ func Identity(identity string) Option

+ func LabelLimitCount(count int) Option

+ func LabelLimitKeySize(size int) Option

+ func LabelLimitValueSize(size int) Option

+ func LogLevels(levels map[string]logging.Level) Option

+ func Logger(l log.Logger) Option

+ func MembershipChecksumStatPeriod(period time.Duration) Option

+ func RequiresAppInPing(requiresAppInPing bool) Option

+ func RingChecksumStatPeriod(period time.Duration) Option

+ func SelfEvictPingRatio(ratio float64) Option

+ func Statter(s log.StatsReporter) Option

+ func SuspectPeriod(period time.Duration) Option

+ func TombstonePeriod(period time.Duration) Option

+ type Ringpop struct

+ func New(app string, opts ...Option) (*Ringpop, error)

+ func (rp *Ringpop) App() string

+ func (rp *Ringpop) Bootstrap(bootstrapOpts *swim.BootstrapOptions) ([]string, error)

+ func (rp *Ringpop) Checksum() (uint32, error)

+ func (rp *Ringpop) CountReachableMembers(predicates ...swim.MemberPredicate) (int, error)

+ func (rp *Ringpop) Destroy()

+ func (rp *Ringpop) Forward(dest string, keys []string, request []byte, service, endpoint string, ...) ([]byte, error)

+ func (rp *Ringpop) GetReachableMemberObjects(predicates ...swim.MemberPredicate) ([]swim.Member, error)

+ func (rp *Ringpop) GetReachableMembers(predicates ...swim.MemberPredicate) ([]string, error)

+ func (rp *Ringpop) HandleEvent(event events.Event)

+ func (rp *Ringpop) HandleOrForward(key string, request []byte, response *[]byte, service, endpoint string, ...) (bool, error)

+ func (rp *Ringpop) Labels() (*swim.NodeLabels, error)

+ func (rp *Ringpop) Lookup(key string) (string, error)

+ func (rp *Ringpop) LookupN(key string, n int) ([]string, error)

+ func (rp *Ringpop) Ready() bool

+ func (rp *Ringpop) RegisterListener(l events.EventListener)

+ func (rp *Ringpop) RegisterSelfEvictHook(hooks swim.SelfEvictHook) error

+ func (rp *Ringpop) SelfEvict() error

+ func (rp *Ringpop) Uptime() (time.Duration, error)

+ func (rp *Ringpop) WhoAmI() (string, error)