eventbus

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 9, 2026 License: MIT Imports: 1 Imported by: 0

Documentation

Overview

Package eventbus 提供类型化的进程内事件总线,对齐 Cordis 的四种同步分发模式。

上游 Cordis 用同一套 ctx.on/ctx.emit 承载插件间松耦合通信,每种事件有且只有 一种分发模式。Go 侧没有 Cordis 运行时,本包用泛型把四种契约固化为独立方法, 让"注册—分发—自动清理"在编译期就清晰可辨:

  • Emit 广播:所有监听器顺序执行,返回值被忽略(通知语义);
  • Bail 保释:顺序执行,第一个返回非 error 零值/错误的监听器短路并回传;
  • Serial 串行:顺序执行,收集每个监听器的返回值为切片(聚合语义);
  • Waterfall 归 pkg/waterfall(洋葱 next 委托),不在本包重复。

生命周期:On 返回 dispose 闭包,调用即摘除该监听器——对应 Cordis "插件卸载时 自动移除监听",调用方应在自己的清理路径里保留并调用它。

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Bus

type Bus[T any, R any] struct {
	// contains filtered or unexported fields
}

Bus 是单个事件通道:维护一组有序监听器,并发安全。 零值不可直接使用,请用 New 构造。

func New

func New[T any, R any]() *Bus[T, R]

New 创建一个空事件总线。

func (*Bus[T, R]) Bail

func (b *Bus[T, R]) Bail(payload T, shouldShort func(R) bool) (R, bool)

Bail 保释:顺序调用监听器,第一个 shouldShort(返回值)=true 的结果被回传, 后续监听器不再执行。所有监听器都未命中时返回零值与 false。

func (*Bus[T, R]) Emit

func (b *Bus[T, R]) Emit(payload T)

Emit 广播:顺序调用所有监听器,忽略返回值。

func (*Bus[T, R]) Len

func (b *Bus[T, R]) Len() int

Len 返回当前监听器数量。

func (*Bus[T, R]) On

func (b *Bus[T, R]) On(fn Listener[T, R]) func()

On 注册一个监听器,返回 dispose 函数。 调用 dispose(幂等)会摘除该监听器;未调用时监听器一直有效。

func (*Bus[T, R]) Serial

func (b *Bus[T, R]) Serial(payload T) []R

Serial 串行:顺序调用所有监听器,收集返回值为切片(保持注册顺序)。

type Listener

type Listener[T any, R any] func(payload T) R

Listener 是一个接收载荷并返回结果的监听器。 Emit 场景下返回值被忽略;Bail/Serial 场景下参与短路或聚合。

type Signal

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

Signal 是不关心返回值的通知总线。

func NewSignal

func NewSignal[T any]() *Signal[T]

NewSignal 创建通知总线。

func (*Signal[T]) Emit

func (s *Signal[T]) Emit(payload T)

Emit 广播通知。

func (*Signal[T]) Len

func (s *Signal[T]) Len() int

Len 返回监听器数量。

func (*Signal[T]) On

func (s *Signal[T]) On(fn func(T)) func()

On 注册通知监听器,返回 dispose。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL