broadcast

README

broadcast

A library that provides broadcast channels (one to many).

I'll write up some examples and docs later, for now I only extracted it from OvenCast which the package was originally created for.

Probably not production-ready.

Documentation

Index

• Variables
• type Channel
  • func NewChannel[T any]() *Channel[T]
  • func (c *Channel[T]) Broadcast(ctx context.Context, m T) error
  • func (c *Channel[T]) Ch() chan<- T
  • func (c *Channel[T]) Close(ctx context.Context) error
  • func (c *Channel[T]) Run(ctx context.Context)
  • func (c *Channel[T]) Running() bool
  • func (c *Channel[T]) SubCount(ctx context.Context) (int, error)
  • func (c *Channel[T]) Subscribe(ctx context.Context) (<-chan T, error)

Variables

var ErrResultSentTwice = fmt.Errorf("tried to send result twice")

Types

type Channel

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

func NewChannel

func NewChannel[T any]() *Channel[T]

func (*Channel[T]) Broadcast

func (c *Channel[T]) Broadcast(ctx context.Context, m T) error

func (*Channel[T]) Ch

func (c *Channel[T]) Ch() chan<- T

func (*Channel[T]) Close

func (c *Channel[T]) Close(ctx context.Context) error

func (*Channel[T]) Run

func (c *Channel[T]) Run(ctx context.Context)

func (*Channel[T]) Running

func (c *Channel[T]) Running() bool

func (*Channel[T]) SubCount

func (c *Channel[T]) SubCount(ctx context.Context) (int, error)

func (*Channel[T]) Subscribe

func (c *Channel[T]) Subscribe(ctx context.Context) (<-chan T, error)