events

Documentation

Overview

events defines an event subscriber and dispatcher

Index

• type EmitterInterface
• type Event
• type EventEmitter
  • func (e *EventEmitter) Emit(ctx context.Context, evt Event)
  • func (e *EventEmitter) GlobalChannel(ctx context.Context) <-chan Event
  • func (e *EventEmitter) Subscribe(ctx context.Context) <-chan Event
  • func (e *EventEmitter) UnsubscribeAll()

Types

type EmitterInterface

type EmitterInterface interface {
	// Emit Sends an event to the subscribed listeners
	Emit(context.Context, Event)

	// GlobalChannel returns a glocal channel that receives emitted events
	GlobalChannel(ctx context.Context) <-chan Event

	// Subscribe Returns a channel that receives emitted events
	Subscribe(context.Context) <-chan Event

	// UnsubscribeAll close all listeners channels
	UnsubscribeAll()
}

EmitterInterface Root interface for events dispatch

type Event

type Event interface{}

Event Is a base interface for events

type EventEmitter

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

EventEmitter Registers listeners and dispatches events to them

func (*EventEmitter) Emit

func (e *EventEmitter) Emit(ctx context.Context, evt Event)

func (*EventEmitter) GlobalChannel

func (e *EventEmitter) GlobalChannel(ctx context.Context) <-chan Event

func (*EventEmitter) Subscribe

func (e *EventEmitter) Subscribe(ctx context.Context) <-chan Event

func (*EventEmitter) UnsubscribeAll

func (e *EventEmitter) UnsubscribeAll()