msgq

Documentation

Overview

Package msgq implements a simple, finite-sized message queue. It can be used as a building block for a message processor pool.

Index

• Variables
• type MessageAdder
• type MessageHandler
• type Queue
  • func New(size int) *Queue
  • func (q *Queue) AddMessage(content []byte, sender peer.ID) error
  • func (q *Queue) Close() error
  • func (q *Queue) HandleMessages(h MessageHandler)

Variables

var ErrRxOverrun = errors.New("rx overrun")

ErrRxOverrun signals that a receive queue has been overrun.

Types

type MessageAdder

type MessageAdder interface {
	AddMessage(content []byte, sender peer.ID) error
}

MessageAdder enqueues a received message for processing. It returns without blocking, and may return a queue overrun error.

type MessageHandler

type MessageHandler interface {
	HandleMessage(content []byte, sender peer.ID)
}

MessageHandler is a message handler.

type Queue

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

Queue is a finite-sized message queue.

func New

func New(size int) *Queue

New returns a new message queue of the given size.

func (*Queue) AddMessage

func (q *Queue) AddMessage(content []byte, sender peer.ID) error

AddMessage enqueues a received message for processing. It returns without blocking, and may return a queue overrun error.

func (*Queue) Close

func (q *Queue) Close() error

Close closes the given queue.

func (*Queue) HandleMessages

func (q *Queue) HandleMessages(h MessageHandler)

HandleMessages dequeues and dispatches incoming messages using the given message handler, until the message queue is closed. This function can be spawned as a background goroutine, potentially multiple times for a pool.