Documentation
¶
Index ¶
- Constants
- Variables
- type Announcement
- type AnnouncementType
- type Option
- type Pool
- func (p *Pool) Fetch(ctx context.Context, from peer.ID, l ipld.Link) error
- func (p *Pool) Has(ctx context.Context, l ipld.Link) (bool, error)
- func (p *Pool) Load(ctx context.Context, l ipld.Link, np ipld.NodePrototype) (ipld.Node, error)
- func (p *Pool) Shutdown(ctx context.Context) error
- func (p *Pool) Start(ctx context.Context) error
- func (p *Pool) Store(ctx context.Context, n ipld.Node) (ipld.Link, error)
Constants ¶
View Source
const Version0 = "0"
Variables ¶
View Source
var ( PubSubPrototypes struct { Announcement schema.TypedPrototype } )
Functions ¶
This section is empty.
Types ¶
type Announcement ¶
type Announcement struct {
Version string
Type AnnouncementType
Addrs []string
}
func (*Announcement) MarshalBinary ¶
func (a *Announcement) MarshalBinary() ([]byte, error)
func (*Announcement) SetAddrs ¶
func (a *Announcement) SetAddrs(ma ...multiaddr.Multiaddr)
func (*Announcement) UnmarshalBinary ¶
func (a *Announcement) UnmarshalBinary(b []byte) error
type AnnouncementType ¶
type AnnouncementType int
const ( UnknownAnnouncementType AnnouncementType = iota IExistAnnouncementType )
type Option ¶
type Option func(*options) error
func WithAnnounceInterval ¶
WithAnnounceInterval sets the interval at which announcements are made on the pubsub. Defaults to 5 seconds if unset.
func WithDatastore ¶ added in v0.4.8
func WithHost ¶
WithHost sets the libp2p host on which the pool is exposed. If unset a default host with random identity is used. See: libp2p.New.
func WithLinkSystem ¶ added in v0.4.8
func WithLinkSystem(ls *ipld.LinkSystem) Option
func WithPoolName ¶
WithPoolName sets a human readable name for the pool. Required.
func WithTopicName ¶
WithTopicName sets the name of the topic onto which announcements are made. Defaults to "/explore.fula/pools/<pool-name>" if unset. See: WithPoolName.
Source Files
Click to show internal directories.
Click to hide internal directories.