shared

Documentation

Index

• Constants
• func AllSelector() ipld.Node
• func IsCtxDone(err error) bool
• func MoveKey(ds datastore.Datastore, old string, new string) error
• func NewInflatorReader(readSeeker io.ReadSeeker, payloadSize uint64, targetSize abi.UnpaddedPieceSize) (*inflatorReader, error)
• func ReadyDispatcher(evt pubsub.Event, fn pubsub.SubscriberFn) error
• type ReadSeekStarter
• type ReadyFunc
• type ReadyManager
  • func NewReadyManager() *ReadyManager
  • func (m *ReadyManager) AwaitReady() error
  • func (m *ReadyManager) FireReady(err error) error
  • func (m *ReadyManager) OnReady(ready ReadyFunc)
• type RetryStream
  • func NewRetryStream(opener StreamOpener, options ...RetryStreamOption) *RetryStream
  • func (impl *RetryStream) OpenStream(ctx context.Context, id peer.ID, protocols []protocol.ID) (network.Stream, error)
  • func (impl *RetryStream) SetOptions(options ...RetryStreamOption)
• type RetryStreamOption
  • func RetryParameters(minDuration time.Duration, maxDuration time.Duration, attempts float64, ...) RetryStreamOption
• type StreamOpener
• type TimeCounter
  • func NewTimeCounter() *TimeCounter
  • func (tc *TimeCounter) Next() uint64
• type TipSetToken
• type Unsubscribe

Constants

const CloseDataTransferTimeout = 30 * time.Second

When we close the data transfer, we also send a cancel message to the peer. CloseDataTransferTimeout is the amount of time to wait for the close to complete before giving up.

Functions

func AllSelector

func AllSelector() ipld.Node

Deprecated: AllSelector is a compatibility alias for an entire DAG non-matching-selector. Use github.com/ipld/go-ipld-prime/traversal/selector/parse.CommonSelector_ExploreAllRecursively instead.

func IsCtxDone

func IsCtxDone(err error) bool

func MoveKey

func MoveKey(ds datastore.Datastore, old string, new string) error

MoveKey moves a key in a data store

func NewInflatorReader

func NewInflatorReader(readSeeker io.ReadSeeker, payloadSize uint64, targetSize abi.UnpaddedPieceSize) (*inflatorReader, error)

func ReadyDispatcher

func ReadyDispatcher(evt pubsub.Event, fn pubsub.SubscriberFn) error

ReadyDispatcher is just an pubsub dispatcher where the callback is ReadyFunc

Types

type ReadSeekStarter

type ReadSeekStarter interface {
	io.Reader
	SeekStart() error
}

ReadSeekStarter implements io.Reader and allows the caller to seek to the start of the reader

type ReadyFunc

type ReadyFunc func(error)

ReadyFunc is function that gets called once when an event is ready

type ReadyManager

type ReadyManager struct {
	Stop context.CancelFunc
	// contains filtered or unexported fields
}

ReadyManager managers listeners for a ready event

func NewReadyManager

func NewReadyManager() *ReadyManager

func (*ReadyManager) AwaitReady

func (m *ReadyManager) AwaitReady() error

AwaitReady blocks until the ready event fires. Returns immediately if the event already fired.

func (*ReadyManager) FireReady

func (m *ReadyManager) FireReady(err error) error

FireReady is called when the ready event occurs

func (*ReadyManager) OnReady

func (m *ReadyManager) OnReady(ready ReadyFunc)

OnReady registers a listener for the ready event. If the event has already been fired, the callback is immediately called back (in a go-routine).

type RetryStream

type RetryStream struct {
	// contains filtered or unexported fields
}

func NewRetryStream

func NewRetryStream(opener StreamOpener, options ...RetryStreamOption) *RetryStream

func (*RetryStream) OpenStream

func (impl *RetryStream) OpenStream(ctx context.Context, id peer.ID, protocols []protocol.ID) (network.Stream, error)

func (*RetryStream) SetOptions

func (impl *RetryStream) SetOptions(options ...RetryStreamOption)

type RetryStreamOption

type RetryStreamOption func(*RetryStream)

func RetryParameters

func RetryParameters(minDuration time.Duration, maxDuration time.Duration, attempts float64, backoffFactor float64) RetryStreamOption

RetryParameters changes the default parameters around connection reopening

type StreamOpener

type StreamOpener interface {
	NewStream(ctx context.Context, p peer.ID, pids ...protocol.ID) (network.Stream, error)
}

type TimeCounter

type TimeCounter struct {
	// contains filtered or unexported fields
}

timeCounter is used to generate a monotonically increasing sequence. It starts at the current time, then increments on each call to next.

func NewTimeCounter

func NewTimeCounter() *TimeCounter

func (*TimeCounter) Next

func (tc *TimeCounter) Next() uint64

type TipSetToken

type TipSetToken []byte

TipSetToken is the implementation-nonspecific identity for a tipset.

type Unsubscribe

type Unsubscribe func()

Unsubscribe is a function that gets called to unsubscribe from (storage|retrieval)market events