events

Documentation

Overview

Package events provides protocol event pub/sub and webhook notifications.

Index

• func FormatEvent(e *Event) string
• type Event
• type EventBus
  • func NewEventBus() *EventBus
  • func (eb *EventBus) AddWebhook(wh Webhook)
  • func (eb *EventBus) Publish(e *Event)
  • func (eb *EventBus) Replay(filter *FilterRule) []*Event
  • func (eb *EventBus) Subscribe(id string) chan *Event
  • func (eb *EventBus) Unsubscribe(id string)
• type EventType
• type FilterRule
  • func (f *FilterRule) Match(e *Event) bool
• type Webhook

Functions

func FormatEvent

func FormatEvent(e *Event) string

FormatEvent formats an event for display.

Types

type Event

type Event struct {
	ID        string    `json:"id"`
	Type      EventType `json:"type"`
	Protocol  string    `json:"protocol"`
	Timestamp time.Time `json:"timestamp"`
	Data      any       `json:"data"`
}

Event represents a protocol event.

type EventBus

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

EventBus manages event pub/sub.

func NewEventBus

func NewEventBus() *EventBus

NewEventBus creates a new event bus.

func (*EventBus) AddWebhook

func (eb *EventBus) AddWebhook(wh Webhook)

AddWebhook registers a webhook.

func (*EventBus) Publish

func (eb *EventBus) Publish(e *Event)

Publish publishes an event.

func (*EventBus) Replay

func (eb *EventBus) Replay(filter *FilterRule) []*Event

Replay replays historical events.

func (*EventBus) Subscribe

func (eb *EventBus) Subscribe(id string) chan *Event

Subscribe subscribes to events.

func (*EventBus) Unsubscribe

func (eb *EventBus) Unsubscribe(id string)

Unsubscribe removes a subscriber.

type EventType

type EventType string

EventType represents the type of protocol event.

const (
	EventProtocolChanged EventType = "protocol.changed"
	EventDecodeError     EventType = "decode.error"
	EventValidation      EventType = "validation.complete"
)

type FilterRule

type FilterRule struct {
	Types     []EventType `json:"types,omitempty"`
	Protocols []string    `json:"protocols,omitempty"`
}

FilterRule defines an event filter.

func (*FilterRule) Match

func (f *FilterRule) Match(e *Event) bool

Match checks if an event matches the filter.

type Webhook

type Webhook struct {
	URL    string     `json:"url"`
	Filter FilterRule `json:"filter"`
}

Webhook represents a webhook endpoint.