GoEventBus

README

GoEventBus

A blazing‑fast, in‑memory, lock‑free event bus for Go—ideal for low‑latency pipelines, microservices, and game loops.

📚 Table of Contents

• Features
• Why GoEventBus?
• Installation
• Quick Start
• Transactions
• API Reference
• Back-pressure and Overrun Policies
• Use Cases
• Benchmarks
• Contributing
• License

Features

• Lock‑free ring buffer: Efficient event dispatching using atomic operations and cache‑line padding.
• Context‑aware handlers: Every handler now receives a context.Context, enabling deadlines, cancellation and tracing.
• Back‑pressure policies: Choose whether to drop, block, or error when the buffer is full.
• Configurable buffer size: Specify the ring buffer size (must be a power of two) when creating the store.
• Async or Sync processing: Toggle between synchronous handling or async goroutine‑based processing via the Async flag.
• Metrics: Track published, processed, and errored event counts with a simple API.
• Simple API: Easy to subscribe, publish, and retrieve metrics.

Why GoEventBus?

Modern Go apps demand lightning‑fast, non‑blocking communication—but channels can bottleneck and external brokers add latency, complexity and ops overhead. GoEventBus is your in‑process, lock‑free solution:

• Micro‑latency dispatch
  Atomic, cache‑aligned ring buffers deliver sub‑microsecond hand‑offs—no locks, no syscalls, zero garbage.
• Sync or Async at will
  Flip a switch to run handlers inline for predictability or in goroutines for massive parallelism.
• Back‑pressure your way
  Choose from DropOldest, Block or ReturnError to match your system’s tolerance for loss or latency.
• Built‑in observability
  Expose counters for published, processed and errored events out of the box—no extra instrumentation.
• Drop‑in, zero deps
  One import, no external services, no workers to manage—just Go 1.21+ and you’re off.

Whether you’re building real‑time analytics, high‑throughput microservices, or game engines, GoEventBus keeps your events moving at Go‑speed.

Installation

go get github.com/Protocol-Lattice/GoEventBus

Quick Start

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/Protocol-Lattice/GoEventBus"
)

// Define a typed projection as a struct
type HouseWasSold struct{}

func main() {
	// Create a dispatcher mapping projections (string or struct) to handlers
	dispatcher := GoEventBus.Dispatcher{
		"user_created": func(ctx context.Context, args map[string]any) (GoEventBus.Result, error) {
			userID := args["id"].(string)
			fmt.Println("User created with ID:", userID)
			return GoEventBus.Result{Message: "handled user_created"}, nil
		},
		HouseWasSold{}: func(ctx context.Context, args map[string]any) (GoEventBus.Result, error) {
			address := args["address"].(string)
			price := args["price"].(int)
			fmt.Printf("House sold at %s for $%d\n", address, price)
			return GoEventBus.Result{Message: "handled HouseWasSold"}, nil
		},
	}

	// Initialise an EventStore with a 64K ring buffer and DropOldest overrun policy
	store := GoEventBus.NewEventStore(&dispatcher, 1<<16, GoEventBus.DropOldest)

	// Enable asynchronous processing
	store.Async = true

	// Enqueue a string-based event
	_ = store.Subscribe(context.Background(), GoEventBus.Event{
		ID:         "evt1",
		Projection: "user_created",
		Args:       map[string]any{"id": "12345"},
	})

	// Enqueue a struct-based event
	_ = store.Subscribe(context.Background(), GoEventBus.Event{
		ID:         "evt2",
		Projection: HouseWasSold{},
		Args:       map[string]any{"address": "123 Main St", "price": 500000},
	})

	// Process pending events
	store.Publish()

	// Wait for all async handlers to finish
	if err := store.Drain(context.Background()); err != nil {
		log.Fatalf("Failed to drain EventStore: %v", err)
	}

	// Retrieve metrics
	published, processed, errors := store.Metrics()
	fmt.Printf("published=%d processed=%d errors=%d\n", published, processed, errors)
}

Transactions

GoEventBus now supports atomic transactions, allowing you to group multiple events and commit them together. This ensures that either all events are successfully published and handled, or none are.

package main

import (
	"context"
	"log"

	"github.com/Protocol-Lattice/GoEventBus"
)

