datatransfer

package module

Go to main page

Versions in this module

v1

v1.15.4-boost

Mar 27, 2023

v1.15.3

Jan 7, 2023

v1.15.2

Jun 21, 2022

v1.15.1

Mar 30, 2022

v1.15.0

Mar 9, 2022

Changes in this version

type Message

+ ToIPLD func() (datamodel.Node, error)

v1.14.1

Mar 2, 2022

v1.14.0

Jan 19, 2022

v1.14.0-rc1

Jan 19, 2022

v1.13.0

Jan 14, 2022

Changes in this version

type ChannelState

+ MissingCids func() []cid.Cid

+ QueuedCidsTotal func() int64

+ SentCidsTotal func() int64

type EventCode

+ const CIDMissing

+ const CleanupCompletePartial

type EventsHandler

+ OnLinkMissing func(chid ChannelID, link ipld.Link) error

type Status

+ const PartiallyCompleted

v1.12.1

Dec 22, 2021

Changes in this version

type EventsHandler

+ OnContextAugment func(chid ChannelID) func(context.Context) context.Context

v1.12.0

Dec 9, 2021

v1.11.7

Dec 9, 2021

v1.11.6

Nov 17, 2021

v1.11.5

Oct 27, 2021

v1.11.4

Oct 19, 2021

Changes in this version

type EventCode

+ const Opened

v1.11.3

Oct 14, 2021

v1.11.2

Oct 6, 2021

v1.11.1

Oct 5, 2021

v1.11.0

Oct 4, 2021

Changes in this version

+ var ProtocolDataTransfer1_2 protocol.ID = "/fil/datatransfer/1.2.0"

type ChannelState

+ ReceivedCidsTotal func() int64

v1.11.0-rc1

Oct 4, 2021

v1.10.1

Sep 7, 2021

v1.10.0

Sep 3, 2021

v1.9.0

Sep 2, 2021

v1.8.0

Sep 1, 2021

v1.7.8

Aug 27, 2021

v1.7.7

Aug 24, 2021

v1.7.6

Aug 23, 2021

v1.7.5

Aug 19, 2021

v1.7.4

Aug 18, 2021

v1.7.3

Aug 6, 2021

Changes in this version

type EventCode

+ const RequestCancelled

type EventsHandler

+ OnRequestCancelled func(chid ChannelID, err error) error

v1.7.2

Jul 29, 2021

v1.7.1

Jul 28, 2021

v1.7.0

Jun 10, 2021

Changes in this version

type EventCode

+ const TransferRequestQueued

type EventsHandler

+ OnTransferQueued func(chid ChannelID)

v1.6.1

Jun 8, 2021

Changes in this version

type ChannelState

+ ReceivedCidsLen func() int

v1.6.0

Jun 1, 2021

v1.6.0-rc1

Jun 1, 2021

v1.5.0

May 6, 2021

Changes in this version

type EventCode

+ const ReceiveDataError

type EventsHandler

+ OnReceiveDataError func(chid ChannelID, err error) error

v1.4.3

Apr 2, 2021

v1.4.2

Apr 2, 2021

v1.4.1

Mar 30, 2021

Changes in this version

+ type ChannelStage struct

+ CreatedTime cbg.CborTime

+ Description string

+ Logs []*Log

+ Name string

+ UpdatedTime cbg.CborTime

+ func (t *ChannelStage) MarshalCBOR(w io.Writer) error

+ func (t *ChannelStage) UnmarshalCBOR(r io.Reader) error

+ type ChannelStages struct

+ Stages []*ChannelStage

+ func (cs *ChannelStages) AddLog(stage, msg string)

+ func (cs *ChannelStages) GetStage(stage string) *ChannelStage

+ func (t *ChannelStages) MarshalCBOR(w io.Writer) error

+ func (t *ChannelStages) UnmarshalCBOR(r io.Reader) error

type ChannelState

+ Stages func() *ChannelStages

+ type Log struct

+ Log string

+ UpdatedTime cbg.CborTime

+ func (t *Log) MarshalCBOR(w io.Writer) error

+ func (t *Log) UnmarshalCBOR(r io.Reader) error

v1.4.0

Mar 24, 2021

v1.3.0

Mar 23, 2021

v1.2.9

Mar 22, 2021

Changes in this version

type EventCode

+ const RequestTimedOut

+ const SendDataError

type EventsHandler

+ OnSendDataError func(chid ChannelID, err error) error

v1.2.8

Feb 1, 2021

Changes in this version

type EventCode

+ const DataQueuedProgress

+ const DataReceivedProgress

+ const DataSentProgress

v1.2.7

Jan 19, 2021

v1.2.6

Jan 14, 2021

v1.2.5

Dec 18, 2020

v1.2.4

Dec 16, 2020

v1.2.3

Dec 8, 2020

Changes in this version

type Manager

+ ChannelState func(ctx context.Context, chid ChannelID) (ChannelState, error)

v1.2.2

