notify

Documentation

Overview

Package notify implements a touch notification system.

Index

• type Notify
  • func New(log *zap.Logger, touchNotifyDelay time.Duration) *Notify
  • func (n *Notify) Touch() context.CancelFunc

Types

type Notify

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

Notify contains touch notification configuration.

func New

func New(log *zap.Logger, touchNotifyDelay time.Duration) *Notify

New initialises a new Notify struct.

func (*Notify) Touch

func (n *Notify) Touch() context.CancelFunc

Touch starts a goroutine, and waits for a short period. If the returned CancelFunc has not been called it sends a notification to remind the user to physically touch the Security Key.