discover

Documentation

Overview

Package discover implements the node discovery protocol.

Index

• Constants
• Variables
• type Address
  • func (o *Address) DecodeXDR(r io.Reader) error
  • func (o Address) EncodeXDR(w io.Writer) (int, error)
  • func (o Address) MarshalXDR() []byte
  • func (o *Address) UnmarshalXDR(bs []byte) error
• type AnnounceV2
  • func (o *AnnounceV2) DecodeXDR(r io.Reader) error
  • func (o AnnounceV2) EncodeXDR(w io.Writer) (int, error)
  • func (o AnnounceV2) MarshalXDR() []byte
  • func (o *AnnounceV2) UnmarshalXDR(bs []byte) error
• type Discoverer
  • func NewDiscoverer(id string, addresses []string) (*Discoverer, error)
  • func (d *Discoverer) All() map[string][]string
  • func (d *Discoverer) ExtAnnounceOK() bool
  • func (d *Discoverer) Hint(node string, addrs []string)
  • func (d *Discoverer) Lookup(node string) []string
  • func (d *Discoverer) StartGlobal(server string, extPort uint16)
  • func (d *Discoverer) StartLocal()
• type Node
  • func (o *Node) DecodeXDR(r io.Reader) error
  • func (o Node) EncodeXDR(w io.Writer) (int, error)
  • func (o Node) MarshalXDR() []byte
  • func (o *Node) UnmarshalXDR(bs []byte) error
• type QueryV2
  • func (o *QueryV2) DecodeXDR(r io.Reader) error
  • func (o QueryV2) EncodeXDR(w io.Writer) (int, error)
  • func (o QueryV2) MarshalXDR() []byte
  • func (o *QueryV2) UnmarshalXDR(bs []byte) error

Constants

const (
	AnnouncementMagicV2 = 0x029E4C77
	QueryMagicV2        = 0x23D63A9A
)

const (
	AnnouncementPort = 21025
)

Variables

var (
	ErrIncorrectMagic = errors.New("incorrect magic number")
)

Types

type Address

type Address struct {
	IP   []byte // max:16
	Port uint16
}

func (*Address) DecodeXDR

func (o *Address) DecodeXDR(r io.Reader) error

func (Address) EncodeXDR

func (o Address) EncodeXDR(w io.Writer) (int, error)

func (Address) MarshalXDR

func (o Address) MarshalXDR() []byte

func (*Address) UnmarshalXDR

func (o *Address) UnmarshalXDR(bs []byte) error

type AnnounceV2

type AnnounceV2 struct {
	Magic uint32
	This  Node
	Extra []Node // max:16
}

func (*AnnounceV2) DecodeXDR

func (o *AnnounceV2) DecodeXDR(r io.Reader) error

func (AnnounceV2) EncodeXDR

func (o AnnounceV2) EncodeXDR(w io.Writer) (int, error)

func (AnnounceV2) MarshalXDR

func (o AnnounceV2) MarshalXDR() []byte

func (*AnnounceV2) UnmarshalXDR

func (o *AnnounceV2) UnmarshalXDR(bs []byte) error

type Discoverer

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

func NewDiscoverer

func NewDiscoverer(id string, addresses []string) (*Discoverer, error)

func (*Discoverer) All

func (d *Discoverer) All() map[string][]string

func (*Discoverer) ExtAnnounceOK

func (d *Discoverer) ExtAnnounceOK() bool

func (*Discoverer) Hint

func (d *Discoverer) Hint(node string, addrs []string)

func (*Discoverer) Lookup

func (d *Discoverer) Lookup(node string) []string

func (*Discoverer) StartGlobal

func (d *Discoverer) StartGlobal(server string, extPort uint16)

func (*Discoverer) StartLocal

func (d *Discoverer) StartLocal()

type Node

type Node struct {
	ID        string    // max:64
	Addresses []Address // max:16
}

func (*Node) DecodeXDR

func (o *Node) DecodeXDR(r io.Reader) error

func (Node) EncodeXDR

func (o Node) EncodeXDR(w io.Writer) (int, error)

func (Node) MarshalXDR

func (o Node) MarshalXDR() []byte

func (*Node) UnmarshalXDR

func (o *Node) UnmarshalXDR(bs []byte) error

type QueryV2

type QueryV2 struct {
	Magic  uint32
	NodeID string // max:64
}

func (*QueryV2) DecodeXDR

func (o *QueryV2) DecodeXDR(r io.Reader) error

func (QueryV2) EncodeXDR

func (o QueryV2) EncodeXDR(w io.Writer) (int, error)

func (QueryV2) MarshalXDR

func (o QueryV2) MarshalXDR() []byte

func (*QueryV2) UnmarshalXDR

func (o *QueryV2) UnmarshalXDR(bs []byte) error