func main() {
	// Begin a new transaction on the existing EventStore

	// Create a dispatcher mapping projections to handlers
	dispatcher := GoEventBus.Dispatcher{
		"user_created": func(ctx context.Context, args map[string]any) (GoEventBus.Result, error) {
			return GoEventBus.Result{Message: "handled user_created"}, nil
		},
		"send_email": func(ctx context.Context, args map[string]any) (GoEventBus.Result, error) {
			log.Println("Hello")
			return GoEventBus.Result{Message: "handled send_email"}, nil
		},
	}

	// Initialise an EventStore with a 64K ring buffer and DropOldest policy
	store := GoEventBus.NewEventStore(&dispatcher, 1<<16, GoEventBus.DropOldest)
	tx := store.BeginTransaction()

	// Buffer multiple events
	tx.Publish(GoEventBus.Event{
		ID:         "evtA",
		Projection: "user_created",
		Args:       map[string]any{"id": "12345"},
	})
	tx.Publish(GoEventBus.Event{
		ID:         "evtB",
		Projection: "send_email",
		Args:       map[string]any{"template": "welcome", "userID": "12345"},
	})
	tx.Rollback()

	// Commit the transaction atomically
	if err := tx.Commit(context.Background()); err != nil {
		log.Fatalf("transaction failed: %v", err)
	}
}

API Reference

type Result

type Result struct {
    Message string // Outcome message from handler
}

type Dispatcher

type Dispatcher map[interface{}]func(context.Context, map[string]any) (Result, error)

A map from projection keys to handler functions. Handlers receive a context.Context and an argument map, and return a Result and an error.

type Event

type Event struct {
    ID         string          // Unique identifier for the event
    Projection interface{}     // Key to look up the handler in the dispatcher
    Args       map[string]any  // Payload data for the event
}

type Transaction

type Transaction struct {
    store  *EventStore
    events []Event
    startHead uint64 // head position when transaction began

}

• BeginTransaction() *Transaction: Start a new transaction.
• Publish(e Event): Buffer an event within the transaction.
• Commit(ctx context.Context) error: Atomically enqueue and process all buffered events, returning on the first error.
• Rollback(): Discard buffered events without publishing.

type OverrunPolicy

type OverrunPolicy int

const (
    DropOldest  OverrunPolicy = iota // Default: discard oldest events
    Block                            // Block until space is available
    ReturnError                      // Fail fast with ErrBufferFull
)

type EventStore

type EventStore struct {
    dispatcher     *Dispatcher      // Pointer to the dispatcher map
    size           uint64           // Buffer size (power of two)
    buf            []unsafe.Pointer // Ring buffer of event pointers
    events         []Event          // Backing slice for Event data
    head           uint64           // Atomic write index
    tail           uint64           // Atomic read index

    // Config flags
    Async          bool
    OverrunPolicy  OverrunPolicy

    // Counters
    publishedCount uint64
    processedCount uint64
    errorCount     uint64
}

NewEventStore

func NewEventStore(dispatcher *Dispatcher, bufferSize uint64, policy OverrunPolicy) *EventStore

Creates a new EventStore with the provided dispatcher, ring buffer size, and overrun policy.

Subscribe

func (es *EventStore) Subscribe(ctx context.Context, e Event) error

Atomically enqueues an Event for later publication, applying back‑pressure according to OverrunPolicy. If OverrunPolicy is ReturnError and the buffer is full, the function returns ErrBufferFull.

Publish

func (es *EventStore) Publish()

Dispatches all events from the last published position to the current head. If Async is true, handlers run in separate goroutines; otherwise they run in the caller's goroutine.

Drain

func (es *EventStore) Drain(ctx context.Context) error

Blocks until all in-flight asynchronous handlers complete, then stops the worker pool. Returns an error if the provided context.Context is canceled or its deadline is exceeded.

Close

func (es *EventStore) Close(ctx context.Context) error

Drains all pending asynchronous handlers and shuts down the EventStore. Blocks until all in-flight handlers complete or the provided context.Context is canceled. Returns an error if the context’s deadline is exceeded or it is otherwise canceled.

Metrics

func (es *EventStore) Metrics() (published, processed, errors uint64)

Returns the total count of published, processed, and errored events.

Schedule

func (es *EventStore) Schedule(ctx context.Context, t time.Time, e Event) *time.Timer

Schedules an Event to be subscribed and published at a specific time t.

