session

package

v1.0.20 Latest Latest Go to latest Published: Jan 23, 2023 License: GPL-3.0 Imports: 9 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

This section is empty.

This section is empty.

This section is empty.

type Session struct {
	sync.Mutex
	PID      int
	Duration time.Duration
	Signals  chan os.Signal
	// contains filtered or unexported fields
}

func New(duration time.Duration, pid int) *Session

Creates a New session instance with duration.

If the session's duration is 0, the session will stop after a termination signal or a call to session.Stop.

func (s *Session) Active() bool

A Boolean for session status

func (s *Session) Kill() error

Kill terminates the current session.

Can be called only when Wait is running in the background.

func (s *Session) Start() error

Starts the session (according to https://people.freedesktop.org/~hadess/idle-inhibition-spec/re01.html) with a call to the D-BUS screensaver inhibitor.

A non-nil error is returned if the D-BUS session connection fails, if the inhabitation call fails or if the cookie recovery fails.

func (s *Session) Stop() error

Stop kills an already-started session while Wait is not running in the background.

This method is recommended for uses in which the session is required to terminate only by the calling program, and not by the user.

func (s *Session) Wait() error

Wait can be called only after Start has been called successfully.

Wait will block further execution until the user send an interrupt signal, or until the session duration has passed.

A non-nil error is returned if the un-inhabitation call fails.