Documentation
¶
Index ¶
- type ConnManager
- type NullConnMgr
- func (_ NullConnMgr) Close() error
- func (_ NullConnMgr) GetTagInfo(peer.ID) *TagInfo
- func (_ NullConnMgr) Notifee() inet.Notifiee
- func (_ NullConnMgr) Protect(peer.ID, string)
- func (_ NullConnMgr) TagPeer(peer.ID, string, int)
- func (_ NullConnMgr) TrimOpenConns(context.Context)
- func (_ NullConnMgr) Unprotect(peer.ID, string) bool
- func (_ NullConnMgr) UntagPeer(peer.ID, string)
- func (_ NullConnMgr) UpsertTag(peer.ID, string, func(int) int)
- type TagInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConnManager ¶
type ConnManager interface {
// TagPeer tags a peer with a string, associating a weight with the tag.
TagPeer(peer.ID, string, int)
// Untag removes the tagged value from the peer.
UntagPeer(p peer.ID, tag string)
// UpsertTag updates an existing tag or inserts a new one.
//
// The connection manager calls the upsert function supplying the current
// value of the tag (or zero if inexistent). The return value is used as
// the new value of the tag.
UpsertTag(p peer.ID, tag string, upsert func(int) int)
// GetTagInfo returns the metadata associated with the peer,
// or nil if no metadata has been recorded for the peer.
GetTagInfo(p peer.ID) *TagInfo
// TrimOpenConns terminates open connections based on an implementation-defined
// heuristic.
TrimOpenConns(ctx context.Context)
// Notifee returns an implementation that can be called back to inform of
// opened and closed connections.
Notifee() inet.Notifiee
// Protect protects a peer from having its connection(s) pruned.
//
// Tagging allows different parts of the system to manage protections without interfering with one another.
//
// Calls to Protect() with the same tag are idempotent. They are not refcounted, so after multiple calls
// to Protect() with the same tag, a single Unprotect() call bearing the same tag will revoke the protection.
Protect(id peer.ID, tag string)
// Unprotect removes a protection that may have been placed on a peer, under the specified tag.
//
// The return value indicates whether the peer continues to be protected after this call, by way of a different tag.
// See notes on Protect() for more info.
Unprotect(id peer.ID, tag string) (protected bool)
// Close closes the connection manager and stops background processes
Close() error
}
ConnManager tracks connections to peers, and allows consumers to associate metadata with each peer.
It enables connections to be trimmed based on implementation-defined heuristics.
type NullConnMgr ¶
type NullConnMgr struct{}
func (NullConnMgr) Close ¶ added in v0.0.5
func (_ NullConnMgr) Close() error
func (NullConnMgr) GetTagInfo ¶
func (_ NullConnMgr) GetTagInfo(peer.ID) *TagInfo
func (NullConnMgr) Notifee ¶
func (_ NullConnMgr) Notifee() inet.Notifiee
func (NullConnMgr) TrimOpenConns ¶
func (_ NullConnMgr) TrimOpenConns(context.Context)
Click to show internal directories.
Click to hide internal directories.