package
0.15.4
Repository: https://github.com/ipni/index-provider.git
Documentation: pkg.go.dev

# Packages

Package chunker provides functionality for chunking ad entries generated from provider.MultihashIterator into an IPLD DAG.
Package peerutil provides utilities around peer ID values.
No description provided by the author
Package xproviders provides convinience classes for building and signing advertisements with ExtendedProviders, that implement extended providers specification.

# Functions

New creates a new index provider Engine as the default implementation of provider.Interface.
WithChainedEntries sets format of advertisement entries to chained Entry Chunk with the given chunkSize as the maximum number of multihashes per chunk.
WithDatastore sets the datastore that is used by the engine to store advertisements.
WithDirectAnnounce sets indexer URLs to send direct HTTP announcements to.
WithEntriesCacheCapacity sets the maximum number of advertisement entries DAG to cache.
WithExtraGossipData supplies extra data to include in the pubsub announcement.
WithHamtEntries sets format of advertisement entries to HAMT with the given hash algorithm, bit-width and bucket size.
WithHost specifies the host to which the provider engine belongs.
WithHttpPublisherAnnounceAddr sets the address to be supplied in announce messages to tell indexers where to retrieve advertisements.
WithHttpPublisherHandlerPath should only be used with WithHttpPublisherWithoutServer.
WithHttpPublisherListenAddr sets the net listen address for the HTTP publisher.
WithHttpPublisherWithoutServer sets the HTTP publisher to not start a server.
No description provided by the author
WithProvider sets the peer and addresses for the provider to put in indexing advertisements.
WithPublisherKind sets the kind of publisher used to serve advertisements.
WithPubsubAnnounce configures whether or not announcements are send via gossip pubsub.
WithPurgeCacheOnStart sets whether to clear any cached entries chunks when the provider engine starts.
WithRetrievalAddrs sets the addresses that specify where to get the content corresponding to an indexing advertisement.
WithStorageReadOpenerErrorHook allows the calling applicaiton to invoke a custom piece logic whenever a storage read opener error occurs.
No description provided by the author
WithTopic sets the pubsub topic on which new advertisements are announced.
WithTopicName sets the topic name on which pubsub announcements are published.

# Constants

Deprecated.
HttpPublisher exposes an HTTP server that serves advertisements using an HTTP server.
Libp2pHttpPublisher serves advertisements using both an HTTP server and engine's libp2p host.
Libp2pPublisher serves advertisements using the engine's libp2p host.
NoPublisher indicates that no announcements are made to the network and all advertisements are only stored locally.

# Variables

ErrEntriesLinkMismatch signals that the link generated from chunking the mulithashes returned by provider.MultihashLister does not match the previously generated link.

# Structs

Engine is an implementation of the core reference provider interface.

# Type aliases

No description provided by the author
No description provided by the author