syncthing/lib/discover/discover.go

51 lines
1.4 KiB
Go
Raw Normal View History

// Copyright (C) 2015 The Syncthing Authors.
2014-09-29 19:43:32 +00:00
//
2015-03-07 20:36:35 +00:00
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
// You can obtain one at https://mozilla.org/MPL/2.0/.
2014-06-01 20:50:14 +00:00
2013-12-15 10:43:31 +00:00
package discover
import (
"context"
2013-12-15 10:43:31 +00:00
"time"
2013-12-24 16:10:49 +00:00
2015-09-22 17:38:46 +00:00
"github.com/syncthing/syncthing/lib/protocol"
"github.com/thejerf/suture"
2013-12-15 10:43:31 +00:00
)
// A Finder provides lookup services of some kind.
type Finder interface {
Lookup(ctx context.Context, deviceID protocol.DeviceID) (address []string, err error)
Error() error
String() string
Cache() map[protocol.DeviceID]CacheEntry
2015-09-12 19:59:15 +00:00
}
type CacheEntry struct {
Addresses []string `json:"addresses"`
when time.Time // When did we get the result
found bool // Is it a success (cacheTime applies) or a failure (negCacheTime applies)?
validUntil time.Time // Validity time, overrides normal calculation
instanceID int64 // for local discovery, the instance ID (random on each restart)
}
// A FinderService is a Finder that has background activity and must be run as
// a suture.Service.
type FinderService interface {
Finder
suture.Service
2014-05-02 06:53:19 +00:00
}
type FinderMux interface {
Finder
ChildStatus() map[string]error
}
// The AddressLister answers questions about what addresses we are listening
// on.
type AddressLister interface {
ExternalAddresses() []string
AllAddresses() []string
}