pathdb

Documentation

Index

• type PathDB

Types

type PathDB

type PathDB interface {
	// Insert inserts or updates a path segment. It returns the number of path segments
	// that have been inserted/updated.
	Insert(context.Context, *seg.PathSegment, []proto.PathSegType) (int, error)
	// InsertWithHPCfgIDs inserts or updates a path segment with a set of HPCfgIDs. It
	// returns the number of path segments that have been inserted/updated.
	InsertWithHPCfgIDs(context.Context, *seg.PathSegment, []proto.PathSegType, []*query.HPCfgID) (
		int, error)
	// Delete deletes all path segments that matches the given query,
	// returning the number of deleted segments
	Delete(context.Context, *query.Params) (int, error)
	// DeleteExpired deletes all paths segments that are expired, using now as a reference.
	// Returns the number of deleted segments.
	DeleteExpired(ctx context.Context, now time.Time) (int, error)
	// Get returns all path segment(s) matching the parameters specified.
	Get(context.Context, *query.Params) ([]*query.Result, error)
	// InsertNextQuery inserts or updates the timestamp nextQuery for the given dst.
	InsertNextQuery(ctx context.Context, dst addr.IA, nextQuery time.Time) (bool, error)
	// GetNextQuery returns the nextQuery timestamp for the given dst,
	// or nil if it hasn't been queried.
	GetNextQuery(ctx context.Context, dst addr.IA) (*time.Time, error)
}

PathDB defines the interface that all PathDB backends have to implement.