site

package
v0.0.0-...-ac41614 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 9, 2022 License: MIT Imports: 7 Imported by: 12

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var EDecodeKey = errors.New("Unable to decode key in store")

Functions

This section is empty.

Types

type CloudNodeSitePool 

type CloudNodeSitePool struct {
	SiteFactory SiteFactory
	// contains filtered or unexported fields
}

func (*CloudNodeSitePool) Acquire 

func (cloudNodeSitePool *CloudNodeSitePool) Acquire(siteID string) Site

func (*CloudNodeSitePool) Add 

func (cloudNodeSitePool *CloudNodeSitePool) Add(siteID string)

func (*CloudNodeSitePool) Iterator 

func (cloudNodeSitePool *CloudNodeSitePool) Iterator() SitePoolIterator

func (*CloudNodeSitePool) LockReads 

func (cloudNodeSitePool *CloudNodeSitePool) LockReads()

func (*CloudNodeSitePool) LockWrites 

func (cloudNodeSitePool *CloudNodeSitePool) LockWrites()

func (*CloudNodeSitePool) Release 

func (cloudNodeSitePool *CloudNodeSitePool) Release(siteID string)

func (*CloudNodeSitePool) Remove 

func (cloudNodeSitePool *CloudNodeSitePool) Remove(siteID string)

func (*CloudNodeSitePool) UnlockReads 

func (cloudNodeSitePool *CloudNodeSitePool) UnlockReads()

func (*CloudNodeSitePool) UnlockWrites 

func (cloudNodeSitePool *CloudNodeSitePool) UnlockWrites()

type CloudSiteFactory 

type CloudSiteFactory struct {
	NodeID        string
	MerkleDepth   uint8
	StorageDriver StorageDriver
}

func (*CloudSiteFactory) CreateSite 

func (cloudSiteFactory *CloudSiteFactory) CreateSite(siteID string) Site

type CloudSiteIterator 

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

func (*CloudSiteIterator) Bucket 

func (cloudSiteIterator *CloudSiteIterator) Bucket() string

func (*CloudSiteIterator) Error 

func (cloudSiteIterator *CloudSiteIterator) Error() error

func (*CloudSiteIterator) Key 

func (cloudSiteIterator *CloudSiteIterator) Key() string

func (*CloudSiteIterator) Next 

func (cloudSiteIterator *CloudSiteIterator) Next() bool

func (*CloudSiteIterator) Release 

func (cloudSiteIterator *CloudSiteIterator) Release()

func (*CloudSiteIterator) Value 

func (cloudSiteIterator *CloudSiteIterator) Value() *SiblingSet

type CloudSitePoolterator 

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

func (*CloudSitePoolterator) Bucket 

func (cloudSitePoolIterator *CloudSitePoolterator) Bucket() string

func (*CloudSitePoolterator) Error 

func (cloudSitePoolIterator *CloudSitePoolterator) Error() error

func (*CloudSitePoolterator) Key 

func (cloudSitePoolIterator *CloudSitePoolterator) Key() string

func (*CloudSitePoolterator) Next 

func (cloudSitePoolIterator *CloudSitePoolterator) Next() bool

func (*CloudSitePoolterator) Release 

func (cloudSitePoolIterator *CloudSitePoolterator) Release()

func (*CloudSitePoolterator) Site 

func (cloudSitePoolIterator *CloudSitePoolterator) Site() string

func (*CloudSitePoolterator) Value 

func (cloudSitePoolIterator *CloudSitePoolterator) Value() *SiblingSet

type CloudSiteReplica 

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

func (*CloudSiteReplica) Buckets 

func (cloudSiteReplica *CloudSiteReplica) Buckets() *BucketList

func (*CloudSiteReplica) ID 

func (cloudSiteReplica *CloudSiteReplica) ID() string

func (*CloudSiteReplica) Iterator 

func (cloudSiteReplica *CloudSiteReplica) Iterator() SiteIterator

func (*CloudSiteReplica) LockReads 

func (cloudSiteReplica *CloudSiteReplica) LockReads()

func (*CloudSiteReplica) LockWrites 

func (cloudSiteReplica *CloudSiteReplica) LockWrites()

func (*CloudSiteReplica) UnlockReads 

func (cloudSiteReplica *CloudSiteReplica) UnlockReads()

func (*CloudSiteReplica) UnlockWrites 

func (cloudSiteReplica *CloudSiteReplica) UnlockWrites()

type RelayNodeSitePool 

type RelayNodeSitePool struct {
	Site Site
}

A relay only ever contains one site database

func (*RelayNodeSitePool) Acquire 

func (relayNodeSitePool *RelayNodeSitePool) Acquire(siteID string) Site

func (*RelayNodeSitePool) Add 

func (relayNodeSitePool *RelayNodeSitePool) Add(siteID string)

func (*RelayNodeSitePool) Iterator 

func (relayNodeSitePool *RelayNodeSitePool) Iterator() SitePoolIterator

func (*RelayNodeSitePool) LockReads 

func (relayNodeSitePool *RelayNodeSitePool) LockReads()

func (*RelayNodeSitePool) LockWrites 

func (relayNodeSitePool *RelayNodeSitePool) LockWrites()

func (*RelayNodeSitePool) Release 

