storage

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

type ErrDuplicateClientID struct {
	// ClientID is the client ID that is used multiple times
	ClientID string

	// IP may hold the IP address used by the client
	IP net.IP
}

type ErrDuplicateIP struct {
	// IP holds the IP address that is used multiple times
	IP net.IP

	// ClientID may hold the ID of the client that has the IP assigned
	ClientID string
}

type ErrIPNotFound struct {
	IP net.IP
}

type Factory func(args map[string][]string) (LeaseStorage, error)

type LeaseStorage interface {
	// Create stores a unique IP address lease.
	// Implementation MUST check that  IP and client
	// are not already used inside the database
	Create(ctx context.Context, ip net.IP, clientID string, leased bool, expiration time.Time) error

	// Delete deletes an IP lease from the database.
	// If clientID is not empty, implementations should
	// check if the lease to be removed is for the same clientID
	Delete(ctx context.Context, ip net.IP, clientID string) error

	// Update updates `leased` and `expiration` of an
	// existing IP lease. The operation should only be performed
	// if clientID matches the stored one.
	Update(ctx context.Context, ip net.IP, clientID string, leased bool, expiration time.Time) error

	// FindByIP searches for an IP lease for the given IP
	FindByIP(ctx context.Context, ip net.IP) (clientID string, leased bool, expiration time.Time, err error)

	// FindByID searches for an IP lease for the given client ID
	FindByID(ctx context.Context, clientID string) (ip net.IP, leased bool, expiration time.Time, err error)

	// ListIPs returns a list of IPs that are available in the storage
	ListIPs(ctx context.Context) ([]net.IP, error)

	// ListIDs returns a list of client IDs that are available in the storage
	ListIDs(ctx context.Context) ([]string, error)
}