message

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: May 6, 2020 License: Apache-2.0, MIT Imports: 11 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DataTransferMessage

type DataTransferMessage interface {
	IsRequest() bool
	TransferID() datatransfer.TransferID
	cborgen.CBORMarshaler
	cborgen.CBORUnmarshaler
	ToNet(w io.Writer) error
}

DataTransferMessage is a message for the data transfer protocol (either request or response) that can serialize to a protobuf

func FromNet

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

FromNet can read a network stream to deserialize a GraphSyncMessage

type DataTransferRequest

type DataTransferRequest interface {
	DataTransferMessage
	IsPull() bool
	VoucherType() datatransfer.TypeIdentifier
	Voucher(decoder encoding.Decoder) (encoding.Encodable, error)
	BaseCid() cid.Cid
	Selector() (ipld.Node, error)
	IsCancel() bool
}

DataTransferRequest is a response message for the data transfer protocol

func CancelRequest

CancelRequest request generates a request to cancel an in progress request

func NewRequest

func NewRequest(id datatransfer.TransferID, isPull bool, vtype datatransfer.TypeIdentifier, voucher encoding.Encodable, baseCid cid.Cid, selector ipld.Node) (DataTransferRequest, error)

NewRequest generates a new request for the data transfer protocol

type DataTransferResponse

type DataTransferResponse interface {
	DataTransferMessage
	Accepted() bool
}

DataTransferResponse is a response message for the data transfer protocol

func NewResponse

func NewResponse(id datatransfer.TransferID, accepted bool) DataTransferResponse

NewResponse builds a new Data Transfer response

Jump to

Keyboard shortcuts

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