exchange

package module
v0.2.1 Latest Latest
Warning

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

 Go to latest Published: Oct 26, 2021 License: MIT Imports: 3 Imported by: 2

README

go-ipfs-exchange-interface

standard-readme compliant GoDoc Build Status

go-ipfs-exchange-interface defines the IPFS exchange interface

Lead Maintainer

Steven Allen

Table of Contents

Install

go-ipfs-exchange-interface works like a regular Go module:

> go get github.com/ipfs/go-ipfs-exchange-interface

Usage

import "github.com/ipfs/go-ipfs-exchange-interface"

Check the GoDoc documentation

Contribute

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © Protocol Labs, Inc.

Documentation

Overview

Package exchange defines the IPFS exchange interface

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Fetcher 

type Fetcher interface {
	// GetBlock returns the block associated with a given key.
	GetBlock(context.Context, auth.Want) (auth.AuthBlock, error)
	GetBlocks(context.Context, []auth.Want) (<-chan auth.AuthBlock, 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(auth.AuthBlock) error

	IsOnline() bool

	io.Closer
}

Interface defines the functionality of the IPFS block exchange protocol.

type SessionExchange 

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

SessionExchange is an exchange.Interface which supports sessions.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.