monitors

README

monitors

About

monitors is a package for Go. It offers functions to query monitor metrics. It is published on https://github.com/vbsw/monitors.

Copyright

Copyright 2021, Vitali Baumtrok (vbsw@mailbox.org).

monitors is distributed under the Boost Software License, version 1.0. (See accompanying file LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt)

monitors is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Boost Software License for more details.

References

• https://golang.org/doc/install
• https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
• https://dave.cheney.net/2013/10/12/how-to-use-conditional-compilation-with-the-go-build-tool

Documentation

Overview

Package monitors provides monitor metrics.

Index

• func Index(mtr *Monitor) int
• type Monitor
  • func All() []*Monitor
  • func Default() *Monitor
  • func (monitor *Monitor) Equals(mtr *Monitor) bool

Functions

func Index

func Index(mtr *Monitor) int

Index returns the index of monitor in list from function All(). If monitor is not in list, the index of default monitor is returned. At failure, -1 is returned.

Types

type Monitor

type Monitor struct {
	X, Y, Width, Height int
	Default             bool
	InternalData        unsafe.Pointer
}

Monitor holds metrics of monitor.

func All

func All() []*Monitor

All returns all available monitors. At failure, nil is returned.

func Default

func Default() *Monitor

Default returns the default monitor. At failure, nil is returned.

func (*Monitor) Equals

func (monitor *Monitor) Equals(mtr *Monitor) bool

Equals returns true, if both monitors reference the same monitor.