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

routing

package

Go to main page

Versions in this module

v1

v1.12.5

Jul 13, 2026

v1.12.4

Jun 29, 2026

v1.12.3

Jun 23, 2026

v1.12.2

Jun 22, 2026

v1.12.1

Jun 21, 2026

v1.12.0

Jun 21, 2026

Changes in this version

+ const BeaconCacheFilename

+ const BeaconCacheMaxAge

+ const BeaconRefreshInterval

+ const BeaconRefreshJitter

+ const BlackholeMissesRequired

+ const DirectBlackholeThreshold

+ const DirectClearsRequired

+ const MaxRelayPeers

+ const SendErrThreshold

+ var ErrNoAddress = errors.New("routing: no address for peer")

+ func BeaconCachePath(identityPath string) string

+ func BeaconCacheSavedAt(identityPath string) (time.Time, error)

+ func DiscoverEndpoint(beaconAddr string, nodeID uint32, conn *net.UDPConn, readDeadline time.Time) (*net.UDPAddr, error)

+ func FetchBeaconList(client BeaconLister) ([]string, error)

+ func FilterUnreachable(addrs []string) []string

+ func FirstBeacon(s string) string

+ func InitialJitter() time.Duration

+ func IsUnreachableBeaconHost(host string) bool

+ func LoadBeaconCache(identityPath string) ([]string, error)

+ func MergeBeaconLists(bootstrap, discovered []string) []string

+ func ParseBeaconList(s string) []string

+ func PickBeacon(list []string, key []byte) string

+ func PickBeaconWithRTT(list []string, key []byte, rttMap map[string]time.Duration) string

+ func ProbeBeaconRTT(beaconAddr string, nodeID uint32, timeout time.Duration) (time.Duration, error)

+ func SaveBeaconCache(identityPath string, addrs []string) error

+ type BeaconCacheEntry struct

+ Addrs []string

+ SavedAt time.Time

+ type BeaconLister interface

+ Send func(msg map[string]interface{}) (map[string]interface{}, error)

+ type BeaconSelectionState struct

+ func NewBeaconSelectionState(bootstrap []string) *BeaconSelectionState

+ func (s *BeaconSelectionState) ApplyRefreshDecision(d RefreshDecision)

+ func (s *BeaconSelectionState) GetCurrentPick() string

+ type CounterTarget struct

+ BytesSent *uint64

+ PktsSent *uint64

+ type LocalNodeIDFn func() uint32

+ type Manager struct

+ func New() *Manager

+ func (m *Manager) AdmitRelayFromBeacon(peerNodeID uint32) bool

+ func (m *Manager) BeaconAddr() *net.UDPAddr

+ func (m *Manager) BlackholeMissCount(nodeID uint32) int

+ func (m *Manager) ClearRelayOnDirect(peerNodeID uint32, from *net.UDPAddr) bool

+ func (m *Manager) ClearSendErrCount(nodeID uint32)

+ func (m *Manager) ForceRelay() bool

+ func (m *Manager) HandlePunchCommand(data []byte)

+ func (m *Manager) HandleSendError(nodeID uint32, err error) (flipped bool, count int)

+ func (m *Manager) HasDirectRecv(nodeID uint32) bool

+ func (m *Manager) IsFromBeacon(from *net.UDPAddr) bool

+ func (m *Manager) IsRelayPeer(nodeID uint32) bool

+ func (m *Manager) IsRelayPinned(nodeID uint32) bool

+ func (m *Manager) LastDirectRecv(nodeID uint32) time.Time

+ func (m *Manager) LastOutboundSend(nodeID uint32) (time.Time, bool)

+ func (m *Manager) MarkRelayActivatedIfHadCrypto(srcNodeID uint32, hadCrypto bool) (admitted, newlyActivated, shouldAliasPeer bool)

+ func (m *Manager) MaybeFlipBlackhole(nodeID uint32) (shouldRelay, flipped bool, silentFor time.Duration, misses int)

+ func (m *Manager) RecordDirectRecv(nodeID uint32, t time.Time)

+ func (m *Manager) RecordOutboundSend(nodeID uint32, t time.Time)

+ func (m *Manager) RegisterWithBeacon() error

+ func (m *Manager) RelayPeerCount() int

+ func (m *Manager) RelayPeerIDs() []uint32

+ func (m *Manager) RemovePeer(nodeID uint32)

+ func (m *Manager) RequestHolePunch(targetNodeID uint32) error

+ func (m *Manager) SendErrCount(nodeID uint32) int

+ func (m *Manager) SendRelayFrame(nodeID uint32, frame []byte) error

+ func (m *Manager) SetBeaconAddr(addr string) error

+ func (m *Manager) SetBeaconAddrUDP(a *net.UDPAddr)

+ func (m *Manager) SetForceRelay(v bool)

+ func (m *Manager) SetLocalNodeIDFn(f LocalNodeIDFn)

+ func (m *Manager) SetRelayPeer(nodeID uint32, relay bool)

+ func (m *Manager) SetRelayPeerPinned(nodeID uint32, relay bool)

+ func (m *Manager) SetSocket(s SocketSender)

+ func (m *Manager) WriteFrame(nodeID uint32, addr *net.UDPAddr, frame []byte, counters CounterTarget) (SendOutcome, error)

+ type RefreshDecision struct

+ NewList []string

+ NewPick string

+ ShouldSwap bool

+ func ComputeRefreshDecision(state *BeaconSelectionState, discovered []string, identityKey []byte) RefreshDecision

+ type SendOutcome struct

+ BytesSent int

+ WasRelay bool

+ type SocketSender interface

+ Send func(frame []byte, dst *net.UDPAddr) (int, error)