linkstore

Documentation

Index

• type Opt
  • func WithPendingRecordLifespan(value time.Duration) Opt
• type Store
  • func New(provider storage.Provider, expiryService dataExpiryService, opts ...Opt) (*Store, error)
  • func (s *Store) DeleteLinks(links []*url.URL) error
  • func (s *Store) DeletePendingLinks(links []*url.URL) error
  • func (s *Store) GetLinks(anchorHash string) ([]*url.URL, error)
  • func (s *Store) GetProcessedAndPendingLinks(anchorHash string) ([]*url.URL, error)
  • func (s *Store) HandleExpiredKeys(keys ...string) ([]string, error)
  • func (s *Store) PutLinks(links []*url.URL) error
  • func (s *Store) PutPendingLinks(links []*url.URL) error

Types

type Opt

type Opt func(opts *options)

Opt is a link store option.

func WithPendingRecordLifespan

func WithPendingRecordLifespan(value time.Duration) Opt

WithPendingRecordLifespan sets the lifespan of an anchor reference in PENDING state, after which it will be deleted.

type Store

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

Store is implements an anchor link store.

func New

func New(provider storage.Provider, expiryService dataExpiryService, opts ...Opt) (*Store, error)

New creates a new anchor link store.

func (*Store) DeleteLinks

func (s *Store) DeleteLinks(links []*url.URL) error

DeleteLinks deletes the given hash links.

func (*Store) DeletePendingLinks

func (s *Store) DeletePendingLinks(links []*url.URL) error

DeletePendingLinks deletes the given hash links if they are in PENDING status.

func (*Store) GetLinks

func (s *Store) GetLinks(anchorHash string) ([]*url.URL, error)

GetLinks returns the links for the given anchor hash.

func (*Store) GetProcessedAndPendingLinks

func (s *Store) GetProcessedAndPendingLinks(anchorHash string) ([]*url.URL, error)

GetProcessedAndPendingLinks returns the links for the given anchor hash, including all pending links.

func (*Store) HandleExpiredKeys

func (s *Store) HandleExpiredKeys(keys ...string) ([]string, error)

HandleExpiredKeys is invoked by the data expiration handler.

func (*Store) PutLinks

func (s *Store) PutLinks(links []*url.URL) error

PutLinks stores the given hash links.

func (*Store) PutPendingLinks

func (s *Store) PutPendingLinks(links []*url.URL) error

PutPendingLinks stores the given hash links with the status of PENDING. These links are yet to be processed. Once they are processed, their status will be updated to processed.