• If t is in the future, the function returns a *time.Timer that can be used to cancel the event before it fires by using timer.Stop().
• If t is in the past or is the current time, the event is executed immediately and synchronously, bypassing the event queue, and the function returns nil.

ScheduleAfter

func (es *EventStore) ScheduleAfter(ctx context.Context, d time.Duration, e Event) *time.Timer

A convenience wrapper around Schedule that fires an event after a specified duration d.

• If the duration d is greater than zero, it returns a cancellable *time.Timer.
• If d is zero or negative, the event is executed immediately and synchronously, bypassing the event queue, and the function returns nil.

Back-pressure and Overrun Policies

GoEventBus provides three strategies for handling a saturated ring buffer:

Policy	Behaviour	When to use
DropOldest	Atomically advances the read index, discarding the oldest event to make room for the new one.	Low‑latency scenarios where the newest data is most valuable and occasional loss is acceptable.
Block	Causes Subscribe to block (respecting its context) until space becomes available.	Workloads that must not lose events but can tolerate the latency of back‑pressure.
ReturnError	Subscribe returns ErrBufferFull immediately, allowing the caller to decide what to do.	Pipelines where upstream logic controls retries and failures explicitly.

DropOldest is the default behaviour and matches releases prior to April 2025.

💡 Use Cases

GoEventBus is ideal for scenarios where low‑latency, high‑throughput, and non‑blocking event dispatching is needed:

• 🔄 Real‑time event pipelines (e.g. analytics, telemetry)
• 📥 Background task execution or job queues
• 🧩 Microservice communication using in‑process events
• ⚙️ Observability/event sourcing in domain‑driven designs
• 🔁 In‑memory pub/sub for small‑scale distributed systems
• 🎮 Game loops or simulations requiring lock‑free dispatching

Benchmarks

All benchmarks were run with Go’s testing harness (go test -bench .) on an -8 procs configuration. Numbers below are from the April 2025 release.

Benchmark	Iterations	ns/op
BenchmarkSubscribe-8	27,080,376	40.37
BenchmarkSubscribeParallel-8	26,418,999	38.42
BenchmarkPublish-8	295,661,464	3.910
BenchmarkPublishAfterPrefill-8	252,943,526	4.585
BenchmarkSubscribeLargePayload-8	1,613,017	771.5
BenchmarkPublishLargePayload-8	296,434,225	3.910
BenchmarkEventStore_Async-8	2,816,988	436.5
BenchmarkEventStore_Sync-8	2,638,519	428.5
BenchmarkFastHTTPSync-8	6,275,112	163.8
BenchmarkFastHTTPAsync-8	1,954,884	662.0
BenchmarkFastHTTPParallel-8	4,489,274	262.3

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

License

Distributed under the MIT License. See LICENSE for more information.

Documentation

Index

• Variables
• type AfterHook
• type BeforeHook
• type Dispatcher
• type ErrorHook
• type Event
• type EventStore
  • func NewEventStore(dispatcher *Dispatcher, bufferSize uint64, policy OverrunPolicy) *EventStore
  • func (es *EventStore) BeginTransaction() *Transaction
  • func (es *EventStore) Close(ctx context.Context) error
  • func (es *EventStore) Drain(ctx context.Context) error
  • func (es *EventStore) Metrics() (published, processed, errors uint64)
  • func (es *EventStore) OnAfter(hook AfterHook)
  • func (es *EventStore) OnBefore(hook BeforeHook)
  • func (es *EventStore) OnError(hook ErrorHook)
  • func (es *EventStore) Publish()
  • func (es *EventStore) Schedule(ctx context.Context, t time.Time, e Event) *time.Timer
  • func (es *EventStore) ScheduleAfter(ctx context.Context, d time.Duration, e Event) *time.Timer
  • func (es *EventStore) Subscribe(ctx context.Context, e Event) error
  • func (es *EventStore) Use(mw Middleware)
• type HandlerFunc
• type Middleware
• type OverrunPolicy
• type Result
• type Transaction
  • func (tx *Transaction) Commit(ctx context.Context) error
  • func (tx *Transaction) Publish(e Event)
  • func (tx *Transaction) Rollback()

Variables

var ErrBufferFull = errors.New("goeventbus: buffer is full")

