nsopts

package
v0.11.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 25, 2023 License: MIT Imports: 1 Imported by: 32

Documentation

Index

Constants

View Source
const (
	// DefaultDepthLimit is the default depth limit used by Resolve.
	//
	// Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.DefaultDepthLimit
	DefaultDepthLimit = 32

	// UnlimitedDepth allows infinite recursion in Resolve.  You
	// probably don't want to use this, but it's here if you absolutely
	// trust resolution to eventually complete and can't put an upper
	// limit on how many steps it will take.
	//
	// Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.UnlimitedDepth
	UnlimitedDepth = 0

	// DefaultIPNSRecordTTL specifies the time that the record can be cached
	// before checking if its validity again.
	//
	// Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.DefaultIPNSRecordTTL
	DefaultIPNSRecordTTL = time.Minute

	// DefaultIPNSRecordEOL specifies the time that the network will cache IPNS
	// records after being published. Records should be re-published before this
	// interval expires. We use the same default expiration as the DHT.
	//
	// Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.DefaultIPNSRecordEOL
	DefaultIPNSRecordEOL = 48 * time.Hour
)

Variables

This section is empty.

Functions

This section is empty.

Types

type PublishOption deprecated added in v0.9.0

type PublishOption func(*PublishOptions)

PublishOption is used to set an option for PublishOpts.

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.PublishOption

func PublishWithEOL deprecated added in v0.9.0

func PublishWithEOL(eol time.Time) PublishOption

PublishWithEOL sets an EOL.

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.PublishWithEOL

func PublishWithTTL deprecated added in v0.9.0

func PublishWithTTL(ttl time.Duration) PublishOption

PublishWithEOL sets a TTL.

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.PublishWithTTL

type PublishOptions deprecated added in v0.9.0

type PublishOptions struct {
	EOL time.Time
	TTL time.Duration
}

PublishOptions specifies options for publishing an IPNS record.

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.PublishOptions

func DefaultPublishOptions deprecated added in v0.9.0

func DefaultPublishOptions() PublishOptions

DefaultPublishOptions returns the default options for publishing an IPNS record.

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.DefaultPublishOptions

func ProcessPublishOptions deprecated added in v0.9.0

func ProcessPublishOptions(opts []PublishOption) PublishOptions

ProcessPublishOptions converts an array of PublishOpt into a PublishOpts object.

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.ProcessPublishOptions

type ResolveOpt deprecated

type ResolveOpt func(*ResolveOpts)

ResolveOpt is used to set an option

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.ResolveOpt

func Depth deprecated

func Depth(depth uint) ResolveOpt

Depth is the recursion depth limit

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.Depth

func DhtRecordCount deprecated

func DhtRecordCount(count uint) ResolveOpt

DhtRecordCount is the number of IPNS records to retrieve from the DHT

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.DhtRecordCount

func DhtTimeout deprecated

func DhtTimeout(timeout time.Duration) ResolveOpt

DhtTimeout is the amount of time to wait for DHT records to be fetched and verified. A zero value indicates that there is no explicit timeout

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.DhtTimeout

type ResolveOpts deprecated

type ResolveOpts struct {
	// Recursion depth limit
	Depth uint
	// The number of IPNS records to retrieve from the DHT
	// (the best record is selected from this set)
	DhtRecordCount uint
	// The amount of time to wait for DHT records to be fetched
	// and verified. A zero value indicates that there is no explicit
	// timeout (although there is an implicit timeout due to dial
	// timeouts within the DHT)
	DhtTimeout time.Duration
}

ResolveOpts specifies options for resolving an IPNS path

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.ResolveOpts

func DefaultResolveOpts deprecated

func DefaultResolveOpts() ResolveOpts

DefaultResolveOpts returns the default options for resolving an IPNS path

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.DefaultResolveOpts

func ProcessOpts deprecated

func ProcessOpts(opts []ResolveOpt) ResolveOpts

ProcessOpts converts an array of ResolveOpt into a ResolveOpts object

Deprecated: use github.com/ipfs/boxo/coreiface/options/namesys.ProcessOpts

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL