mpsc

Documentation

Overview

Package mpsc implements a multiple-producer, single-consumer queue.

Index

• type Queue
  • func New[T any]() *Queue[T]
• type Rx
  • func (rx *Rx[T]) Recv(ctx context.Context) (T, error)
  • func (rx *Rx[T]) TryRecv() (v T, ok bool)
• type Tx
  • func (tx *Tx[T]) Send(v T)

Types

type Queue

type Queue[T any] struct {
	Tx[T]
	Rx[T]
}

A multiple-producer, single-consumer queue. Create one with New(), and send from many gorotuines with Tx.Send(). Only one gorotuine may call Rx.Recv().

func New

func New[T any]() *Queue[T]

Create a new, initially empty Queue.

type Rx

type Rx[T any] struct {
	// contains filtered or unexported fields
}

The receive end of a Queue.

func (*Rx[T]) Recv

func (rx *Rx[T]) Recv(ctx context.Context) (T, error)

Receive a message from the queue. Blocks if the queue is empty. If the context ends before the receive happens, this returns ctx.Err().

func (*Rx[T]) TryRecv

func (rx *Rx[T]) TryRecv() (v T, ok bool)

Try to receive a message from the queue. If successful, ok will be true. If the queue is empty, this will return immediately with ok = false.

type Tx

type Tx[T any] struct {
	// contains filtered or unexported fields
}

The send/transmit end of a Queue.

func (*Tx[T]) Send

func (tx *Tx[T]) Send(v T)

Send a message on the queue.