ErrBufferFull is returned by Subscribe when OverrunPolicy==ReturnError and the ring buffer is saturated.

Types

type AfterHook

type AfterHook func(context.Context, Event, Result, error)

type BeforeHook

type BeforeHook func(context.Context, Event)

Hook types for before, after, and error events.

type Dispatcher

type Dispatcher map[interface{}]HandlerFunc

Dispatcher maps event projections to handler functions.

type ErrorHook

type ErrorHook func(context.Context, Event, error)

type Event

type Event struct {
	ID         string
	Projection interface{}
	Args       map[string]any
	Ctx        context.Context // carried context from Subscribe
}

Event is a unit of work to be dispatched.

type EventStore

type EventStore struct {

	// Config flags
	Async         bool
	OverrunPolicy OverrunPolicy
	// contains filtered or unexported fields
}

EventStore is a high-performance, lock-free ring buffer with middleware and hooks support.

func NewEventStore

func NewEventStore(dispatcher *Dispatcher, bufferSize uint64, policy OverrunPolicy) *EventStore

NewEventStore initializes a new EventStore. It spins up a default worker pool.

func (*EventStore) BeginTransaction

func (es *EventStore) BeginTransaction() *Transaction

BeginTransaction starts a new transaction on the EventStore.

func (*EventStore) Close

func (es *EventStore) Close(ctx context.Context) error

Close drains all pending async events and shuts down the EventStore.

func (*EventStore) Drain

func (es *EventStore) Drain(ctx context.Context) error

Drain waits for all in-flight async handlers to complete, stopping new dispatch.

func (*EventStore) Metrics

func (es *EventStore) Metrics() (published, processed, errors uint64)

Metrics returns snapshot counters.

func (*EventStore) OnAfter

func (es *EventStore) OnAfter(hook AfterHook)

OnAfter registers a hook that runs after each handler invocation (even on error).

func (*EventStore) OnBefore

func (es *EventStore) OnBefore(hook BeforeHook)

OnBefore registers a hook that runs before each handler invocation.

func (*EventStore) OnError

func (es *EventStore) OnError(hook ErrorHook)

OnError registers a hook that runs only when a handler returns an error.

func (*EventStore) Publish

func (es *EventStore) Publish()

Publish processes all pending events, applying middleware and hooks.

func (*EventStore) Schedule

func (es *EventStore) Schedule(ctx context.Context, t time.Time, e Event) *time.Timer

func (*EventStore) ScheduleAfter

func (es *EventStore) ScheduleAfter(ctx context.Context, d time.Duration, e Event) *time.Timer

ScheduleAfter fires e after the given duration d. If d<=0 it falls back to Schedule(now).

func (*EventStore) Subscribe

func (es *EventStore) Subscribe(ctx context.Context, e Event) error

Subscribe enqueues an Event, applying back-pressure according to OverrunPolicy.

func (*EventStore) Use

func (es *EventStore) Use(mw Middleware)

Use adds middleware to the EventStore. It will be applied in the order added.

type HandlerFunc

type HandlerFunc func(context.Context, map[string]any) (Result, error)

HandlerFunc is the signature for event handlers and middleware.

type Middleware

type Middleware func(HandlerFunc) HandlerFunc

Middleware wraps a HandlerFunc, returning a new HandlerFunc.

type OverrunPolicy

type OverrunPolicy int

OverrunPolicy defines what happens when the ring buffer is full.

const (
	// DropOldest discards the oldest events when the buffer is full.
	DropOldest OverrunPolicy = iota
	// Block causes Subscribe to block (respecting ctx) until space is available.
	Block
	// ReturnError makes Subscribe fail fast with ErrBufferFull.
	ReturnError
)

type Result

type Result struct {
	Message string
}

Result represents the outcome of an event handler.

type Transaction

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

Transaction encapsulates a set of events to be committed atomically.

func (*Transaction) Commit

func (tx *Transaction) Commit(ctx context.Context) error

Commit enqueues all buffered events and processes them immediately. It returns the first error encountered from Subscribe or handler execution.

func (*Transaction) Publish

func (tx *Transaction) Publish(e Event)

Publish adds an event to the transaction buffer.

func (*Transaction) Rollback

func (tx *Transaction) Rollback()

Rollback clears the local buffer *and* any events that have already been pushed into the store’s ring-buffer since the transaction began.