package rcmgr

Import Path
	github.com/libp2p/go-libp2p/p2p/host/resource-manager (on go.dev)

Dependency Relation
	imports 29 packages, and imported by 2 packages

Involved Source Files

	    allowlist.go
	    conn_limiter.go
	    conn_rate_limiter.go
	    error.go
	    extapi.go
	  d limit.go
		Package rcmgr is the resource manager for go-libp2p. This allows you to track
		resources being used throughout your go-libp2p process. As well as making sure
		that the process doesn't use more resources than what you define as your
		limits. The resource manager only knows about things it is told about, so it's
		the responsibility of the user of this library (either go-libp2p or a go-libp2p
		user) to make sure they check with the resource manager before actually
		allocating the resource.

	    limit_defaults.go
	    metrics.go
	    rcmgr.go
	    scope.go
	    stats.go
	    sys_unix.go
	    trace.go
Package-Level Type Names (total 24)

	/* sort by: alphabet | popularity */
	 type Allowlist (struct)

		Methods (total 4)
			(*Allowlist) Add(ma multiaddr.Multiaddr) error
				Add takes a multiaddr and adds it to the allowlist. The multiaddr should be
				an ip address of the peer with or without a `/p2p` protocol.
				e.g. /ip4/1.2.3.4/p2p/QmFoo, /ip4/1.2.3.4, and /ip4/1.2.3.0/ipcidr/24 are valid.
				/p2p/QmFoo is not valid.

			(*Allowlist) Allowed(ma multiaddr.Multiaddr) bool
			(*Allowlist) AllowedPeerAndMultiaddr(peerID peer.ID, ma multiaddr.Multiaddr) bool
			(*Allowlist) Remove(ma multiaddr.Multiaddr) error
		As Outputs Of (at least one exported)
			func GetAllowlist(rcmgr network.ResourceManager) *Allowlist

	 type BaseLimit (struct)
		BaseLimit is a mixin type for basic resource limits.

		Fields (total 8)
			Conns int
			ConnsInbound int
			ConnsOutbound int
			FD int
			Memory int64
			Streams int
			StreamsInbound int
			StreamsOutbound int
		Methods (total 8)
			(*BaseLimit) Apply(l2 BaseLimit)
				Apply overwrites all zero-valued limits with the values of l2
				Must not use a pointer receiver.

			( BaseLimit) GetConnLimit(dir network.Direction) int
			( BaseLimit) GetConnTotalLimit() int
			( BaseLimit) GetFDLimit() int
			( BaseLimit) GetMemoryLimit() int64
			( BaseLimit) GetStreamLimit(dir network.Direction) int
			( BaseLimit) GetStreamTotalLimit() int
			( BaseLimit) ToResourceLimits() ResourceLimits
				ToResourceLimits converts the BaseLimit to a ResourceLimits

		Implements (at least one exported)
			 BaseLimit : Limit
		As Outputs Of (at least one exported)
			func (*ResourceLimits).Build(defaults Limit) BaseLimit
		As Inputs Of (at least 6)
			func (*BaseLimit).Apply(l2 BaseLimit)
			func (*ScalingLimitConfig).AddPeerLimit(p peer.ID, base BaseLimit, inc BaseLimitIncrease)
			func (*ScalingLimitConfig).AddProtocolLimit(proto protocol.ID, base BaseLimit, inc BaseLimitIncrease)
			func (*ScalingLimitConfig).AddProtocolPeerLimit(proto protocol.ID, base BaseLimit, inc BaseLimitIncrease)
			func (*ScalingLimitConfig).AddServiceLimit(svc string, base BaseLimit, inc BaseLimitIncrease)
			func (*ScalingLimitConfig).AddServicePeerLimit(svc string, base BaseLimit, inc BaseLimitIncrease)

	 type BaseLimitIncrease (struct)
		BaseLimitIncrease is the increase per GiB of allowed memory.

		Fields (total 8)
			Conns int
			ConnsInbound int
			ConnsOutbound int
			FDFraction float64
				FDFraction is expected to be >= 0 and <= 1.

			Memory int64
				Memory is in bytes. Values over 1>>30 (1GiB) don't make sense.

			Streams int
			StreamsInbound int
			StreamsOutbound int
		Methods (only one)
			(*BaseLimitIncrease) Apply(l2 BaseLimitIncrease)
				Apply overwrites all zero-valued limits with the values of l2
				Must not use a pointer receiver.

		As Inputs Of (at least 6)
			func (*BaseLimitIncrease).Apply(l2 BaseLimitIncrease)
			func (*ScalingLimitConfig).AddPeerLimit(p peer.ID, base BaseLimit, inc BaseLimitIncrease)
			func (*ScalingLimitConfig).AddProtocolLimit(proto protocol.ID, base BaseLimit, inc BaseLimitIncrease)
			func (*ScalingLimitConfig).AddProtocolPeerLimit(proto protocol.ID, base BaseLimit, inc BaseLimitIncrease)
			func (*ScalingLimitConfig).AddServiceLimit(svc string, base BaseLimit, inc BaseLimitIncrease)
			func (*ScalingLimitConfig).AddServicePeerLimit(svc string, base BaseLimit, inc BaseLimitIncrease)

	 type ConcreteLimitConfig (struct)
		ConcreteLimitConfig is similar to PartialLimitConfig, but all values are defined.
		There is no unset "default" value. Commonly constructed by calling
		PartialLimitConfig.Build(rcmgr.DefaultLimits.AutoScale())

		Methods (only one)
			( ConcreteLimitConfig) ToPartialLimitConfig() PartialLimitConfig
				ToPartialLimitConfig converts a ConcreteLimitConfig to a PartialLimitConfig.
				The returned PartialLimitConfig will have no default values.

		As Outputs Of (at least 3)
			func PartialLimitConfig.Build(defaults ConcreteLimitConfig) ConcreteLimitConfig
			func (*ScalingLimitConfig).AutoScale() ConcreteLimitConfig
			func (*ScalingLimitConfig).Scale(memory int64, numFD int) ConcreteLimitConfig
		As Inputs Of (at least 3)
			func NewFixedLimiter(conf ConcreteLimitConfig) Limiter
			func NewLimiterFromJSON(in io.Reader, defaults ConcreteLimitConfig) (Limiter, error)
			func PartialLimitConfig.Build(defaults ConcreteLimitConfig) ConcreteLimitConfig
		As Types Of (only one)
			  var InfiniteLimits

	 type ConnLimitPerSubnet (struct)

		Fields (total 2)
			ConnCount int
				The maximum number of connections allowed for each subnet.

			PrefixLength int
				This defines how big the subnet is. For example, a /24 subnet has a
				PrefixLength of 24. All IPs that share the same 24 bit prefix are in the same
				subnet. Are in the same subnet, and bound to the same limit.

		As Inputs Of (at least 2)
			func WithLimitPerSubnet(ipv4 []ConnLimitPerSubnet, ipv6 []ConnLimitPerSubnet) Option
			func WithLimitPerSubnet(ipv4 []ConnLimitPerSubnet, ipv6 []ConnLimitPerSubnet) Option

	 type ErrMemoryLimitExceeded (struct)

		Methods (total 2)
			(*ErrMemoryLimitExceeded) Error() string
			(*ErrMemoryLimitExceeded) Unwrap() error
		Implements (at least 2)
			*ErrMemoryLimitExceeded : error
			*ErrMemoryLimitExceeded : golang.org/x/xerrors.Wrapper

	 type ErrStreamOrConnLimitExceeded (struct)

		Methods (total 2)
			(*ErrStreamOrConnLimitExceeded) Error() string
			(*ErrStreamOrConnLimitExceeded) Unwrap() error
		Implements (at least 2)
			*ErrStreamOrConnLimitExceeded : error
			*ErrStreamOrConnLimitExceeded : golang.org/x/xerrors.Wrapper

	 type Limit (interface)
		Limit is an object that specifies basic resource limits.

		Methods (total 6)
			( Limit) GetConnLimit(network.Direction) int
				GetConnLimit returns the connection limit, for inbound or outbound connections.

			( Limit) GetConnTotalLimit() int
				GetConnTotalLimit returns the total connection limit

			( Limit) GetFDLimit() int
				GetFDLimit returns the file descriptor limit.

			( Limit) GetMemoryLimit() int64
				GetMemoryLimit returns the (current) memory limit.

			( Limit) GetStreamLimit(network.Direction) int
				GetStreamLimit returns the stream limit, for inbound or outbound streams.

			( Limit) GetStreamTotalLimit() int
				GetStreamTotalLimit returns the total stream limit

		Implemented By (at least one exported)
			 BaseLimit
		As Outputs Of (at least 12)
			func Limiter.GetAllowlistedSystemLimits() Limit
			func Limiter.GetAllowlistedTransientLimits() Limit
			func Limiter.GetConnLimits() Limit
			func Limiter.GetPeerLimits(p peer.ID) Limit
			func Limiter.GetProtocolLimits(proto protocol.ID) Limit
			func Limiter.GetProtocolPeerLimits(proto protocol.ID) Limit
			func Limiter.GetServiceLimits(svc string) Limit
			func Limiter.GetServicePeerLimits(svc string) Limit
			func Limiter.GetStreamLimits(p peer.ID) Limit
			func Limiter.GetSystemLimits() Limit
			func Limiter.GetTransientLimits() Limit
			func ResourceScopeLimiter.Limit() Limit
		As Inputs Of (at least 2)
			func (*ResourceLimits).Build(defaults Limit) BaseLimit
			func ResourceScopeLimiter.SetLimit(Limit)

	 type Limiter (interface)
		Limiter is the interface for providing limits to the resource manager.

		Methods (total 11)
			( Limiter) GetAllowlistedSystemLimits() Limit
			( Limiter) GetAllowlistedTransientLimits() Limit
			( Limiter) GetConnLimits() Limit
			( Limiter) GetPeerLimits(p peer.ID) Limit
			( Limiter) GetProtocolLimits(proto protocol.ID) Limit
			( Limiter) GetProtocolPeerLimits(proto protocol.ID) Limit
			( Limiter) GetServiceLimits(svc string) Limit
			( Limiter) GetServicePeerLimits(svc string) Limit
			( Limiter) GetStreamLimits(p peer.ID) Limit
			( Limiter) GetSystemLimits() Limit
			( Limiter) GetTransientLimits() Limit
		As Outputs Of (at least 3)
			func NewDefaultLimiterFromJSON(in io.Reader) (Limiter, error)
			func NewFixedLimiter(conf ConcreteLimitConfig) Limiter
			func NewLimiterFromJSON(in io.Reader, defaults ConcreteLimitConfig) (Limiter, error)
		As Inputs Of (at least one exported)
			func NewResourceManager(limits Limiter, opts ...Option) (network.ResourceManager, error)

	 type LimitVal int (basic type)

		Methods (total 3)
			( LimitVal) Build(defaultVal int) int
			( LimitVal) MarshalJSON() ([]byte, error)
			(*LimitVal) UnmarshalJSON(b []byte) error
		Implements (at least 4)
			 LimitVal : github.com/goccy/go-json.Marshaler
			*LimitVal : github.com/goccy/go-json.Unmarshaler
			 LimitVal : encoding/json.Marshaler
			*LimitVal : encoding/json.Unmarshaler
		As Types Of (total 3)
			const BlockAllLimit
			const DefaultLimit
			const Unlimited

	 type LimitVal64 int64 (basic type)

		Methods (total 3)
			( LimitVal64) Build(defaultVal int64) int64
			( LimitVal64) MarshalJSON() ([]byte, error)
			(*LimitVal64) UnmarshalJSON(b []byte) error
		Implements (at least 4)
			 LimitVal64 : github.com/goccy/go-json.Marshaler
			*LimitVal64 : github.com/goccy/go-json.Unmarshaler
			 LimitVal64 : encoding/json.Marshaler
			*LimitVal64 : encoding/json.Unmarshaler
		As Types Of (total 3)
			const BlockAllLimit64
			const DefaultLimit64
			const Unlimited64

	 type MetricsReporter (interface)
		MetricsReporter is an interface for collecting metrics from resource manager actions

		Methods (total 14)
			( MetricsReporter) AllowConn(dir network.Direction, usefd bool)
				AllowConn is invoked when opening a connection is allowed

			( MetricsReporter) AllowMemory(size int)
				AllowMemory is invoked when a memory reservation is allowed

			( MetricsReporter) AllowPeer(p peer.ID)
				AllowPeer is invoked when attaching ac onnection to a peer is allowed

			( MetricsReporter) AllowProtocol(proto protocol.ID)
				AllowProtocol is invoked when setting the protocol for a stream is allowed

			( MetricsReporter) AllowService(svc string)
				AllowService is invoked when setting the protocol for a stream is allowed

			( MetricsReporter) AllowStream(p peer.ID, dir network.Direction)
				AllowStream is invoked when opening a stream is allowed

			( MetricsReporter) BlockConn(dir network.Direction, usefd bool)
				BlockConn is invoked when opening a connection is blocked

			( MetricsReporter) BlockMemory(size int)
				BlockMemory is invoked when a memory reservation is blocked

			( MetricsReporter) BlockPeer(p peer.ID)
				BlockPeer is invoked when attaching ac onnection to a peer is blocked

			( MetricsReporter) BlockProtocol(proto protocol.ID)
				BlockProtocol is invoked when setting the protocol for a stream is blocked

			( MetricsReporter) BlockProtocolPeer(proto protocol.ID, p peer.ID)
				BlockProtocolPeer is invoked when setting the protocol for a stream is blocked at the per protocol peer scope

			( MetricsReporter) BlockService(svc string)
				BlockService is invoked when setting the protocol for a stream is blocked

			( MetricsReporter) BlockServicePeer(svc string, p peer.ID)
				BlockServicePeer is invoked when setting the service for a stream is blocked at the per service peer scope

			( MetricsReporter) BlockStream(p peer.ID, dir network.Direction)
				BlockStream is invoked when opening a stream is blocked

		As Inputs Of (at least one exported)
			func WithMetrics(reporter MetricsReporter) Option

	 type NetworkPrefixLimit (struct)

		Fields (total 2)
			ConnCount int
				The maximum number of connections allowed for this subnet.

			Network netip.Prefix
				The Network prefix for which this limit applies.

		As Inputs Of (at least 2)
			func WithNetworkPrefixLimit(ipv4 []NetworkPrefixLimit, ipv6 []NetworkPrefixLimit) Option
			func WithNetworkPrefixLimit(ipv4 []NetworkPrefixLimit, ipv6 []NetworkPrefixLimit) Option

	 type Option (func)

		As Outputs Of (at least 8)
			func WithAllowlistedMultiaddrs(mas []multiaddr.Multiaddr) Option
			func WithConnRateLimiters(connRateLimiter *rate.Limiter) Option
			func WithLimitPerSubnet(ipv4 []ConnLimitPerSubnet, ipv6 []ConnLimitPerSubnet) Option
			func WithMetrics(reporter MetricsReporter) Option
			func WithMetricsDisabled() Option
			func WithNetworkPrefixLimit(ipv4 []NetworkPrefixLimit, ipv6 []NetworkPrefixLimit) Option
			func WithTrace(path string) Option
			func WithTraceReporter(reporter TraceReporter) Option
		As Inputs Of (at least one exported)
			func NewResourceManager(limits Limiter, opts ...Option) (network.ResourceManager, error)

	 type PartialLimitConfig (struct)

		Fields (total 16)
			AllowlistedSystem ResourceLimits
				Limits that are applied to resources with an allowlisted multiaddr.
				These will only be used if the normal System & Transient limits are
				reached.

			AllowlistedTransient ResourceLimits
			Conn ResourceLimits
			Peer map[peer.ID]ResourceLimits
			PeerDefault ResourceLimits
			Protocol map[protocol.ID]ResourceLimits
			ProtocolDefault ResourceLimits
			ProtocolPeer map[protocol.ID]ResourceLimits
			ProtocolPeerDefault ResourceLimits
			Service map[string]ResourceLimits
			ServiceDefault ResourceLimits
			ServicePeer map[string]ResourceLimits
			ServicePeerDefault ResourceLimits
			Stream ResourceLimits
			System ResourceLimits
			Transient ResourceLimits
		Methods (total 3)
			(*PartialLimitConfig) Apply(c PartialLimitConfig)
			( PartialLimitConfig) Build(defaults ConcreteLimitConfig) ConcreteLimitConfig
			(*PartialLimitConfig) MarshalJSON() ([]byte, error)
		Implements (at least 2)
			*PartialLimitConfig : github.com/goccy/go-json.Marshaler
			*PartialLimitConfig : encoding/json.Marshaler
		As Outputs Of (at least one exported)
			func ConcreteLimitConfig.ToPartialLimitConfig() PartialLimitConfig
		As Inputs Of (at least one exported)
			func (*PartialLimitConfig).Apply(c PartialLimitConfig)

	 type ResourceLimits (struct)
		ResourceLimits is the type for basic resource limits.

		Fields (total 8)
			Conns LimitVal
			ConnsInbound LimitVal
			ConnsOutbound LimitVal
			FD LimitVal
			Memory LimitVal64
			Streams LimitVal
			StreamsInbound LimitVal
			StreamsOutbound LimitVal
		Methods (total 4)
			(*ResourceLimits) Apply(l2 ResourceLimits)
				Apply overwrites all default limits with the values of l2

			(*ResourceLimits) Build(defaults Limit) BaseLimit
			(*ResourceLimits) IsDefault() bool
			(*ResourceLimits) ToMaybeNilPtr() *ResourceLimits
		As Outputs Of (at least 2)
			func BaseLimit.ToResourceLimits() ResourceLimits
			func (*ResourceLimits).ToMaybeNilPtr() *ResourceLimits
		As Inputs Of (at least one exported)
			func (*ResourceLimits).Apply(l2 ResourceLimits)

	 type ResourceManagerStat (struct)

		Fields (total 5)
			Peers map[peer.ID]network.ScopeStat
			Protocols map[protocol.ID]network.ScopeStat
			Services map[string]network.ScopeStat
			System network.ScopeStat
			Transient network.ScopeStat
		As Outputs Of (at least one exported)
			func ResourceManagerState.Stat() ResourceManagerStat

	 type ResourceManagerState (interface)
		ResourceManagerStat is a trait that allows you to access resource manager state.

		Methods (total 4)
			( ResourceManagerState) ListPeers() []peer.ID
			( ResourceManagerState) ListProtocols() []protocol.ID
			( ResourceManagerState) ListServices() []string
			( ResourceManagerState) Stat() ResourceManagerStat

	 type ResourceScopeLimiter (interface)
		ResourceScopeLimiter is a trait interface that allows you to access scope limits.

		Methods (total 2)
			( ResourceScopeLimiter) Limit() Limit
			( ResourceScopeLimiter) SetLimit(Limit)

	 type ScalingLimitConfig (struct)
		ScalingLimitConfig is a struct for configuring default limits.
		{}BaseLimit is the limits that Apply for a minimal node (128 MB of memory for libp2p) and 256 file descriptors.
		{}LimitIncrease is the additional limit granted for every additional 1 GB of RAM.

		Fields (total 27)
			AllowlistedSystemBaseLimit BaseLimit
			AllowlistedSystemLimitIncrease BaseLimitIncrease
			AllowlistedTransientBaseLimit BaseLimit
			AllowlistedTransientLimitIncrease BaseLimitIncrease
			ConnBaseLimit BaseLimit
			ConnLimitIncrease BaseLimitIncrease
			PeerBaseLimit BaseLimit
			PeerLimitIncrease BaseLimitIncrease
			PeerLimits map[peer.ID]baseLimitConfig
				// use AddPeerLimit to modify

			ProtocolBaseLimit BaseLimit
			ProtocolLimitIncrease BaseLimitIncrease
			ProtocolLimits map[protocol.ID]baseLimitConfig
				// use AddProtocolLimit to modify

			ProtocolPeerBaseLimit BaseLimit
			ProtocolPeerLimitIncrease BaseLimitIncrease
			ProtocolPeerLimits map[protocol.ID]baseLimitConfig
				// use AddProtocolPeerLimit to modify

			ServiceBaseLimit BaseLimit
			ServiceLimitIncrease BaseLimitIncrease
			ServiceLimits map[string]baseLimitConfig
				// use AddServiceLimit to modify

			ServicePeerBaseLimit BaseLimit
			ServicePeerLimitIncrease BaseLimitIncrease
			ServicePeerLimits map[string]baseLimitConfig
				// use AddServicePeerLimit to modify

			StreamBaseLimit BaseLimit
			StreamLimitIncrease BaseLimitIncrease
			SystemBaseLimit BaseLimit
			SystemLimitIncrease BaseLimitIncrease
			TransientBaseLimit BaseLimit
			TransientLimitIncrease BaseLimitIncrease
		Methods (total 7)
			(*ScalingLimitConfig) AddPeerLimit(p peer.ID, base BaseLimit, inc BaseLimitIncrease)
			(*ScalingLimitConfig) AddProtocolLimit(proto protocol.ID, base BaseLimit, inc BaseLimitIncrease)
			(*ScalingLimitConfig) AddProtocolPeerLimit(proto protocol.ID, base BaseLimit, inc BaseLimitIncrease)
			(*ScalingLimitConfig) AddServiceLimit(svc string, base BaseLimit, inc BaseLimitIncrease)
			(*ScalingLimitConfig) AddServicePeerLimit(svc string, base BaseLimit, inc BaseLimitIncrease)
			(*ScalingLimitConfig) AutoScale() ConcreteLimitConfig
			(*ScalingLimitConfig) Scale(memory int64, numFD int) ConcreteLimitConfig
				Scale scales up a limit configuration.
				memory is the amount of memory that the stack is allowed to consume,
				for a dedicated node it's recommended to use 1/8 of the installed system memory.
				If memory is smaller than 128 MB, the base configuration will be used.

		As Inputs Of (at least one exported)
			func github.com/libp2p/go-libp2p.SetDefaultServiceLimits(config *ScalingLimitConfig)
		As Types Of (only one)
			  var DefaultLimits

	 type StatsTraceReporter (struct)
		StatsTraceReporter reports stats on the resource manager using its traces.

		Methods (only one)
			( StatsTraceReporter) ConsumeEvent(evt TraceEvt)
		Implements (at least one exported)
			 StatsTraceReporter : TraceReporter
		As Outputs Of (at least one exported)
			func NewStatsTraceReporter() (StatsTraceReporter, error)

	 type TraceEvt (struct)

		Fields (total 15)
			ConnsIn int
			ConnsOut int
			Delta int64
			DeltaIn int
			DeltaOut int
			FD int
			Limit interface{}
			Memory int64
			Name string
			Priority uint8
			Scope *scopeClass
			StreamsIn int
			StreamsOut int
			Time string
			Type TraceEvtTyp
		As Inputs Of (at least 2)
			func StatsTraceReporter.ConsumeEvent(evt TraceEvt)
			func TraceReporter.ConsumeEvent(TraceEvt)

	 type TraceEvtTyp string (basic type)

		As Types Of (total 12)
			const TraceAddConnEvt
			const TraceAddStreamEvt
			const TraceBlockAddConnEvt
			const TraceBlockAddStreamEvt
			const TraceBlockReserveMemoryEvt
			const TraceCreateScopeEvt
			const TraceDestroyScopeEvt
			const TraceReleaseMemoryEvt
			const TraceRemoveConnEvt
			const TraceRemoveStreamEvt
			const TraceReserveMemoryEvt
			const TraceStartEvt

	 type TraceReporter (interface)

		Methods (only one)
			( TraceReporter) ConsumeEvent(TraceEvt)
				ConsumeEvent consumes a trace event. This is called synchronously,
				implementations should process the event quickly.

		Implemented By (at least one exported)
			 StatsTraceReporter
		As Inputs Of (at least one exported)
			func WithTraceReporter(reporter TraceReporter) Option


