exchange

Documentation

Overview

Package exchange defines the IPFS exchange interface

Index

• type Fetcher
• type Interface
• type SessionExchange

Types

type Fetcher

type Fetcher interface {
	// GetBlock returns the block associated with a given key.
	GetBlock(context.Context, *cid.Cid) (blocks.Block, error)
	GetBlocks(context.Context, []*cid.Cid) (<-chan blocks.Block, error)
}

Fetcher is an object that can be used to retrieve blocks

type Interface

type Interface interface {
	Fetcher

	// TODO Should callers be concerned with whether the block was made
	// available on the network?
	HasBlock(blocks.Block) error

	IsOnline() bool

	io.Closer
}

Interface defines the functionality of the IPFS block exchange protocol.

type SessionExchange

type SessionExchange interface {
	Interface
	NewSession(context.Context) Interface
}

SessionExchange is an exchange.Interface which supports sessions.