func (relayNodeSitePool *RelayNodeSitePool) Release(siteID string)

func (*RelayNodeSitePool) Remove 

func (relayNodeSitePool *RelayNodeSitePool) Remove(siteID string)

func (*RelayNodeSitePool) UnlockReads 

func (relayNodeSitePool *RelayNodeSitePool) UnlockReads()

func (*RelayNodeSitePool) UnlockWrites 

func (relayNodeSitePool *RelayNodeSitePool) UnlockWrites()

type RelaySiteFactory 

type RelaySiteFactory struct {
	MerkleDepth   uint8
	StorageDriver StorageDriver
	RelayID       string
}

func (*RelaySiteFactory) CreateSite 

func (relaySiteFactory *RelaySiteFactory) CreateSite(siteID string) Site

type RelaySiteIterator 

type RelaySiteIterator struct {
}

func (*RelaySiteIterator) Bucket 

func (relaySiteIterator *RelaySiteIterator) Bucket() string

func (*RelaySiteIterator) Error 

func (relaySiteIterator *RelaySiteIterator) Error() error

func (*RelaySiteIterator) Key 

func (relaySiteIterator *RelaySiteIterator) Key() string

func (*RelaySiteIterator) Next 

func (relaySiteIterator *RelaySiteIterator) Next() bool

func (*RelaySiteIterator) Release 

func (relaySiteIterator *RelaySiteIterator) Release()

func (*RelaySiteIterator) Value 

func (relaySiteIterator *RelaySiteIterator) Value() *SiblingSet

type RelaySitePoolIterator 

type RelaySitePoolIterator struct {
}

func (*RelaySitePoolIterator) Bucket 

func (relaySitePoolIterator *RelaySitePoolIterator) Bucket() string

func (*RelaySitePoolIterator) Error 

func (relaySitePoolIterator *RelaySitePoolIterator) Error() error

func (*RelaySitePoolIterator) Key 

func (relaySitePoolIterator *RelaySitePoolIterator) Key() string

func (*RelaySitePoolIterator) Next 

func (relaySitePoolIterator *RelaySitePoolIterator) Next() bool

func (*RelaySitePoolIterator) Release 

func (relaySitePoolIterator *RelaySitePoolIterator) Release()

func (*RelaySitePoolIterator) Site 

func (relaySitePoolIterator *RelaySitePoolIterator) Site() string

func (*RelaySitePoolIterator) Value 

func (relaySitePoolIterator *RelaySitePoolIterator) Value() *SiblingSet

type RelaySiteReplica 

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

func NewRelaySiteReplica 

func NewRelaySiteReplica(id string, buckets *BucketList) *RelaySiteReplica

func (*RelaySiteReplica) Buckets 

func (relaySiteReplica *RelaySiteReplica) Buckets() *BucketList

func (*RelaySiteReplica) ID 

func (relaySiteReplica *RelaySiteReplica) ID() string

func (*RelaySiteReplica) Iterator 

func (relaySiteReplica *RelaySiteReplica) Iterator() SiteIterator

func (*RelaySiteReplica) LockReads 

func (relaySiteReplica *RelaySiteReplica) LockReads()

func (*RelaySiteReplica) LockWrites 

func (relaySiteReplica *RelaySiteReplica) LockWrites()

func (*RelaySiteReplica) UnlockReads 

func (relaySiteReplica *RelaySiteReplica) UnlockReads()

func (*RelaySiteReplica) UnlockWrites 

func (relaySiteReplica *RelaySiteReplica) UnlockWrites()

type Site 

type Site interface {
	Buckets() *BucketList
	Iterator() SiteIterator
	ID() string
	LockWrites()
	UnlockWrites()
	LockReads()
	UnlockReads()
}

type SiteFactory 

type SiteFactory interface {
	CreateSite(siteID string) Site
}

type SiteIterator 

type SiteIterator interface {
	Next() bool
	// The site that the current entry belongs to
	Bucket() string
	// The key of the current entry
	Key() string
	// The value of the current entry
	Value() *SiblingSet
	// The checksum of the current entry
	Release()
	Error() error
}

type SitePool 

type SitePool interface {
	// Called when client needs to access site. This does not guaruntee
	// exclusive access it merely ensures that the site pool does not
	// dispose of the underlying site
	Acquire(siteID string) Site
	// Called when client no longer needs access to a site
	Release(siteID string)
	// Call when a site should be added to the pool
	Add(siteID string)
	// Called when a site should be removed from the pool
	Remove(siteID string)
	// Iterate over all sites that exist in the site pool
	Iterator() SitePoolIterator
	// Ensure no new writes can occur to any sites in this site pool
	LockWrites()
	// Ensure writes can occur to sites in this site pool
	UnlockWrites()
	// Ensure no new reads can occur from any sites in this site pool
	LockReads()
	// Ensure reads can occur from sites in this site pool
	UnlockReads()
}

type SitePoolIterator 

type SitePoolIterator interface {
	Next() bool
	// The site that the current entry belongs to
	Site() string
	// The bucket that the current entry belongs to within its site
	Bucket() string
	// The key of the current entry
	Key() string
	// The value of the current entry
	Value() *SiblingSet
	// The checksum of the current entry
	Release()
	Error() error
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.