message

Documentation

Index

• type BitSwapMessage
  • func FromNet(r io.Reader) (BitSwapMessage, error)
  • func FromPBReader(pbr ggio.Reader) (BitSwapMessage, error)
  • func New(full bool) BitSwapMessage
• type Entry
• type Exportable

Types

type BitSwapMessage

type BitSwapMessage interface {
	// Wantlist returns a slice of unique keys that represent data wanted by
	// the sender.
	Wantlist() []Entry

	// Blocks returns a slice of unique blocks
	Blocks() []blocks.Block

	// AddEntry adds an entry to the Wantlist.
	AddEntry(key cid.Cid, priority int)

	Cancel(key cid.Cid)

	Empty() bool

	// A full wantlist is an authoritative copy, a 'non-full' wantlist is a patch-set
	Full() bool

	AddBlock(blocks.Block)
	Exportable

	Loggable() map[string]interface{}
}

func FromNet

func FromNet(r io.Reader) (BitSwapMessage, error)

func FromPBReader

func FromPBReader(pbr ggio.Reader) (BitSwapMessage, error)

func New

func New(full bool) BitSwapMessage

type Entry

type Entry struct {
	*wantlist.Entry
	Cancel bool
}

type Exportable

type Exportable interface {
	ToProtoV0() *pb.Message
	ToProtoV1() *pb.Message
	ToNetV0(w io.Writer) error
	ToNetV1(w io.Writer) error
}