exchange

Documentation

Index

• Variables
• type Event
• type EventData
• type Exchange
• type ExchangeMux
  • func DefaultMux() *ExchangeMux
  • func (e *ExchangeMux) Add(ctx context.Context, tr *planning.TransportRequest) error
  • func (e *ExchangeMux) Register(ex Exchange) error
  • func (e *ExchangeMux) Subscribe() chan MuxEvent
• type MuxEvent
• type State

Variables

var ErrUnknownCodec = errors.New("unknown codec")

Types

type Event

type Event int

const (
	StartEvent Event = iota
	ErrorEvent       // temporary failure
	ProgressEvent
	SuccessEvent
	FailureEvent
)

type EventData

type EventData struct {
	Event Event
	State State
}

type Exchange

type Exchange interface {
	// Code is the identifier for this exchange protocol
	Code() multicodec.Code

	// RequestData based on root, selector, and routing parameters
	RequestData(ctx context.Context, request ipld.Link, selector ipld.Node, routingProvider interface{}, routingPayload interface{}) <-chan EventData

	// Close completes use of this exchange
	Close()
}

type ExchangeMux

type ExchangeMux struct {
	// contains filtered or unexported fields
}

func DefaultMux

func DefaultMux() *ExchangeMux

func (*ExchangeMux) Add

func (e *ExchangeMux) Add(ctx context.Context, tr *planning.TransportRequest) error

func (*ExchangeMux) Register

func (e *ExchangeMux) Register(ex Exchange) error

func (*ExchangeMux) Subscribe

func (e *ExchangeMux) Subscribe() chan MuxEvent

type MuxEvent

type MuxEvent struct {
	Source *planning.TransportRequest
	EventData
}

type State

type State interface{}