storage

Documentation

Index

• type CBORStorage
  • func NewCBORStorage(baseDir string, now time.Time) (*CBORStorage, error)
  • func (bs *CBORStorage) AddKnown(known []KnownPeer) error
  • func (bs *CBORStorage) AddSuspended(suspended []SuspendedPeer) error
  • func (bs *CBORStorage) DeleteKnown(known []KnownPeer) error
  • func (bs *CBORStorage) DeleteSuspendedByIP(suspended []SuspendedPeer) error
  • func (bs *CBORStorage) DropKnown() error
  • func (bs *CBORStorage) DropStorage() error
  • func (bs *CBORStorage) DropSuspended() error
  • func (bs *CBORStorage) IsSuspendedIP(ip IP, now time.Time) bool
  • func (bs *CBORStorage) IsSuspendedIPs(ips []IP, now time.Time) []bool
  • func (bs *CBORStorage) Known() []KnownPeer
  • func (bs *CBORStorage) RefreshSuspended(now time.Time) error
  • func (bs *CBORStorage) Suspended(now time.Time) []SuspendedPeer
• type IP
  • func IPFromString(s string) IP
  • func IpFromIpPort(ipPort proto.IpPort) IP
  • func (i *IP) String() string
• type KnownPeer
  • func (kp *KnownPeer) IP() IP
  • func (kp *KnownPeer) IpPort() proto.IpPort
  • func (kp *KnownPeer) String() string
• type SuspendedPeer
  • func (sp *SuspendedPeer) AwakeTime() time.Time
  • func (sp *SuspendedPeer) IsSuspended(now time.Time) bool
  • func (sp *SuspendedPeer) SuspendTime() time.Time

Types

type CBORStorage

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

func NewCBORStorage

func NewCBORStorage(baseDir string, now time.Time) (*CBORStorage, error)

func (*CBORStorage) AddKnown

func (bs *CBORStorage) AddKnown(known []KnownPeer) error

AddKnown adds known peers into peers storage with strong error guarantees.

func (*CBORStorage) AddSuspended

func (bs *CBORStorage) AddSuspended(suspended []SuspendedPeer) error

AddSuspended adds suspended peers into peers storage with strong error guarantees.

func (*CBORStorage) DeleteKnown

func (bs *CBORStorage) DeleteKnown(known []KnownPeer) error

DeleteKnown removes known peers from peers storage with strong error guarantees.

func (*CBORStorage) DeleteSuspendedByIP

func (bs *CBORStorage) DeleteSuspendedByIP(suspended []SuspendedPeer) error

DeleteSuspendedByIP removes suspended peers from peers storage with strong error guarantees. Note, that only IP field in input parameter will be used.

func (*CBORStorage) DropKnown

func (bs *CBORStorage) DropKnown() error

DropKnown clear known in memory cache and truncates known peers storage file with strong error guarantee.

func (*CBORStorage) DropStorage

func (bs *CBORStorage) DropStorage() error

DropStorage clear storage memory cache and truncates storage files. In case of error we can loose suspended peers storage file, but honestly it's almost impossible case.

func (*CBORStorage) DropSuspended

func (bs *CBORStorage) DropSuspended() error

DropSuspended clear suspended in memory cache and truncates suspended peers storage file with strong error guarantee.

func (*CBORStorage) IsSuspendedIP

func (bs *CBORStorage) IsSuspendedIP(ip IP, now time.Time) bool

func (*CBORStorage) IsSuspendedIPs

func (bs *CBORStorage) IsSuspendedIPs(ips []IP, now time.Time) []bool

func (*CBORStorage) Known

func (bs *CBORStorage) Known() []KnownPeer

func (*CBORStorage) RefreshSuspended

func (bs *CBORStorage) RefreshSuspended(now time.Time) error

RefreshSuspended removes expired peers from suspended peers storage with strong error guarantee.

func (*CBORStorage) Suspended

func (bs *CBORStorage) Suspended(now time.Time) []SuspendedPeer

type IP

type IP [net.IPv6len]byte

func IPFromString

func IPFromString(s string) IP

func IpFromIpPort

func IpFromIpPort(ipPort proto.IpPort) IP

func (*IP) String

func (i *IP) String() string

type KnownPeer

type KnownPeer proto.IpPort

func (*KnownPeer) IP

func (kp *KnownPeer) IP() IP

func (*KnownPeer) IpPort

func (kp *KnownPeer) IpPort() proto.IpPort

func (*KnownPeer) String

func (kp *KnownPeer) String() string

type SuspendedPeer

type SuspendedPeer struct {
	IP                     IP            `cbor:"0,keyasint,omitemtpy"`
	SuspendTimestampMillis int64         `cbor:"1,keyasint,omitemtpy"`
	SuspendDuration        time.Duration `cbor:"2,keyasint,omitemtpy"`
	Reason                 string        `cbor:"3,keyasint,omitemtpy"`
}

func (*SuspendedPeer) AwakeTime

func (sp *SuspendedPeer) AwakeTime() time.Time

func (*SuspendedPeer) IsSuspended

func (sp *SuspendedPeer) IsSuspended(now time.Time) bool

func (*SuspendedPeer) SuspendTime

func (sp *SuspendedPeer) SuspendTime() time.Time