events

Documentation

Overview

Package events provides management and structs for Eludris gateway events.

Index

• func Subscribe[E Event](m EventManager, subscriber func(E, interfaces.Client))
• type Event
• type EventListener
• type EventManager
  • func NewEventManager() EventManager
• type MessageEvent
  • func (*MessageEvent) Op() string
• type PongEvent
  • func (*PongEvent) Op() string

Functions

func Subscribe

func Subscribe[E Event](m EventManager, subscriber func(E, interfaces.Client))

Subscribe allows you to subscribe to an event to the given manager. This infers the event type from the function signature.

Types

type Event

type Event interface {
	Op() string
}

Event represents the base fields for all events.

type EventListener

type EventListener interface {
	Handle(Event, interfaces.Client)
	Op() string
	Func() func(Event, interfaces.Client)
}

type EventManager

type EventManager interface {
	Subscribe(EventListener)
	Dispatch(interfaces.Client, []byte)
}

EventManager manages events, allowing you to subscribe to them.

func NewEventManager

func NewEventManager() EventManager

NewEventManager creates a new event manager.

type MessageEvent

type MessageEvent struct {
	Content string `mapstructure:"content"`
	Author  string `mapstructure:"author"`
}

MessageEvent represents a received message from Eludris.

func (*MessageEvent) Op

func (*MessageEvent) Op() string

type PongEvent

type PongEvent struct{}

func (*PongEvent) Op

func (*PongEvent) Op() string