Package-Level Functions (total 22)

	 func GetAllowlist(rcmgr network.ResourceManager) *Allowlist
		GetAllowlist tries to get the allowlist from the given resourcemanager
		interface by checking to see if its concrete type is a resourceManager.
		Returns nil if it fails to get the allowlist.

	 func IsConnScope(name string) bool
	 func IsSpan(name string) bool
		IsSpan will return true if this name was created by newResourceScopeSpan

	 func IsStreamScope(name string) bool
	 func IsSystemScope(name string) bool
	 func IsTransientScope(name string) bool
	 func MustRegisterWith(reg prometheus.Registerer)
	 func NewDefaultLimiterFromJSON(in io.Reader) (Limiter, error)
		NewDefaultLimiterFromJSON creates a new limiter by parsing a json configuration,
		using the default limits for fallback.

	 func NewFixedLimiter(conf ConcreteLimitConfig) Limiter
	 func NewLimiterFromJSON(in io.Reader, defaults ConcreteLimitConfig) (Limiter, error)
		NewLimiterFromJSON creates a new limiter by parsing a json configuration.

	 func NewResourceManager(limits Limiter, opts ...Option) (network.ResourceManager, error)
	 func NewStatsTraceReporter() (StatsTraceReporter, error)
	 func ParseProtocolScopeName(name string) string
		ParseProtocolScopeName returns the service name if name is a serviceScopeName.
		Otherwise returns ""

	 func PeerStrInScopeName(name string) string
		PeerStrInScopeName returns "" if name is not a peerScopeName. Returns a string to avoid allocating a peer ID object

	 func WithAllowlistedMultiaddrs(mas []multiaddr.Multiaddr) Option
		WithAllowlistedMultiaddrs sets the multiaddrs to be in the allowlist

	 func WithConnRateLimiters(connRateLimiter *rate.Limiter) Option
		WithConnRateLimiters sets a custom rate limiter for new connections.
		connRateLimiter is used for OpenConnection calls

	 func WithLimitPerSubnet(ipv4 []ConnLimitPerSubnet, ipv6 []ConnLimitPerSubnet) Option
		WithLimitPerSubnet sets the limits for the number of connections allowed per
		subnet. This will limit the number of connections per subnet if that subnet
		is not defined in the NetworkPrefixLimit option. Think of this as a default
		limit for any given subnet.

	 func WithMetrics(reporter MetricsReporter) Option
		WithMetrics is a resource manager option to enable metrics collection

	 func WithMetricsDisabled() Option
	 func WithNetworkPrefixLimit(ipv4 []NetworkPrefixLimit, ipv6 []NetworkPrefixLimit) Option
		WithNetworkPrefixLimit sets the limits for the number of connections allowed
		for a specific Network Prefix. Use this when you want to set higher limits
		for a specific subnet than the default limit per subnet.

	 func WithTrace(path string) Option
	 func WithTraceReporter(reporter TraceReporter) Option
