executor

Documentation

Index

• type AsyncLoadFn
• type BlockHooks
• type Executor
  • func NewExecutor(manager Manager, blockHooks BlockHooks, loader AsyncLoadFn) *Executor
  • func (e *Executor) ExecuteTask(ctx context.Context, pid peer.ID, task *peertask.Task) bool
• type Manager
• type RequestTask

Types

type AsyncLoadFn

type AsyncLoadFn func(peer.ID, graphsync.RequestID, ipld.Link, ipld.LinkContext) <-chan types.AsyncLoadResult

AsyncLoadFn is a function which given a request id and an ipld.Link, returns a channel which will eventually return data for the link or an err

type BlockHooks

type BlockHooks interface {
	ProcessBlockHooks(p peer.ID, response graphsync.ResponseData, block graphsync.BlockData) hooks.UpdateResult
}

BlockHooks run for each block loaded

type Executor

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

Executor handles actually executing graphsync requests and verifying them. It has control of requests when they are in the "running" state, while the manager is in charge when requests are queued or paused

func NewExecutor

func NewExecutor(
	manager Manager,
	blockHooks BlockHooks,
	loader AsyncLoadFn) *Executor

NewExecutor returns a new executor

func (*Executor) ExecuteTask

func (e *Executor) ExecuteTask(ctx context.Context, pid peer.ID, task *peertask.Task) bool

type Manager

type Manager interface {
	SendRequest(peer.ID, gsmsg.GraphSyncRequest)
	GetRequestTask(peer.ID, *peertask.Task, chan RequestTask)
	ReleaseRequestTask(peer.ID, *peertask.Task, error)
}

Manager is an interface the Executor uses to interact with the request manager

type RequestTask

type RequestTask struct {
	Ctx            context.Context
	Span           trace.Span
	Request        gsmsg.GraphSyncRequest
	LastResponse   *atomic.Value
	DoNotSendCids  *cid.Set
	PauseMessages  <-chan struct{}
	Traverser      ipldutil.Traverser
	P              peer.ID
	InProgressErr  chan error
	Empty          bool
	InitialRequest bool
}

RequestTask are parameters for a single request execution