usedserials

Documentation

Index

• Constants
• Variables
• type Full
  • func (a Full) Less(b Full) bool
• type Partial
  • func (a Partial) Less(b Partial) bool
• type Table
  • func NewTable(maxMemory memory.Size) *Table
  • func (table *Table) Add(ctx context.Context, satelliteID storj.NodeID, serialNumber storj.SerialNumber, ...) (err error)
  • func (table *Table) Count() int
  • func (table *Table) DeleteExpired(ctx context.Context, now time.Time)
  • func (table *Table) Exists(satelliteID storj.NodeID, serialNumber storj.SerialNumber, ...) bool

Constants

const (
	// PartialSize is the size of a partial serial number.
	PartialSize = memory.Size(len(Partial{}))
	// FullSize is the size of a full serial number.
	FullSize = memory.Size(len(storj.SerialNumber{}))
)

Variables

var (
	// ErrSerials defines the usedserials store error class.
	ErrSerials = errs.Class("usedserials")
	// ErrSerialAlreadyExists defines an error class for duplicate usedserials.
	ErrSerialAlreadyExists = errs.Class("used serial already exists in store")
)

Types

type Full

type Full storj.SerialNumber

Full is a copy of the SerialNumber type. It is necessary so we can define a Less function on it.

func (Full) Less

func (a Full) Less(b Full) bool

Less returns true if partial serial a is less than partial serial b and false otherwise.

type Partial

type Partial [8]byte

Partial represents the last 8 bytes of a serial number. It is used when the first 8 are based on the expiration date.

func (Partial) Less

func (a Partial) Less(b Partial) bool

Less returns true if partial serial a is less than partial serial b and false otherwise.

type Table

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

Table is an in-memory store for serial numbers.

func NewTable

func NewTable(maxMemory memory.Size) *Table

NewTable creates and returns a new usedserials in-memory store.

func (*Table) Add

func (table *Table) Add(ctx context.Context, satelliteID storj.NodeID, serialNumber storj.SerialNumber, expiration time.Time) (err error)

Add adds a serial to the store, or returns an error if the serial number was already added. It randomly deletes items from the store if the set maxMemory is exceeded.

func (*Table) Count

func (table *Table) Count() int

Count iterates over all the items in the table and returns the number.

func (*Table) DeleteExpired

func (table *Table) DeleteExpired(ctx context.Context, now time.Time)

DeleteExpired deletes expired serial numbers if their expiration hour has passed.

func (*Table) Exists

func (table *Table) Exists(satelliteID storj.NodeID, serialNumber storj.SerialNumber, expiration time.Time) bool

Exists determines whether a serial number exists in the table.