lock

README

lock

A simple Golang package to get notified when the screen gets locked.

⚠️ Warnings:

1. This was developed as an experiment and may not always work.
2. It currently supports only macOS, Windows and Linux.
3. Not tested on all linux desktops

Installation

go get -u github.com/IamFaizanKhalid/lock

Usage Example

package main

import (
	"fmt"
	"time"

	"github.com/IamFaizanKhalid/lock"
)

func main() {
	if lock.IsScreenLocked() {
		fmt.Println("Screen is locked...")
	} else {
		fmt.Println("Screen is not locked...")
	}

	lock.HandleEvents(lockEventHandler)
}

func lockEventHandler(e lock.Event) {
	fmt.Print(e.Time.Format(time.TimeOnly), "\t")
	if e.Locked {
		fmt.Println("screen locked")
	} else {
		fmt.Println("screen unlocked")
	}
}

License

MIT License

Documentation

Index

• func HandleEvents(h EventHandler)
• func IsScreenLocked() bool
• func Notify() <-chan Event
• type Event
• type EventHandler

Functions

func HandleEvents

func HandleEvents(h EventHandler)

func IsScreenLocked

func IsScreenLocked() bool

func Notify

func Notify() <-chan Event

Types

type Event

type Event struct {
	Time   time.Time
	Locked bool
}

type EventHandler

type EventHandler func(e Event)