goob

README

Overview

A lightweight observable lib. Go channel doesn't support unlimited buffer size, it's a pain to decide what size to use, this lib will handle it dynamically.

• unlimited buffer size
• one publisher to multiple subscribers
• thread-safe
• subscribers never block each other
• stable event order

Examples

See examples_test.go.

Documentation

Overview

Example (Basic)

package main

import (
	"fmt"

	"github.com/ysmood/goob"
)

func main() {
	// create an observable instance
	ob := goob.New()
	defer ob.Close()

	events := ob.Subscribe()

	// publish events without blocking
	ob.Publish(1)
	ob.Publish(2)
	ob.Publish(3)

	// consume events
	for e := range events {
		fmt.Print(e)

		if e.(int) == 3 {
			break
		}
	}

}

Output:
123

Index

• type Event
• type Observable
  • func New() *Observable
  • func (ob *Observable) Close()
  • func (ob *Observable) Len() int
  • func (ob *Observable) Publish(e Event)
  • func (ob *Observable) Subscribe() Subscriber
  • func (ob *Observable) Unsubscribe(s Subscriber)
• type Pipe
  • func NewPipe() *Pipe
• type Subscriber

Examples

• Package (Basic)

Types

type Event

type Event interface{}

Event interface

type Observable

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

Observable hub

func New

func New() *Observable

New observable instance

func (*Observable) Close

func (ob *Observable) Close()

Close subscribers

func (*Observable) Len

func (ob *Observable) Len() int

Len of the subscribers

func (*Observable) Publish

func (ob *Observable) Publish(e Event)

Publish message to the queue

func (*Observable) Subscribe

func (ob *Observable) Subscribe() Subscriber

Subscribe message

func (*Observable) Unsubscribe

func (ob *Observable) Unsubscribe(s Subscriber)

Unsubscribe from observable

type Pipe

type Pipe struct {
	Write  func(Event)
	Events <-chan Event
	Stop   func()
}

Pipe the Event via Write to Events. Events uses an internal buffer so it won't block Write. Call Stop to abort.

func NewPipe

func NewPipe() *Pipe

NewPipe instance

type Subscriber

type Subscriber <-chan Event

Subscriber type