mrevent

Documentation

Index

• type EventPool
  • func NewEventPool(bufferSize uint32) *EventPool
  • func (e *EventPool) Emit(eventName string, args mrcore.EventArgs) error
  • func (e *EventPool) EmitWithContext(ctx context.Context, eventName string, args mrcore.EventArgs) error
  • func (e *EventPool) Has(eventName string) bool
  • func (e *EventPool) List() []string
  • func (e *EventPool) Listen(eventName string, handlerFunc mrcore.EventHandlerFunc)
  • func (e *EventPool) Remove(eventNames ...string)
  • func (e *EventPool) Wait()

Types

type EventPool

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

EventPool - thread safe structure stores events, their handlers and functions for management

func NewEventPool

func NewEventPool(bufferSize uint32) *EventPool

func (*EventPool) Emit

func (e *EventPool) Emit(eventName string, args mrcore.EventArgs) error

Emit - Call eventName there

func (*EventPool) EmitWithContext

func (e *EventPool) EmitWithContext(ctx context.Context, eventName string, args mrcore.EventArgs) error

EmitWithContext - Call eventName there

func (*EventPool) Has

func (e *EventPool) Has(eventName string) bool

Has - Checks if there are listeners for the passed eventName

func (*EventPool) List

func (e *EventPool) List() []string

List - Returns a list of events that listeners are subscribed to

func (*EventPool) Listen

func (e *EventPool) Listen(eventName string, handlerFunc mrcore.EventHandlerFunc)

Listen - Subscribe on eventName

func (*EventPool) Remove

func (e *EventPool) Remove(eventNames ...string)

Remove - Removes listeners by event name Removing listeners closes subscribers and stops the goroutine.

If you call the function without the "names" parameter, all listeners of all events will be removed.

func (*EventPool) Wait

func (e *EventPool) Wait()

Wait - Blocks the thread until all running events are completed