itopo

type Callbacks struct {
	// CleanDynamic is called whenever dynamic topology is dropped due to expiration.
	CleanDynamic func()
	// DropDynamic is called whenever dynamic topology is dropped due to static update.
	DropDynamic func()
	// UpdateStatic is called whenever the pointer to static topology is updated.
	UpdateStatic func()
}

type ProviderI interface {
	Get() Topology
}

type ServiceType string

type Topology interface {
	// IA returns the local ISD-AS number.
	IA() addr.IA
	// MTU returns the MTU of the local AS.
	MTU() uint16
	// Core returns whether the local AS is core.
	Core() bool
	// InterfaceIDs returns all interface IDS from the local AS.
	InterfaceIDs() []common.IFIDType

	// PublicAddress gets the public address of a server with the requested type and name, and nil
	// if no such server exists.
	//
	// FIXME(scrye): See whether this or its snet variant below can be removed.
	PublicAddress(svc addr.HostSVC, name string) *addr.AppAddr
	// SPublicAddress gets the public address of a server with the requested type and name, and nil
	// if no such server exists.
	//
	// FIXME(scrye): See whether this or its app variant above can be removed.
	SPublicAddress(svc addr.HostSVC, name string) *snet.Addr

	// Exists returns true if the service and name are present in the topology file.
	Exists(svc addr.HostSVC, name string) bool

	// BindAddress gets the bind address of a server with the requested type and name, and nil
	// if no such server exists.
	//
	// FIXME(scrye): See whether this or its snet variant below can be removed.
	BindAddress(svc addr.HostSVC, name string) *addr.AppAddr
	// BindAddress gets the bind address of a server with the requested type and name, and nil
	// if no such server exists.
	//
	// FIXME(scrye): See whether this or its app variant above can be removed.
	SBindAddress(svc addr.HostSVC, name string) *snet.Addr

	// SBRAddress returns the internal public address of the BR with the specified name.
	SBRAddress(name string) *snet.Addr

	// OverlayAnycast returns the overlay address for an arbitrary server of the requested type.
	OverlayAnycast(svc addr.HostSVC) (*overlay.OverlayAddr, error)
	// OverlayMulticast returns all overlay addresses for the requested type.
	OverlayMulticast(svc addr.HostSVC) ([]*overlay.OverlayAddr, error)
	// OverlayByName returns the overlay address of the server name of the requested type.
	//
	// FIXME(scrye): This isn't really needed. We should also get rid of it.
	OverlayByName(svc addr.HostSVC, name string) (*overlay.OverlayAddr, error)
	// OverlayNextHop2 returns the internal overlay address of the router containing the ID. The
	// return value is encoded as an overlay address.
	//
	// FIXME(scrye): Remove either this or the other method. A single return type should be
	// supported.
	OverlayNextHop2(ifID common.IFIDType) (*overlay.OverlayAddr, bool)

	// OverlayNextHop returns the internal overlay address of the router containing the interface
	// ID. The return value is encoded as a SCIOND host info struct.
	//
	// XXX(scrye): Return value is a shallow copy.
	OverlayNextHop(ifID common.IFIDType) (hostinfo.Host, bool)

	// MakeHostInfos returns the overlay addresses of all services for the specified service type.
	//
	// XXX(scrye): The return values are shallow copies.
	MakeHostInfos(st proto.ServiceType) []hostinfo.Host

	// BR returns information for a specific border router
	//
	// FIXME(scrye): Simplify return type and make it topology format agnostic.
	//
	// XXX(scrye): Return value is a shallow copy.
	BR(name string) (topology.BRInfo, bool)
	// IFInfoMap returns the mapping between interface IDs an internal addresses.
	//
	// FIXME(scrye): Simplify return type and make it topology format agnostic.
	//
	// XXX(scrye): Return value is a shallow copy.
	IFInfoMap() topology.IfInfoMap

	// BRNames returns the names of all BRs in the topology.
	//
	// FIXME(scrye): Remove this, callers shouldn't care about names.
	//
	// XXX(scrye): Return value is a shallow copy.
	BRNames() []string

	// SVCNames returns the names of all servers in the topology for the specified service.
	//
	// FIXME(scrye): Remove this, callers shouldn't care about names.
	//
	// XXX(scrye): Return value is a shallow copy.
	SVCNames(svc addr.HostSVC) []string

	// Raw returns a pointer to the underlying topology object. This is included for legacy
	// reasons and should never be used.
	//
	// FIXME(scrye): Remove this.
	//
	// XXX(scrye): Return value is a shallow copy.
	Raw() *topology.Topo
	// Overlay returns the overlay running in the current AS.
	//
	// FIXME(scrye): Remove this.
	Overlay() overlay.Type

	// DS returns the discovery servers in the topology.
	//
	// FIXME(scrye): Simplify return type and make it topology format agnostic.
	//
	// XXX(scrye): Return value is a shallow copy.
	DS() topology.IDAddrMap
}

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