Documentation
¶
Overview ¶
baseorbitdb package containing the base implementation of OrbitDB
Index ¶
Constants ¶
const CBORReadDefaultTimeout = time.Second * 30
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseOrbitDB ¶
type BaseOrbitDB = iface.BaseOrbitDB
OrbitDB An alias of the type defined in the iface package
func NewOrbitDB ¶
func NewOrbitDB(ctx context.Context, ipfs coreiface.CoreAPI, options *NewOrbitDBOptions) (BaseOrbitDB, error)
NewOrbitDB Creates a new OrbitDB instance
type CreateDBOptions ¶
type CreateDBOptions = iface.CreateDBOptions
CreateDBOptions An alias of the type defined in the iface package
type DetermineAddressOptions ¶
type DetermineAddressOptions = iface.DetermineAddressOptions
DetermineAddressOptions An alias of the type defined in the iface package
type DirectChannelFactory ¶ added in v1.7.0
type DirectChannelFactory = iface.DirectChannelFactory
DirectChannelFactory An alias of the type defined in the iface package
type EventExchangeHeads ¶ added in v1.16.0
type EventExchangeHeads struct {
Peer peer.ID
Message *iface.MessageExchangeHeads
}
func NewEventExchangeHeads ¶ added in v1.16.0
func NewEventExchangeHeads(p peer.ID, msg *iface.MessageExchangeHeads) EventExchangeHeads
type EventLogStore ¶
type EventLogStore = iface.EventLogStore
EventLogStore An alias of the type defined in the iface package
type IndexConstructor ¶
type IndexConstructor = iface.IndexConstructor
IndexConstructor An alias of the type defined in the iface package
type KeyValueStore ¶
type KeyValueStore = iface.KeyValueStore
KeyValueStore An alias of the type defined in the iface package
type NewOrbitDBOptions ¶
type NewOrbitDBOptions struct {
ID *string
PeerID peer.ID
Directory *string
Keystore keystore.Interface
Cache cache.Interface
Identity *idp.Identity
CloseKeystore func() error
Logger *zap.Logger
Tracer trace.Tracer
DirectChannelFactory iface.DirectChannelFactory
PubSub iface.PubSubInterface
MessageMarshaler iface.MessageMarshaler
EventBus event.Bus
}
NewOrbitDBOptions Options for a new OrbitDB instance
type OnWritePrototype ¶
type OnWritePrototype = iface.OnWritePrototype
OnWritePrototype An alias of the type defined in the iface package
type StoreConstructor ¶
type StoreConstructor = iface.StoreConstructor
StoreConstructor An alias of the type defined in the iface package
type StoreIndex ¶
type StoreIndex = iface.StoreIndex
StoreIndex An alias of the type defined in the iface package
type StreamOptions ¶
type StreamOptions = iface.StreamOptions
StreamOptions An alias of the type defined in the iface package