Dec 1, 2020

v1.2.1

Nov 30, 2020

v1.2.0

Nov 17, 2020

v1.1.0

Nov 12, 2020

v1.0.1

Nov 10, 2020

Changes in this version

type Transport

+ Shutdown func(ctx context.Context) error

v1.0.0

Oct 29, 2020

Changes in this version

type ChannelState

+ Queued func() uint64

+ ReceivedCids func() []cid.Cid

type EventCode

+ const DataQueued

type EventsHandler

+ OnDataQueued func(chid ChannelID, link ipld.Link, size uint64) (Message, error)

v0

v0.9.0

Oct 14, 2020

Changes in this version

+ const ErrDisconnected

+ const ErrRemoved

+ var ProtocolDataTransfer1_0 protocol.ID = "/fil/datatransfer/1.0.0"

+ var ProtocolDataTransfer1_1 protocol.ID = "/fil/datatransfer/1.1.0"

type Channel

+ OtherPeer func() peer.ID

+ ReceivedCids func() []cid.Cid

type ChannelState

+ SelfPeer func() peer.ID

type EventCode

+ const CompleteCleanupOnRestart

+ const DataReceived

+ const DataSent

+ const Disconnected

+ const Restart

type EventsHandler

+ OnRequestDisconnected func(ctx context.Context, chid ChannelID) error

+ OnRequestTimedOut func(ctx context.Context, chid ChannelID) error

type Manager

+ OnReady func(ReadyFunc)

+ RestartDataTransferChannel func(ctx context.Context, chid ChannelID) error

type Message

+ IsRestart func() bool

+ MessageForProtocol func(targetProtocol protocol.ID) (newMsg Message, err error)

+ type ReadyFunc func(error)

type Request

+ IsRestartExistingChannelRequest func() bool

+ RestartChannelId func() (ChannelID, error)

v0.6.7

Sep 30, 2020

Changes in this version

+ const ErrIncomplete

+ const ErrRejected

+ const ErrUnsupported

v0.6.6

Sep 25, 2020

v0.6.5

Sep 23, 2020

v0.6.4

Sep 17, 2020

v0.6.3

Aug 29, 2020

v0.6.2

Aug 21, 2020

v0.6.1

Aug 13, 2020

v0.6.0

Aug 11, 2020

v0.5.3

Aug 4, 2020

v0.5.2

Jul 31, 2020

v0.5.1

Jul 27, 2020

Changes in this version

+ const ErrHandlerAlreadySet

+ const ErrHandlerNotSet

+ const ErrResume

+ type EventsHandler interface

+ OnChannelCompleted func(chid ChannelID, success bool) error

+ OnChannelOpened func(chid ChannelID) error

+ OnDataReceived func(chid ChannelID, link ipld.Link, size uint64) error

+ OnDataSent func(chid ChannelID, link ipld.Link, size uint64) (Message, error)

+ OnRequestReceived func(chid ChannelID, msg Request) (Response, error)

+ OnResponseReceived func(chid ChannelID, msg Response) error

type Manager

+ RegisterTransportConfigurer func(voucherType Voucher, configurer TransportConfigurer) error

+ type Message interface

+ IsCancel func() bool

+ IsNew func() bool

+ IsPaused func() bool

+ IsRequest func() bool

+ IsUpdate func() bool

+ ToNet func(w io.Writer) error

+ TransferID func() TransferID

+ type PauseableTransport interface

+ PauseChannel func(ctx context.Context, chid ChannelID) error

+ ResumeChannel func(ctx context.Context, msg Message, chid ChannelID) error

+ type Request interface

+ BaseCid func() cid.Cid

+ IsPull func() bool

+ IsVoucher func() bool

+ Selector func() (ipld.Node, error)

+ Voucher func(decoder encoding.Decoder) (encoding.Encodable, error)

+ VoucherType func() TypeIdentifier

+ type Response interface

+ Accepted func() bool

+ EmptyVoucherResult func() bool

+ IsComplete func() bool

+ IsVoucherResult func() bool

+ VoucherResult func(decoder encoding.Decoder) (encoding.Encodable, error)

+ VoucherResultType func() TypeIdentifier

+ type Transport interface

+ CleanupChannel func(chid ChannelID)

+ CloseChannel func(ctx context.Context, chid ChannelID) error

+ OpenChannel func(ctx context.Context, dataSender peer.ID, channelID ChannelID, root ipld.Link, ...) error

+ SetEventHandler func(events EventsHandler) error

+ type TransportConfigurer func(chid ChannelID, voucher Voucher, transport Transport)

v0.5.0

Jul 15, 2020

Changes in this version

type Channel

+ ChannelID func() ChannelID

type ChannelID

+ func (t *ChannelID) MarshalCBOR(w io.Writer) error

+ func (t *ChannelID) UnmarshalCBOR(r io.Reader) error

v0.4.0

Jul 8, 2020

Changes in this version

+ const EmptyTypeIdentifier

