afkdetect

Documentation

Overview

Package afkdetect contains code to detect if the user has gone AFK or returned from AFK.

Index

• Variables
• type Detector
  • func New() Detector
• type Started
• type Stopped

Variables

var (
	ErrObserverIsNil = errors.New("observer is nil")
)

Errors specific to AFK-detectors.

Types

type Detector

type Detector interface {
	// Start makes this detector start listening for OS-specific events to then
	// trigger AFK-started or AFK-stopped events.
	//
	// You need to stop the detector to remove any dangling Goroutines.
	StartDetecting() error
	// StopDetecting makes this detector stop listening for OS-specific events by
	// cleaning up its Goroutines and hooks.
	StopDetecting() error

	StartedObs() *chans.PubSub[Started]
	StoppedObs() *chans.PubSub[Stopped]
}

Detector is an AFK-detector.

func New

func New() Detector

New creates a new AFK-detector.

type Started

type Started struct{}

Started contains event data for when user has gone AFK.

type Stopped

type Stopped struct {
}

Stopped contains event data for when user is no longer AFK (after being AFK).