routing

Documentation

Index

• Constants
• type Bootstrapper
• type DNSBootstrapper
  • func NewDNSBootstrapper(host string, limit int) *DNSBootstrapper
  • func (b *DNSBootstrapper) Get(ctx context.Context) ([]peer.AddrInfo, error)
  • func (b *DNSBootstrapper) Run(ctx context.Context, id string) error
• type HTTPBootstrapper
  • func NewHTTPBootstrapper(addr, peer string) *HTTPBootstrapper
  • func (bs *HTTPBootstrapper) Get(ctx context.Context) ([]peer.AddrInfo, error)
  • func (bs *HTTPBootstrapper) Run(ctx context.Context, id string) error
• type KubernetesBootstrapper
  • func NewKubernetesBootstrapper(cs kubernetes.Interface, namespace, name string) *KubernetesBootstrapper
  • func (bs *KubernetesBootstrapper) Get(ctx context.Context) ([]peer.AddrInfo, error)
  • func (bs *KubernetesBootstrapper) Run(ctx context.Context, id string) error
• type MemoryRouter
  • func NewMemoryRouter(resolver map[string][]netip.AddrPort, self netip.AddrPort) *MemoryRouter
  • func (m *MemoryRouter) Add(key string, ap netip.AddrPort)
  • func (m *MemoryRouter) Advertise(ctx context.Context, keys []string) error
  • func (m *MemoryRouter) Lookup(key string) ([]netip.AddrPort, bool)
  • func (m *MemoryRouter) Ready(ctx context.Context) (bool, error)
  • func (m *MemoryRouter) Resolve(ctx context.Context, key string, allowSelf bool, count int) (<-chan netip.AddrPort, error)
• type P2PRouter
  • func NewP2PRouter(ctx context.Context, addr string, bs Bootstrapper, registryPortStr string, ...) (*P2PRouter, error)
  • func (r *P2PRouter) Advertise(ctx context.Context, keys []string) error
  • func (r *P2PRouter) Ready(ctx context.Context) (bool, error)
  • func (r *P2PRouter) Resolve(ctx context.Context, key string, allowSelf bool, count int) (<-chan netip.AddrPort, error)
  • func (r *P2PRouter) Run(ctx context.Context) error
• type Router
• type StaticBootstrapper
  • func NewStaticBootstrapper() *StaticBootstrapper
  • func (b *StaticBootstrapper) Get(ctx context.Context) ([]peer.AddrInfo, error)
  • func (b *StaticBootstrapper) Run(ctx context.Context, id string) error
  • func (b *StaticBootstrapper) SetPeers(peers []peer.AddrInfo)

Constants

const KeyTTL = 10 * time.Minute

Types

type Bootstrapper

type Bootstrapper interface {
	// Run starts the bootstrap process. Should be blocking even if not needed.
	Run(ctx context.Context, id string) error
	// Get returns a list of peers that should be used as bootstrap nodes.
	// If the peer ID is empty it will be resolved.
	// If the address is missing a port the P2P router port will be used.
	Get(ctx context.Context) ([]peer.AddrInfo, error)
}

Bootstrapper resolves peers to bootstrap with for the P2P router.

type DNSBootstrapper

type DNSBootstrapper struct {
	// contains filtered or unexported fields
}

func NewDNSBootstrapper

func NewDNSBootstrapper(host string, limit int) *DNSBootstrapper

func (*DNSBootstrapper) Get

func (b *DNSBootstrapper) Get(ctx context.Context) ([]peer.AddrInfo, error)

func (*DNSBootstrapper) Run

func (b *DNSBootstrapper) Run(ctx context.Context, id string) error

type HTTPBootstrapper

type HTTPBootstrapper struct {
	// contains filtered or unexported fields
}

func NewHTTPBootstrapper

func NewHTTPBootstrapper(addr, peer string) *HTTPBootstrapper

func (*HTTPBootstrapper) Get

func (bs *HTTPBootstrapper) Get(ctx context.Context) ([]peer.AddrInfo, error)

func (*HTTPBootstrapper) Run

func (bs *HTTPBootstrapper) Run(ctx context.Context, id string) error

type KubernetesBootstrapper

type KubernetesBootstrapper struct {
	// contains filtered or unexported fields
}

func NewKubernetesBootstrapper

func NewKubernetesBootstrapper(cs kubernetes.Interface, namespace, name string) *KubernetesBootstrapper

func (*KubernetesBootstrapper) Get

func (bs *KubernetesBootstrapper) Get(ctx context.Context) ([]peer.AddrInfo, error)

func (*KubernetesBootstrapper) Run

func (bs *KubernetesBootstrapper) Run(ctx context.Context, id string) error

type MemoryRouter

type MemoryRouter struct {
	// contains filtered or unexported fields
}

func NewMemoryRouter

func NewMemoryRouter(resolver map[string][]netip.AddrPort, self netip.AddrPort) *MemoryRouter

func (*MemoryRouter) Add

func (m *MemoryRouter) Add(key string, ap netip.AddrPort)

func (*MemoryRouter) Advertise

func (m *MemoryRouter) Advertise(ctx context.Context, keys []string) error

func (*MemoryRouter) Lookup

func (m *MemoryRouter) Lookup(key string) ([]netip.AddrPort, bool)

func (*MemoryRouter) Ready

func (m *MemoryRouter) Ready(ctx context.Context) (bool, error)

func (*MemoryRouter) Resolve

func (m *MemoryRouter) Resolve(ctx context.Context, key string, allowSelf bool, count int) (<-chan netip.AddrPort, error)

type P2PRouter

type P2PRouter struct {
	// contains filtered or unexported fields
}

func NewP2PRouter

func NewP2PRouter(ctx context.Context, addr string, bs Bootstrapper, registryPortStr string, opts ...libp2p.Option) (*P2PRouter, error)

func (*P2PRouter) Advertise

func (r *P2PRouter) Advertise(ctx context.Context, keys []string) error

func (*P2PRouter) Ready

func (r *P2PRouter) Ready(ctx context.Context) (bool, error)

func (*P2PRouter) Resolve

func (r *P2PRouter) Resolve(ctx context.Context, key string, allowSelf bool, count int) (<-chan netip.AddrPort, error)

func (*P2PRouter) Run

func (r *P2PRouter) Run(ctx context.Context) error

type Router

type Router interface {
	// Ready returns true when the router is ready.
	Ready(ctx context.Context) (bool, error)
	// Resolve asynchronously discovers addresses that can serve the content defined by the give key.
	Resolve(ctx context.Context, key string, allowSelf bool, count int) (<-chan netip.AddrPort, error)
	// Advertise broadcasts that the current router can serve the content.
	Advertise(ctx context.Context, keys []string) error
}

Router implements the discovery of content.

type StaticBootstrapper

type StaticBootstrapper struct {
	// contains filtered or unexported fields
}

func NewStaticBootstrapper

func NewStaticBootstrapper() *StaticBootstrapper

func (*StaticBootstrapper) Get

func (b *StaticBootstrapper) Get(ctx context.Context) ([]peer.AddrInfo, error)

func (*StaticBootstrapper) Run

func (b *StaticBootstrapper) Run(ctx context.Context, id string) error

func (*StaticBootstrapper) SetPeers

func (b *StaticBootstrapper) SetPeers(peers []peer.AddrInfo)