discover

Documentation

Overview

Package discover implements the device discovery protocol.

Index

• Constants
• Variables
• type Address
  • func (o Address) AppendXDR(bs []byte) ([]byte, error)
  • func (o *Address) DecodeXDR(r io.Reader) error
  • func (o Address) EncodeXDR(w io.Writer) (int, error)
  • func (o Address) MarshalXDR() ([]byte, error)
  • func (o Address) MustMarshalXDR() []byte
  • func (o *Address) UnmarshalXDR(bs []byte) error
• type Announce
  • func (o Announce) AppendXDR(bs []byte) ([]byte, error)
  • func (o *Announce) DecodeXDR(r io.Reader) error
  • func (o Announce) EncodeXDR(w io.Writer) (int, error)
  • func (o Announce) MarshalXDR() ([]byte, error)
  • func (o Announce) MustMarshalXDR() []byte
  • func (o *Announce) UnmarshalXDR(bs []byte) error
• type CacheEntry
• type Device
  • func (o Device) AppendXDR(bs []byte) ([]byte, error)
  • func (o *Device) DecodeXDR(r io.Reader) error
  • func (o Device) EncodeXDR(w io.Writer) (int, error)
  • func (o Device) MarshalXDR() ([]byte, error)
  • func (o Device) MustMarshalXDR() []byte
  • func (o *Device) UnmarshalXDR(bs []byte) error
• type Discoverer
  • func NewDiscoverer(id protocol.DeviceID, addresses []string) *Discoverer
  • func (d *Discoverer) All() map[protocol.DeviceID][]CacheEntry
  • func (d *Discoverer) ExtAnnounceOK() bool
  • func (d *Discoverer) Hint(device string, addrs []string)
  • func (d *Discoverer) Lookup(device protocol.DeviceID) []string
  • func (d *Discoverer) StartGlobal(server string, extPort uint16)
  • func (d *Discoverer) StartLocal(localPort int, localMCAddr string)
  • func (d *Discoverer) StopGlobal()
• type Query
  • func (o Query) AppendXDR(bs []byte) ([]byte, error)
  • func (o *Query) DecodeXDR(r io.Reader) error
  • func (o Query) EncodeXDR(w io.Writer) (int, error)
  • func (o Query) MarshalXDR() ([]byte, error)
  • func (o Query) MustMarshalXDR() []byte
  • func (o *Query) UnmarshalXDR(bs []byte) error

Constants

const (
	AnnouncementMagic = 0x9D79BC39
	QueryMagic        = 0x2CA856F5
)

Variables

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

Types

type Address

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

func (Address) AppendXDR

func (o Address) AppendXDR(bs []byte) ([]byte, error)

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, error)

func (Address) MustMarshalXDR

func (o Address) MustMarshalXDR() []byte

func (*Address) UnmarshalXDR

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

type Announce

type Announce struct {
	Magic uint32
	This  Device
	Extra []Device // max:16
}

func (Announce) AppendXDR

func (o Announce) AppendXDR(bs []byte) ([]byte, error)

func (*Announce) DecodeXDR

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

func (Announce) EncodeXDR

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

func (Announce) MarshalXDR

func (o Announce) MarshalXDR() ([]byte, error)

func (Announce) MustMarshalXDR

func (o Announce) MustMarshalXDR() []byte

func (*Announce) UnmarshalXDR

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

type CacheEntry

type CacheEntry struct {
	Address string
	Seen    time.Time
}

type Device

type Device struct {
	ID        []byte    // max:32
	Addresses []Address // max:16
}

func (Device) AppendXDR

func (o Device) AppendXDR(bs []byte) ([]byte, error)

func (*Device) DecodeXDR

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

func (Device) EncodeXDR

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

func (Device) MarshalXDR

func (o Device) MarshalXDR() ([]byte, error)

func (Device) MustMarshalXDR

func (o Device) MustMarshalXDR() []byte

func (*Device) UnmarshalXDR

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

type Discoverer

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

func NewDiscoverer

func NewDiscoverer(id protocol.DeviceID, addresses []string) *Discoverer

func (*Discoverer) All

func (d *Discoverer) All() map[protocol.DeviceID][]CacheEntry

func (*Discoverer) ExtAnnounceOK

func (d *Discoverer) ExtAnnounceOK() bool

func (*Discoverer) Hint

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

func (*Discoverer) Lookup

func (d *Discoverer) Lookup(device protocol.DeviceID) []string

func (*Discoverer) StartGlobal

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

func (*Discoverer) StartLocal

func (d *Discoverer) StartLocal(localPort int, localMCAddr string)

func (*Discoverer) StopGlobal

func (d *Discoverer) StopGlobal()

type Query

type Query struct {
	Magic    uint32
	DeviceID []byte // max:32
}

func (Query) AppendXDR

func (o Query) AppendXDR(bs []byte) ([]byte, error)

func (*Query) DecodeXDR

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

func (Query) EncodeXDR

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

func (Query) MarshalXDR

func (o Query) MarshalXDR() ([]byte, error)

func (Query) MustMarshalXDR

func (o Query) MustMarshalXDR() []byte

func (*Query) UnmarshalXDR

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