Documentation ¶
Index ¶
- Variables
- func NewDecayer(cfg *DecayerCfg, mgr *BasicConnMgr) (*decayer, error)
- type BasicConnMgr
- func (cm *BasicConnMgr) CheckLimit(systemLimit connmgr.GetConnLimiter) error
- func (cm *BasicConnMgr) Close() error
- func (cm *BasicConnMgr) GetInfo() CMInfo
- func (cm *BasicConnMgr) GetTagInfo(p peer.ID) *connmgr.TagInfo
- func (cm *BasicConnMgr) IsProtected(id peer.ID, tag string) (protected bool)
- func (cm *BasicConnMgr) Notifee() network.Notifiee
- func (cm *BasicConnMgr) Protect(id peer.ID, tag string)
- func (d BasicConnMgr) RegisterDecayingTag(name string, interval time.Duration, decayFn connmgr.DecayFn, ...) (connmgr.DecayingTag, error)
- func (cm *BasicConnMgr) TagPeer(p peer.ID, tag string, val int)
- func (cm *BasicConnMgr) TrimOpenConns(_ context.Context)
- func (cm *BasicConnMgr) Unprotect(id peer.ID, tag string) (protected bool)
- func (cm *BasicConnMgr) UntagPeer(p peer.ID, tag string)
- func (cm *BasicConnMgr) UpsertTag(p peer.ID, tag string, upsert func(int) int)
- type CMInfo
- type DecayerCfg
- type Option
Constants ¶
This section is empty.
Variables ¶
var DefaultResolution = 1 * time.Minute
DefaultResolution is the default resolution of the decay tracker.
Functions ¶
func NewDecayer ¶
func NewDecayer(cfg *DecayerCfg, mgr *BasicConnMgr) (*decayer, error)
NewDecayer creates a new decaying tag registry.
Types ¶
type BasicConnMgr ¶
type BasicConnMgr struct {
// contains filtered or unexported fields
}
BasicConnMgr is a ConnManager that trims connections whenever the count exceeds the high watermark. New connections are given a grace period before they're subject to trimming. Trims are automatically run on demand, only if the time from the previous trim is higher than 10 seconds. Furthermore, trims can be explicitly requested through the public interface of this struct (see TrimOpenConns).
See configuration parameters in NewConnManager.
func NewConnManager ¶
func NewConnManager(low, hi int, opts ...Option) (*BasicConnMgr, error)
NewConnManager creates a new BasicConnMgr with the provided params: lo and hi are watermarks governing the number of connections that'll be maintained. When the peer count exceeds the 'high watermark', as many peers will be pruned (and their connections terminated) until 'low watermark' peers remain.
func (*BasicConnMgr) CheckLimit ¶
func (cm *BasicConnMgr) CheckLimit(systemLimit connmgr.GetConnLimiter) error
func (*BasicConnMgr) Close ¶
func (cm *BasicConnMgr) Close() error
func (*BasicConnMgr) GetInfo ¶
func (cm *BasicConnMgr) GetInfo() CMInfo
GetInfo returns the configuration and status data for this connection manager.
func (*BasicConnMgr) GetTagInfo ¶
func (cm *BasicConnMgr) GetTagInfo(p peer.ID) *connmgr.TagInfo
GetTagInfo is called to fetch the tag information associated with a given peer, nil is returned if p refers to an unknown peer.
func (*BasicConnMgr) IsProtected ¶
func (cm *BasicConnMgr) IsProtected(id peer.ID, tag string) (protected bool)
func (*BasicConnMgr) Notifee ¶
func (cm *BasicConnMgr) Notifee() network.Notifiee
Notifee returns a sink through which Notifiers can inform the BasicConnMgr when events occur. Currently, the notifee only reacts upon connection events {Connected, Disconnected}.
func (BasicConnMgr) RegisterDecayingTag ¶
func (*BasicConnMgr) TagPeer ¶
func (cm *BasicConnMgr) TagPeer(p peer.ID, tag string, val int)
TagPeer is called to associate a string and integer with a given peer.
func (*BasicConnMgr) TrimOpenConns ¶
func (cm *BasicConnMgr) TrimOpenConns(_ context.Context)
TrimOpenConns closes the connections of as many peers as needed to make the peer count equal the low watermark. Peers are sorted in ascending order based on their total value, pruning those peers with the lowest scores first, as long as they are not within their grace period.
This function blocks until a trim is completed. If a trim is underway, a new one won't be started, and instead it'll wait until that one is completed before returning.
func (*BasicConnMgr) Unprotect ¶
func (cm *BasicConnMgr) Unprotect(id peer.ID, tag string) (protected bool)
type CMInfo ¶
type CMInfo struct { // The low watermark, as described in NewConnManager. LowWater int // The high watermark, as described in NewConnManager. HighWater int // The timestamp when the last trim was triggered. LastTrim time.Time // The configured grace period, as described in NewConnManager. GracePeriod time.Duration // The current connection count. ConnCount int }
CMInfo holds the configuration for BasicConnMgr, as well as status data.
type DecayerCfg ¶
DecayerCfg is the configuration object for the Decayer.
func (*DecayerCfg) WithDefaults ¶
func (cfg *DecayerCfg) WithDefaults() *DecayerCfg
WithDefaults writes the default values on this DecayerConfig instance, and returns itself for chainability.
cfg := (&DecayerCfg{}).WithDefaults() cfg.Resolution = 30 * time.Second t := NewDecayer(cfg, cm)
type Option ¶
type Option func(*config) error
Option represents an option for the basic connection manager.
func DecayerConfig ¶
func DecayerConfig(opts *DecayerCfg) Option
DecayerConfig applies a configuration for the decayer.
func WithGracePeriod ¶
WithGracePeriod sets the grace period. The grace period is the time a newly opened connection is given before it becomes subject to pruning.
func WithSilencePeriod ¶
WithSilencePeriod sets the silence period. The connection manager will perform a cleanup once per silence period if the number of connections surpasses the high watermark.