Documentation
¶
Index ¶
- Variables
- func NewResourceManager(limits Limiter, opts ...Option) (network.ResourceManager, error)
- type BaseLimit
- type BasicLimiter
- func NewDefaultDynamicLimiter(memFraction float64, minMemory, maxMemory int64) *BasicLimiter
- func NewDefaultFixedLimiter(memoryCap int64) *BasicLimiter
- func NewDefaultLimiter() *BasicLimiter
- func NewDefaultLimiterFromJSON(in io.Reader) (*BasicLimiter, error)
- func NewDefaultStaticLimiter(memFraction float64, minMemory, maxMemory int64) *BasicLimiter
- func NewDynamicLimiter(cfg DefaultLimitConfig) *BasicLimiter
- func NewLimiterFromJSON(in io.Reader, defaults DefaultLimitConfig) (*BasicLimiter, error)
- func NewStaticLimiter(cfg DefaultLimitConfig) *BasicLimiter
- func (l *BasicLimiter) GetConnLimits() Limit
- func (l *BasicLimiter) GetPeerLimits(p peer.ID) Limit
- func (l *BasicLimiter) GetProtocolLimits(proto protocol.ID) Limit
- func (l *BasicLimiter) GetProtocolPeerLimits(proto protocol.ID) Limit
- func (l *BasicLimiter) GetServiceLimits(svc string) Limit
- func (l *BasicLimiter) GetServicePeerLimits(svc string) Limit
- func (l *BasicLimiter) GetStreamLimits(p peer.ID) Limit
- func (l *BasicLimiter) GetSystemLimits() Limit
- func (l *BasicLimiter) GetTransientLimits() Limit
- type DefaultLimitConfig
- type DynamicLimit
- func (l *DynamicLimit) GetMemoryLimit() int64
- func (l *DynamicLimit) WithConnLimit(numConnsIn, numConnsOut, numConns int) Limit
- func (l *DynamicLimit) WithFDLimit(numFD int) Limit
- func (l *DynamicLimit) WithMemoryLimit(memFraction float64, minMemory, maxMemory int64) Limit
- func (l *DynamicLimit) WithStreamLimit(numStreamsIn, numStreamsOut, numStreams int) Limit
- type Limit
- type Limiter
- type MemoryLimit
- type Option
- type ResourceManagerStat
- type ResourceManagerState
- type ResourceScopeLimiter
- type StaticLimit
- func (l *StaticLimit) GetMemoryLimit() int64
- func (l *StaticLimit) WithConnLimit(numConnsIn, numConnsOut, numConns int) Limit
- func (l *StaticLimit) WithFDLimit(numFD int) Limit
- func (l *StaticLimit) WithMemoryLimit(memFraction float64, minMemory, maxMemory int64) Limit
- func (l *StaticLimit) WithStreamLimit(numStreamsIn, numStreamsOut, numStreams int) Limit
Constants ¶
This section is empty.
Variables ¶
var DefaultLimits = DefaultLimitConfig{ SystemBaseLimit: BaseLimit{ StreamsInbound: 4096, StreamsOutbound: 16384, Streams: 16384, ConnsInbound: 256, ConnsOutbound: 1024, Conns: 1024, FD: 512, }, SystemMemory: MemoryLimit{ MemoryFraction: 0.125, MinMemory: 128 << 20, MaxMemory: 1 << 30, }, TransientBaseLimit: BaseLimit{ StreamsInbound: 128, StreamsOutbound: 512, Streams: 512, ConnsInbound: 32, ConnsOutbound: 128, Conns: 128, FD: 128, }, TransientMemory: MemoryLimit{ MemoryFraction: 1, MinMemory: 64 << 20, MaxMemory: 64 << 20, }, ServiceBaseLimit: BaseLimit{ StreamsInbound: 2048, StreamsOutbound: 8192, Streams: 8192, }, ServiceMemory: MemoryLimit{ MemoryFraction: 0.125 / 4, MinMemory: 64 << 20, MaxMemory: 256 << 20, }, ServicePeerBaseLimit: BaseLimit{ StreamsInbound: 256, StreamsOutbound: 512, Streams: 512, }, ServicePeerMemory: MemoryLimit{ MemoryFraction: 0.125 / 16, MinMemory: 16 << 20, MaxMemory: 64 << 20, }, ProtocolBaseLimit: BaseLimit{ StreamsInbound: 1024, StreamsOutbound: 4096, Streams: 4096, }, ProtocolMemory: MemoryLimit{ MemoryFraction: 0.125 / 8, MinMemory: 64 << 20, MaxMemory: 128 << 20, }, ProtocolPeerBaseLimit: BaseLimit{ StreamsInbound: 128, StreamsOutbound: 256, Streams: 512, }, ProtocolPeerMemory: MemoryLimit{ MemoryFraction: 0.125 / 16, MinMemory: 16 << 20, MaxMemory: 64 << 20, }, PeerBaseLimit: BaseLimit{ StreamsInbound: 512, StreamsOutbound: 1024, Streams: 1024, ConnsInbound: 8, ConnsOutbound: 16, Conns: 16, FD: 8, }, PeerMemory: MemoryLimit{ MemoryFraction: 0.125 / 16, MinMemory: 64 << 20, MaxMemory: 128 << 20, }, ConnBaseLimit: BaseLimit{ ConnsInbound: 1, ConnsOutbound: 1, Conns: 1, FD: 1, }, ConnMemory: 1 << 20, StreamBaseLimit: BaseLimit{ StreamsInbound: 1, StreamsOutbound: 1, Streams: 1, }, StreamMemory: 16 << 20, }
DefaultLimits are the limits used by the default limiter constructors.
Functions ¶
func NewResourceManager ¶
func NewResourceManager(limits Limiter, opts ...Option) (network.ResourceManager, error)
Types ¶
type BaseLimit ¶
type BaseLimit struct {
Streams int
StreamsInbound int
StreamsOutbound int
Conns int
ConnsInbound int
ConnsOutbound int
FD int
}
BaseLimit is a mixin type for basic resource limits.
func (*BaseLimit) GetConnTotalLimit ¶
func (*BaseLimit) GetFDLimit ¶
func (*BaseLimit) GetStreamTotalLimit ¶
type BasicLimiter ¶
type BasicLimiter struct {
SystemLimits Limit
TransientLimits Limit
DefaultServiceLimits Limit
DefaultServicePeerLimits Limit
ServiceLimits map[string]Limit
ServicePeerLimits map[string]Limit
DefaultProtocolLimits Limit
DefaultProtocolPeerLimits Limit
ProtocolLimits map[protocol.ID]Limit
ProtocolPeerLimits map[protocol.ID]Limit
DefaultPeerLimits Limit
PeerLimits map[peer.ID]Limit
ConnLimits Limit
StreamLimits Limit
}
BasicLimiter is a limiter with fixed limits.
func NewDefaultDynamicLimiter ¶
func NewDefaultDynamicLimiter(memFraction float64, minMemory, maxMemory int64) *BasicLimiter
NewDefaultDynamicLimiter creates a limiter with default limits and a memory cap dynamically computed based on available memory.
func NewDefaultFixedLimiter ¶
func NewDefaultFixedLimiter(memoryCap int64) *BasicLimiter
NewDefaultFixedLimiter creates a static limiter with default base limits and a specified system memory cap.
func NewDefaultLimiter ¶
func NewDefaultLimiter() *BasicLimiter
NewDefaultLimiter creates a static limiter with the default limits
func NewDefaultLimiterFromJSON ¶
func NewDefaultLimiterFromJSON(in io.Reader) (*BasicLimiter, error)
NewDefaultLimiterFromJSON creates a new limiter by parsing a json configuration, using the default limits for fallback.
func NewDefaultStaticLimiter ¶
func NewDefaultStaticLimiter(memFraction float64, minMemory, maxMemory int64) *BasicLimiter
NewDefaultStaticLimiter creates a static limiter with default base limits and a system memory cap specified as a fraction of total system memory. The assigned memory will not be less than minMemory or more than maxMemory.
func NewDynamicLimiter ¶
func NewDynamicLimiter(cfg DefaultLimitConfig) *BasicLimiter
NewDynamicLimiter crates a dynamic limiter with the specified defaults
func NewLimiterFromJSON ¶
func NewLimiterFromJSON(in io.Reader, defaults DefaultLimitConfig) (*BasicLimiter, error)
NewLimiterFromJSON creates a new limiter by parsing a json configuration.
func NewStaticLimiter ¶
func NewStaticLimiter(cfg DefaultLimitConfig) *BasicLimiter
NewStaticLimiter creates a static limiter using the specified system memory cap and default limit config.
func (*BasicLimiter) GetConnLimits ¶
func (l *BasicLimiter) GetConnLimits() Limit
func (*BasicLimiter) GetPeerLimits ¶
func (l *BasicLimiter) GetPeerLimits(p peer.ID) Limit
func (*BasicLimiter) GetProtocolLimits ¶
func (l *BasicLimiter) GetProtocolLimits(proto protocol.ID) Limit
func (*BasicLimiter) GetProtocolPeerLimits ¶
func (l *BasicLimiter) GetProtocolPeerLimits(proto protocol.ID) Limit
func (*BasicLimiter) GetServiceLimits ¶
func (l *BasicLimiter) GetServiceLimits(svc string) Limit
func (*BasicLimiter) GetServicePeerLimits ¶
func (l *BasicLimiter) GetServicePeerLimits(svc string) Limit
func (*BasicLimiter) GetStreamLimits ¶
func (l *BasicLimiter) GetStreamLimits(p peer.ID) Limit
func (*BasicLimiter) GetSystemLimits ¶
func (l *BasicLimiter) GetSystemLimits() Limit
func (*BasicLimiter) GetTransientLimits ¶
func (l *BasicLimiter) GetTransientLimits() Limit
type DefaultLimitConfig ¶
type DefaultLimitConfig struct {
SystemBaseLimit BaseLimit
SystemMemory MemoryLimit
TransientBaseLimit BaseLimit
TransientMemory MemoryLimit
ServiceBaseLimit BaseLimit
ServiceMemory MemoryLimit
ServicePeerBaseLimit BaseLimit
ServicePeerMemory MemoryLimit
ProtocolBaseLimit BaseLimit
ProtocolMemory MemoryLimit
ProtocolPeerBaseLimit BaseLimit
ProtocolPeerMemory MemoryLimit
PeerBaseLimit BaseLimit
PeerMemory MemoryLimit
ConnBaseLimit BaseLimit
ConnMemory int64
StreamBaseLimit BaseLimit
StreamMemory int64
}
DefaultLimitConfig is a struct for configuring default limits.
func (*DefaultLimitConfig) WithSystemMemory ¶
func (cfg *DefaultLimitConfig) WithSystemMemory(memFraction float64, minMemory, maxMemory int64) DefaultLimitConfig
type DynamicLimit ¶
type DynamicLimit struct {
BaseLimit
MemoryLimit
}
DynamicLimit is a limit with dynamic memory values, based on available (free) memory
func (*DynamicLimit) GetMemoryLimit ¶
func (l *DynamicLimit) GetMemoryLimit() int64
func (*DynamicLimit) WithConnLimit ¶
func (l *DynamicLimit) WithConnLimit(numConnsIn, numConnsOut, numConns int) Limit
func (*DynamicLimit) WithFDLimit ¶
func (l *DynamicLimit) WithFDLimit(numFD int) Limit
func (*DynamicLimit) WithMemoryLimit ¶
func (l *DynamicLimit) WithMemoryLimit(memFraction float64, minMemory, maxMemory int64) Limit
func (*DynamicLimit) WithStreamLimit ¶
func (l *DynamicLimit) WithStreamLimit(numStreamsIn, numStreamsOut, numStreams int) Limit
type Limit ¶
type Limit interface {
// GetMemoryLimit returns the (current) memory limit.
GetMemoryLimit() int64
// GetStreamLimit returns the stream limit, for inbound or outbound streams.
GetStreamLimit(network.Direction) int
// GetStreamTotalLimit returns the total stream limit
GetStreamTotalLimit() int
// GetConnLimit returns the connection limit, for inbound or outbound connections.
GetConnLimit(network.Direction) int
// GetConnTotalLimit returns the total connection limit
GetConnTotalLimit() int
// GetFDLimit returns the file descriptor limit.
GetFDLimit() int
// WithMemoryLimit creates a copy of this limit object, with memory limit adjusted to
// the specified memFraction of its current value, bounded by minMemory and maxMemory.
WithMemoryLimit(memFraction float64, minMemory, maxMemory int64) Limit
// WithStreamLimit creates a copy of this limit object, with stream limits adjusted
// as specified.
WithStreamLimit(numStreamsIn, numStreamsOut, numStreams int) Limit
// WithConnLimit creates a copy of this limit object, with connetion limits adjusted
// as specified.
WithConnLimit(numConnsIn, numConnsOut, numConns int) Limit
// WithFDLimit creates a copy of this limit object, with file descriptor limits adjusted
// as specified
WithFDLimit(numFD int) Limit
}
Limit is an object that specifies basic resource limits.
type Limiter ¶
type Limiter interface {
GetSystemLimits() Limit
GetTransientLimits() Limit
GetServiceLimits(svc string) Limit
GetServicePeerLimits(svc string) Limit
GetProtocolLimits(proto protocol.ID) Limit
GetProtocolPeerLimits(proto protocol.ID) Limit
GetPeerLimits(p peer.ID) Limit
GetStreamLimits(p peer.ID) Limit
GetConnLimits() Limit
}
Limiter is the interface for providing limits to the resource manager.
type MemoryLimit ¶
MemoryLimit is a mixin type for memory limits
func (*MemoryLimit) GetMemory ¶
func (l *MemoryLimit) GetMemory(memoryCap int64) int64
type ResourceManagerStat ¶
type ResourceManagerState ¶
type ResourceManagerState interface {
ListServices() []string
ListProtocols() []protocol.ID
ListPeers() []peer.ID
Stat() ResourceManagerStat
}
ResourceManagerStat is a trait that allows you to access resource manager state.
type ResourceScopeLimiter ¶
ResourceScopeLimiter is a trait interface that allows you to access scope limits.
type StaticLimit ¶
StaticLimit is a limit with static values.
func (*StaticLimit) GetMemoryLimit ¶
func (l *StaticLimit) GetMemoryLimit() int64
func (*StaticLimit) WithConnLimit ¶
func (l *StaticLimit) WithConnLimit(numConnsIn, numConnsOut, numConns int) Limit
func (*StaticLimit) WithFDLimit ¶
func (l *StaticLimit) WithFDLimit(numFD int) Limit
func (*StaticLimit) WithMemoryLimit ¶
func (l *StaticLimit) WithMemoryLimit(memFraction float64, minMemory, maxMemory int64) Limit
func (*StaticLimit) WithStreamLimit ¶
func (l *StaticLimit) WithStreamLimit(numStreamsIn, numStreamsOut, numStreams int) Limit