messagequeue

Documentation

Index

• type MessageNetwork
• type MessageQueue
  • func New(ctx context.Context, p peer.ID, network MessageNetwork) *MessageQueue
  • func (mq *MessageQueue) AddMessage(entries []bsmsg.Entry, ses uint64)
  • func (mq *MessageQueue) AddWantlist(initialWants *wantlist.SessionTrackedWantlist)
  • func (mq *MessageQueue) SetRebroadcastInterval(delay time.Duration)
  • func (mq *MessageQueue) Shutdown()
  • func (mq *MessageQueue) Startup()

Types

type MessageNetwork

type MessageNetwork interface {
	ConnectTo(context.Context, peer.ID) error
	NewMessageSender(context.Context, peer.ID) (bsnet.MessageSender, 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) AddMessage

func (mq *MessageQueue) AddMessage(entries []bsmsg.Entry, ses uint64)

AddMessage adds new entries to an outgoing message for a given session.

func (*MessageQueue) AddWantlist

func (mq *MessageQueue) AddWantlist(initialWants *wantlist.SessionTrackedWantlist)

AddWantlist adds a complete session tracked want list to a message queue

func (*MessageQueue) SetRebroadcastInterval

func (mq *MessageQueue) SetRebroadcastInterval(delay time.Duration)

SetRebroadcastInterval sets a new interval on which to rebroadcast the full wantlist

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.