Package-Level Variables (total 4)

	  var DefaultLimits ScalingLimitConfig
		DefaultLimits are the limits used by the default limiter constructors.

	  var DefaultNetworkPrefixLimitV4 []NetworkPrefixLimit
	  var DefaultNetworkPrefixLimitV6 []NetworkPrefixLimit
	  var InfiniteLimits ConcreteLimitConfig
		InfiniteLimits are a limiter configuration that uses unlimited limits, thus effectively not limiting anything.
		Keep in mind that the operating system limits the number of file descriptors that an application can use.


Package-Level Constants (total 18)

	const BlockAllLimit LimitVal = -2
		BlockAllLimit is the LimitVal for allowing no amount of resources.

	const BlockAllLimit64 LimitVal64 = -2
		BlockAllLimit64 is the LimitVal for allowing no amount of resources.

	const DefaultLimit LimitVal = 0
		DefaultLimit is the default value for resources. The exact value depends on the context, but will get values from `DefaultLimits`.

	const DefaultLimit64 LimitVal64 = 0
		Default is the default value for resources.

	const TraceAddConnEvt TraceEvtTyp = "add_conn"
	const TraceAddStreamEvt TraceEvtTyp = "add_stream"
	const TraceBlockAddConnEvt TraceEvtTyp = "block_add_conn"
	const TraceBlockAddStreamEvt TraceEvtTyp = "block_add_stream"
	const TraceBlockReserveMemoryEvt TraceEvtTyp = "block_reserve_memory"
	const TraceCreateScopeEvt TraceEvtTyp = "create_scope"
	const TraceDestroyScopeEvt TraceEvtTyp = "destroy_scope"
	const TraceReleaseMemoryEvt TraceEvtTyp = "release_memory"
	const TraceRemoveConnEvt TraceEvtTyp = "remove_conn"
	const TraceRemoveStreamEvt TraceEvtTyp = "remove_stream"
	const TraceReserveMemoryEvt TraceEvtTyp = "reserve_memory"
	const TraceStartEvt TraceEvtTyp = "start"
	const Unlimited LimitVal = -1
		Unlimited is the value for unlimited resources. An arbitrarily high number will also work.

	const Unlimited64 LimitVal64 = -1
		Unlimited is the value for unlimited resources.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.