messagequeue

Documentation

Index

• type Event
• type EventName
• type MessageNetwork
• type MessageQueue
  • func New(ctx context.Context, p peer.ID, network MessageNetwork) *MessageQueue
  • func (mq *MessageQueue) AddRequest(graphSyncRequest gsmsg.GraphSyncRequest, notifees ...notifications.Notifee)
  • func (mq *MessageQueue) AddResponses(responses []gsmsg.GraphSyncResponse, blks []blocks.Block, ...)
  • func (mq *MessageQueue) Shutdown()
  • func (mq *MessageQueue) Startup()
• type Topic

Types

type Event

type Event struct {
	Name EventName
	Err  error
}

type EventName

type EventName uint64

const (
	Queued EventName = iota
	Sent
	Error
)

type MessageNetwork

type MessageNetwork interface {
	NewMessageSender(context.Context, peer.ID) (gsnet.MessageSender, error)
	ConnectTo(context.Context, peer.ID) error
}

MessageNetwork is any network that can connect peers and generate a message sender.

type MessageQueue

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

MessageQueue implements queue of want messages to send to peers.

func New

func New(ctx context.Context, p peer.ID, network MessageNetwork) *MessageQueue

New creats a new MessageQueue.

func (*MessageQueue) AddRequest

func (mq *MessageQueue) AddRequest(graphSyncRequest gsmsg.GraphSyncRequest, notifees ...notifications.Notifee)

AddRequest adds an outgoing request to the message queue.

func (*MessageQueue) AddResponses

func (mq *MessageQueue) AddResponses(responses []gsmsg.GraphSyncResponse, blks []blocks.Block, notifees ...notifications.Notifee)

AddResponses adds the given blocks and responses to the next message and returns a channel that sends a notification when sending initiates. If ignored by the consumer sending will not block.

func (*MessageQueue) Shutdown

func (mq *MessageQueue) Shutdown()

Shutdown stops the processing of messages for a message queue.

func (*MessageQueue) Startup

func (mq *MessageQueue) Startup()

Startup starts the processing of messages, and creates an initial message based on the given initial wantlist.

type Topic

type Topic uint64