doc: add doc for eventbus package

eventbus/eventbus.go

@@ -33,6 +33,7 @@ type EventListener[T any] struct {
 }
 
 // NewEventBus creates a new EventBus.
+// Play: todo
 func NewEventBus[T any]() *EventBus[T] {
 	return &EventBus[T]{
 		listeners: sync.Map{},
@@ -40,6 +41,7 @@ func NewEventBus[T any]() *EventBus[T] {
 }
 
 // Subscribe subscribes to an event with a specific event topic and listener function.
+// Play: todo
 func (eb *EventBus[T]) Subscribe(topic string, listener func(eventData T), async bool, priority int, filter func(eventData T) bool) {
 	eb.mu.Lock()
 	defer eb.mu.Unlock()
@@ -63,6 +65,7 @@ func (eb *EventBus[T]) Subscribe(topic string, listener func(eventData T), async
 }
 
 // Unsubscribe unsubscribes from an event with a specific event topic and listener function.
+// Play: todo
 func (eb *EventBus[T]) Unsubscribe(topic string, listener func(eventData T)) {
 	eb.mu.Lock()
 	defer eb.mu.Unlock()
@@ -86,6 +89,7 @@ func (eb *EventBus[T]) Unsubscribe(topic string, listener func(eventData T)) {
 }
 
 // Publish publishes an event with a specific event topic and data payload.
+// Play: todo
 func (eb *EventBus[T]) Publish(event Event[T]) {
 	eb.mu.RLock()
 	defer eb.mu.RUnlock()
@@ -126,6 +130,7 @@ func (eb *EventBus[T]) SetErrorHandler(handler func(err error)) {
 }
 
 // ClearListeners clears all the listeners.
+// Play: todo
 func (eb *EventBus[T]) ClearListeners() {
 	eb.mu.Lock()
 	defer eb.mu.Unlock()
@@ -134,6 +139,7 @@ func (eb *EventBus[T]) ClearListeners() {
 }
 
 // ClearListenersByTopic clears all the listeners by topic.
+// Play: todo
 func (eb *EventBus[T]) ClearListenersByTopic(topic string) {
 	eb.mu.Lock()
 	defer eb.mu.Unlock()
@@ -142,6 +148,7 @@ func (eb *EventBus[T]) ClearListenersByTopic(topic string) {
 }
 
 // GetListenersCount returns the number of listeners for a specific event topic.
+// Play: todo
 func (eb *EventBus[T]) GetListenersCount(topic string) int {
 	eb.mu.RLock()
 	defer eb.mu.RUnlock()
@@ -156,6 +163,7 @@ func (eb *EventBus[T]) GetListenersCount(topic string) int {
 }
 
 // GetAllListenersCount returns the total number of listeners.
+// Play: todo
 func (eb *EventBus[T]) GetAllListenersCount() int {
 	eb.mu.RLock()
 	defer eb.mu.RUnlock()
@@ -170,6 +178,7 @@ func (eb *EventBus[T]) GetAllListenersCount() int {
 }
 
 // GetEvents returns all the events topics.
+// Play: todo
 func (eb *EventBus[T]) GetEvents() []string {
 	eb.mu.RLock()
 	defer eb.mu.RUnlock()

eventbus/eventbus_example_test.go

@@ -0,0 +1,229 @@
+package eventbus
+
+import (
+	"fmt"
+	"sync"
+	"time"
+)
+
+func ExampleEventBus_Subscribe() {
+	eb := NewEventBus[string]()
+	eb.Subscribe("event1", func(eventData string) {
+		fmt.Println(eventData)
+	}, false, 0, nil)
+
+	eb.Publish(Event[string]{Topic: "event1", Payload: "hello"})
+
+	// Output:
+	// hello
+}
+
+func ExampleEventBus_Unsubscribe() {
+	eb := NewEventBus[int]()
+
+	receivedData := 0
+	listener := func(eventData int) {
+		receivedData = eventData
+	}
+
+	eb.Subscribe("event1", listener, false, 0, nil)
+	eb.Unsubscribe("event1", listener)
+
+	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+
+	fmt.Println(receivedData)
+
+	// Output:
+	// 0
+}
+
+func ExampleEventBus_Subscribe_WithFilter() {
+	eb := NewEventBus[int]()
+
+	receivedData := 0
+	listener := func(eventData int) {
+		receivedData = eventData
+	}
+
+	filter := func(eventData int) bool {
+		return eventData == 1
+	}
+
+	eb.Subscribe("event1", listener, false, 0, filter)
+
+	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+	eb.Publish(Event[int]{Topic: "event1", Payload: 2})
+
+	fmt.Println(receivedData)
+
+	// Output:
+	// 1
+}
+
+func ExampleEventBus_Subscribe_WithPriority() {
+	eb := NewEventBus[int]()
+
+	eb.Subscribe("event1", func(eventData int) {
+		fmt.Println(eventData)
+	}, false, 0, nil)
+
+	eb.Subscribe("event1", func(eventData int) {
+		fmt.Println(eventData)
+	}, false, 1, nil)
+
+	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+
+	// Output:
+	// 1
+	// 1
+}
+
+func ExampleEventBus_Subscribe_Async() {
+	eb := NewEventBus[int]()
+
+	var wg sync.WaitGroup
+	wg.Add(1)
+
+	eb.Subscribe("event1", func(eventData int) {
+		time.Sleep(100 * time.Millisecond)
+		fmt.Println(eventData)
+		wg.Done()
+	}, true, 1, nil)
+
+	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+	wg.Wait()
+
+	// Output:
+	// 1
+}
+
+func ExampleEventBus_Publish() {
+	eb := NewEventBus[int]()
+
+	eb.Subscribe("event1", func(eventData int) {
+		fmt.Println(eventData)
+	}, false, 0, nil)
+
+	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+
+	// Output:
+	// 1
+}
+
+func ExampleEventBus() {
+	eb := NewEventBus[int]()
+
+	receivedData := 0
+	listener := func(eventData int) {
+		receivedData = eventData
+	}
+
+	eb.Subscribe("event1", listener, false, 0, nil)
+	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+
+	fmt.Println(receivedData)
+
+	// Output:
+	// 1
+}
+
+func ExampleEventBus_ClearListeners() {
+	eb := NewEventBus[int]()
+
+	receivedData := 0
+	listener := func(eventData int) {
+		receivedData = eventData
+	}
+
+	eb.Subscribe("event1", listener, false, 0, nil)
+	eb.ClearListeners()
+
+	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+
+	fmt.Println(receivedData)
+
+	// Output:
+	// 0
+}
+
+func ExampleEventBus_ClearListenersByTopic() {
+	eb := NewEventBus[int]()
+
+	receivedData := 0
+	listener := func(eventData int) {
+		receivedData = eventData
+	}
+
+	eb.Subscribe("event1", listener, false, 0, nil)
+	eb.ClearListenersByTopic("event1")
+
+	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+
+	fmt.Println(receivedData)
+
+	// Output:
+	// 0
+}
+
+func ExampleEventBus_GetListenersCount() {
+	eb := NewEventBus[int]()
+
+	eb.Subscribe("event1", func(eventData int) {}, false, 0, nil)
+	eb.Subscribe("event1", func(eventData int) {}, false, 0, nil)
+
+	count := eb.GetListenersCount("event1")
+
+	fmt.Println(count)
+
+	// Output:
+	// 2
+}
+
+func ExampleEventBus_SetErrorHandler() {
+	eb := NewEventBus[int]()
+
+	eb.SetErrorHandler(func(err error) {
+		fmt.Println(err)
+	})
+
+	eb.Subscribe("event1", func(eventData int) {
+		panic("error")
+	}, false, 0, nil)
+
+	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+
+	// Output:
+	// error
+}
+
+func ExampleEventBus_GetAllListenersCount() {
+
+	eb := NewEventBus[int]()
+
+	eb.Subscribe("event1", func(eventData int) {}, false, 0, nil)
+	eb.Subscribe("event2", func(eventData int) {}, false, 0, nil)
+
+	count := eb.GetAllListenersCount()
+
+	fmt.Println(count)
+
+	// Output:
+	// 2
+}
+
+func ExampleEventBus_GetEvents() {
+	eb := NewEventBus[int]()
+
+	eb.Subscribe("event1", func(eventData int) {}, false, 0, nil)
+	eb.Subscribe("event2", func(eventData int) {}, false, 0, nil)
+
+	events := eb.GetEvents()
+
+	for _, event := range events {
+		fmt.Println(event)
+	}
+
+	// Output:
+	// event1
+	// event2
+}