requestmanager

Documentation

Index

• type PeerHandler
• type PersistenceOptions
• type RequestHooks
• type RequestManager
  • func New(ctx context.Context, persistenceOptions PersistenceOptions, ...) *RequestManager
  • func (rm *RequestManager) CancelRequest(ctx context.Context, requestID graphsync.RequestID) error
  • func (rm *RequestManager) Disconnected(p peer.ID)
  • func (rm *RequestManager) GetRequestTask(p peer.ID, task *peertask.Task, requestExecutionChan chan executor.RequestTask)
  • func (rm *RequestManager) NewRequest(ctx context.Context, p peer.ID, root ipld.Link, selectorNode ipld.Node, ...) (<-chan graphsync.ResponseProgress, <-chan error)
  • func (rm *RequestManager) PauseRequest(ctx context.Context, requestID graphsync.RequestID) error
  • func (rm *RequestManager) PeerState(p peer.ID) peerstate.PeerState
  • func (rm *RequestManager) ProcessResponses(p peer.ID, responses []gsmsg.GraphSyncResponse, blks []blocks.Block)
  • func (rm *RequestManager) ReleaseRequestTask(p peer.ID, task *peertask.Task, err error)
  • func (rm *RequestManager) SendRequest(p peer.ID, request gsmsg.GraphSyncRequest)
  • func (rm *RequestManager) SetDelegate(peerHandler PeerHandler)
  • func (rm *RequestManager) Shutdown()
  • func (rm *RequestManager) Startup()
  • func (rm *RequestManager) UnpauseRequest(ctx context.Context, requestID graphsync.RequestID, ...) error
  • func (rm *RequestManager) UpdateRequest(ctx context.Context, requestID graphsync.RequestID, ...) error
• type ResponseHooks

Types

type PeerHandler

type PeerHandler interface {
	AllocateAndBuildMessage(p peer.ID, blkSize uint64, buildMessageFn func(*messagequeue.Builder))
}

PeerHandler is an interface that can send requests to peers

type PersistenceOptions

type PersistenceOptions interface {
	GetLinkSystem(name string) (ipld.LinkSystem, bool)
}

PersistenceOptions is an interface for getting loaders by name

type RequestHooks

type RequestHooks interface {
	ProcessRequestHooks(p peer.ID, request graphsync.RequestData) hooks.RequestResult
}

RequestHooks run for new requests

type RequestManager

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

RequestManager tracks outgoing requests and processes incoming reponses to them.

func New

func New(ctx context.Context,
	persistenceOptions PersistenceOptions,
	linkSystem ipld.LinkSystem,
	requestHooks RequestHooks,
	responseHooks ResponseHooks,
	networkErrorListeners *listeners.NetworkErrorListeners,
	outgoingRequestProcessingListeners *listeners.OutgoingRequestProcessingListeners,
	requestQueue taskqueue.TaskQueue,
	connManager network.ConnManager,
	maxLinksPerRequest uint64,
	panicCallback panics.CallBackFn,
) *RequestManager

New generates a new request manager from a context, network, and selectorQuerier

func (*RequestManager) CancelRequest

func (rm *RequestManager) CancelRequest(ctx context.Context, requestID graphsync.RequestID) error

CancelRequest cancels the given request ID and waits for the request to terminate

func (*RequestManager) Disconnected

func (rm *RequestManager) Disconnected(p peer.ID)

Disconnected is called when a peer disconnects

func (*RequestManager) GetRequestTask

func (rm *RequestManager) GetRequestTask(p peer.ID, task *peertask.Task, requestExecutionChan chan executor.RequestTask)

GetRequestTask gets data for the given task in the request queue

func (*RequestManager) NewRequest

func (rm *RequestManager) NewRequest(ctx context.Context,
	p peer.ID,
	root ipld.Link,
	selectorNode ipld.Node,
	extensions ...graphsync.ExtensionData) (<-chan graphsync.ResponseProgress, <-chan error)

NewRequest initiates a new GraphSync request to the given peer.

func (*RequestManager) PauseRequest

func (rm *RequestManager) PauseRequest(ctx context.Context, requestID graphsync.RequestID) error

PauseRequest pauses an in progress request (may take 1 or more blocks to process)

func (*RequestManager) PeerState

func (rm *RequestManager) PeerState(p peer.ID) peerstate.PeerState

PeerState gets stats on all outgoing requests for a given peer

func (*RequestManager) ProcessResponses

func (rm *RequestManager) ProcessResponses(p peer.ID,
	responses []gsmsg.GraphSyncResponse,
	blks []blocks.Block)

ProcessResponses ingests the given responses from the network and and updates the in progress requests based on those responses.

func (*RequestManager) ReleaseRequestTask

func (rm *RequestManager) ReleaseRequestTask(p peer.ID, task *peertask.Task, err error)

ReleaseRequestTask releases a task request the requestQueue

func (*RequestManager) SendRequest

func (rm *RequestManager) SendRequest(p peer.ID, request gsmsg.GraphSyncRequest)

SendRequest sends a request to the message queue

func (*RequestManager) SetDelegate

func (rm *RequestManager) SetDelegate(peerHandler PeerHandler)

SetDelegate specifies who will send messages out to the internet.

func (*RequestManager) Shutdown

func (rm *RequestManager) Shutdown()

Shutdown ends processing for the want manager.

func (*RequestManager) Startup

func (rm *RequestManager) Startup()

Startup starts processing for the WantManager.

func (*RequestManager) UnpauseRequest

func (rm *RequestManager) UnpauseRequest(ctx context.Context, requestID graphsync.RequestID, extensions ...graphsync.ExtensionData) error

UnpauseRequest unpauses a request that was paused in a block hook based request ID Can also send extensions with unpause

func (*RequestManager) UpdateRequest

func (rm *RequestManager) UpdateRequest(ctx context.Context, requestID graphsync.RequestID, extensions ...graphsync.ExtensionData) error

UpdateRequest updates an in progress request

type ResponseHooks

type ResponseHooks interface {
	ProcessResponseHooks(p peer.ID, response graphsync.ResponseData) hooks.UpdateResult
}

ResponseHooks run for new responses