notify

Documentation

Overview

Package notify provides a simple notification system.

Index

• func Clean()
• func NewEventID() uint32
• func Publish(ctx context.Context, event uint32, payload any, cb *Callback)
• func Subscribe(event uint32, subscriber Subscriber[any])
• func UnSubscribe(event uint32, subscriber Subscriber[any])
• type Callback
• type Notify
• type Publisher
• type Response
• type Subscriber

Functions

func Clean

func Clean()

Clean resets the subscriber map.

func NewEventID

func NewEventID() uint32

NewEventID generates a new unique event ID.

func Publish

func Publish(ctx context.Context, event uint32, payload any, cb *Callback)

Publish sends an event with a payload to all subscribers. If a callback is provided, it returns the first successful response that matches the response filter.

func Subscribe

func Subscribe(event uint32, subscriber Subscriber[any])

Subscribe adds a subscriber to the specified event.

func UnSubscribe

func UnSubscribe(event uint32, subscriber Subscriber[any])

UnSubscribe removes a subscriber from the specified event.

Types

type Callback

type Callback struct {
	CB             chan<- any
	ResponseFilter string
}

type Notify

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

type Publisher

type Publisher[T any] interface {
	Subscribe(event *int, subscriber Subscriber[T])
	UnSubscribe(subscriber Subscriber[T])
}

type Response

type Response[T any] struct {
	Payload T
	Error   error
	Name    string
}

type Subscriber

type Subscriber[T any] interface {
	Notify(ctx context.Context, event uint32, payload T) Response[T]
}