+ const ErrChannelNotFound

+ const ErrPause

+ var ErrRetryValidation = errors.New("Retry Revalidation")

+ var Events = map[EventCode]string

+ var Statuses = map[Status]string

type Channel

+ IsPull func(initiator peer.ID) bool

+ OtherParty func(thisParty peer.ID) peer.ID

type ChannelID

+ Responder peer.ID

+ func (c ChannelID) OtherParty(thisPeer peer.ID) peer.ID

+ func (c ChannelID) String() string

type ChannelState

+ LastVoucher func() Voucher

+ LastVoucherResult func() VoucherResult

+ Message func() string

+ Status func() Status

+ VoucherResults func() []VoucherResult

+ Vouchers func() []Voucher

type EventCode

+ const Accept

+ const BeginFinalizing

+ const Cancel

+ const CleanupComplete

+ const FinishTransfer

+ const NewVoucher

+ const NewVoucherResult

+ const PauseInitiator

+ const PauseResponder

+ const ResponderBeginsFinalization

+ const ResponderCompletes

+ const ResumeInitiator

+ const ResumeResponder

type Manager

+ PauseDataTransferChannel func(ctx context.Context, chid ChannelID) error

+ RegisterRevalidator func(voucherType Voucher, revalidator Revalidator) error

+ RegisterVoucherResultType func(resultType VoucherResult) error

+ ResumeDataTransferChannel func(ctx context.Context, chid ChannelID) error

+ SendVoucher func(ctx context.Context, chid ChannelID, voucher Voucher) error

+ Start func(ctx context.Context) error

+ Stop func() error

+ type Revalidator interface

+ OnComplete func(chid ChannelID) (VoucherResult, error)

+ OnPullDataSent func(chid ChannelID, additionalBytesSent uint64) (VoucherResult, error)

+ OnPushDataReceived func(chid ChannelID, additionalBytesReceived uint64) (VoucherResult, error)

+ Revalidate func(channelID ChannelID, voucher Voucher) (VoucherResult, error)

type Status

+ const BothPaused

+ const Cancelled

+ const Cancelling

+ const Completing

+ const Failing

+ const Finalizing

+ const InitiatorPaused

+ const Requested

+ const ResponderCompleted

+ const ResponderFinalizing

+ const ResponderFinalizingTransferFinished

+ const ResponderPaused

+ const TransferFinished

+ type VoucherResult Registerable

v0.3.0

May 6, 2020

Changes in this version

+ type Registerable interface

+ Type func() TypeIdentifier

+ type TypeIdentifier string

v0.2.1

May 4, 2020

v0.2.0

Apr 29, 2020

Changes in this version

+ var EmptyChannelState = ChannelState

+ type Channel struct

+ func NewChannel(transferID TransferID, baseCid cid.Cid, selector ipld.Node, voucher Voucher, ...) Channel

+ func (c Channel) BaseCID() cid.Cid

+ func (c Channel) Recipient() peer.ID

+ func (c Channel) Selector() ipld.Node

+ func (c Channel) Sender() peer.ID

+ func (c Channel) TotalSize() uint64

+ func (c Channel) TransferID() TransferID

+ func (c Channel) Voucher() Voucher

+ type ChannelID struct

+ ID TransferID

+ Initiator peer.ID

+ type ChannelState struct

+ func (c ChannelState) Received() uint64

+ func (c ChannelState) Sent() uint64

+ type Event struct

+ Code EventCode

+ Message string

+ Timestamp time.Time

+ type EventCode int

+ const Complete

+ const Error

+ const Open

+ const Progress

+ type Manager interface

+ CloseDataTransferChannel func(x ChannelID)

+ InProgressChannels func() map[ChannelID]ChannelState

+ OpenPullDataChannel func(ctx context.Context, to peer.ID, voucher Voucher, baseCid cid.Cid, ...) (ChannelID, error)

+ OpenPushDataChannel func(ctx context.Context, to peer.ID, voucher Voucher, baseCid cid.Cid, ...) (ChannelID, error)

+ RegisterVoucherType func(voucherType reflect.Type, validator RequestValidator) error

+ SubscribeToEvents func(subscriber Subscriber) Unsubscribe

+ TransferChannelStatus func(x ChannelID) Status

+ type RequestValidator interface

+ ValidatePull func(receiver peer.ID, voucher Voucher, baseCid cid.Cid, selector ipld.Node) error

+ ValidatePush func(sender peer.ID, voucher Voucher, baseCid cid.Cid, selector ipld.Node) error

+ type Status int

+ const ChannelNotFoundError

+ const Completed

+ const Failed

+ const Ongoing

+ type Subscriber func(event Event, channelState ChannelState)

+ type TransferID uint64

+ type Unsubscribe func()

+ type Voucher interface

+ FromBytes func([]byte) error

+ ToBytes func() ([]byte, error)

+ Type func() string

Other modules containing this package

github.com/filecoin-project/go-data-transfer/v2

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