stores

Documentation

Overview

stores registers constructors for OrbitDB stores

Index

• Variables
• type EventLoad
  • func NewEventLoad(addr address.Address, heads []ipfslog.Entry) EventLoad
• type EventLoadProgress
  • func NewEventLoadProgress(addr address.Address, h cid.Cid, e ipfslog.Entry, progress, max int) EventLoadProgress
• type EventNewPeer
  • func NewEventNewPeer(p peer.ID) EventNewPeer
• type EventReady
  • func NewEventReady(addr address.Address, heads []ipfslog.Entry) EventReady
• type EventReplicate
  • func NewEventReplicate(addr address.Address, c cid.Cid) EventReplicate
• type EventReplicateProgress
  • func NewEventReplicateProgress(addr address.Address, h cid.Cid, e ipfslog.Entry, ...) EventReplicateProgress
• type EventReplicated
  • func NewEventReplicated(addr address.Address, entries []ipfslog.Entry, logLength int) EventReplicated
• type EventWrite
  • func NewEventWrite(addr address.Address, e ipfslog.Entry, heads []ipfslog.Entry) EventWrite

Variables

var Events = []interface{}{
	new(EventWrite),
	new(EventReady),
	new(EventReplicateProgress),
	new(EventLoad),
	new(EventReplicated),
	new(EventReplicate),
}

Types

type EventLoad

type EventLoad struct {
	Address address.Address
	Heads   []ipfslog.Entry
}

EventLoad An event sent when data has been loaded

func NewEventLoad

func NewEventLoad(addr address.Address, heads []ipfslog.Entry) EventLoad

NewEventLoad Creates a new EventLoad event

type EventLoadProgress

type EventLoadProgress struct {
	Address address.Address
	Hash    cid.Cid
	Entry   ipfslog.Entry
	// contains filtered or unexported fields
}

func NewEventLoadProgress

func NewEventLoadProgress(addr address.Address, h cid.Cid, e ipfslog.Entry, progress, max int) EventLoadProgress

type EventNewPeer

type EventNewPeer struct {
	Peer peer.ID
}

EventNewPeer An event sent when a new peer is discovered on the pubsub channel

func NewEventNewPeer

func NewEventNewPeer(p peer.ID) EventNewPeer

NewEventNewPeer Creates a new EventNewPeer event

type EventReady

type EventReady struct {
	Address address.Address
	Heads   []ipfslog.Entry
}

EventReady An event sent when the store is ready

func NewEventReady

func NewEventReady(addr address.Address, heads []ipfslog.Entry) EventReady

NewEventReady Creates a new EventReady event

type EventReplicate

type EventReplicate struct {
	Address address.Address
	Hash    cid.Cid
}

func NewEventReplicate

func NewEventReplicate(addr address.Address, c cid.Cid) EventReplicate

type EventReplicateProgress

type EventReplicateProgress struct {
	Max               int
	Progress          int
	Address           address.Address
	Hash              cid.Cid
	Entry             ipfslog.Entry
	ReplicationStatus replicator.ReplicationInfo
}

EventReplicateProgress An event containing the current replication progress.

func NewEventReplicateProgress

func NewEventReplicateProgress(addr address.Address, h cid.Cid, e ipfslog.Entry, replicationStatus replicator.ReplicationInfo) EventReplicateProgress

NewEventReplicateProgress Creates a new EventReplicateProgress event

type EventReplicated

type EventReplicated struct {
	Address   address.Address
	LogLength int
	Entries   []ipfslog.Entry
}

EventReplicated An event sent when data has been replicated

func NewEventReplicated

func NewEventReplicated(addr address.Address, entries []ipfslog.Entry, logLength int) EventReplicated

NewEventReplicated Creates a new EventReplicated event

type EventWrite

type EventWrite struct {
	Address address.Address
	Entry   ipfslog.Entry
	Heads   []ipfslog.Entry
}

EventWrite An event sent when something has been written

func NewEventWrite

func NewEventWrite(addr address.Address, e ipfslog.Entry, heads []ipfslog.Entry) EventWrite

NewEventWrite Creates a new EventWrite event