package cpu

Import Path
	github.com/shirou/gopsutil/v3/cpu (on go.dev)

Dependency Relation
	imports 13 packages, and imported by one package

Involved Source Files

	    cpu.go
	    cpu_linux.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type InfoStat (struct)

		Fields (total 13)
			CPU int32
			CacheSize int32
			CoreID string
			Cores int32
			Family string
			Flags []string
			Mhz float64
			Microcode string
			Model string
			ModelName string
			PhysicalID string
			Stepping int32
			VendorID string
		Methods (only one)
			( InfoStat) String() string
		Implements (at least 2)
			 InfoStat : expvar.Var
			 InfoStat : fmt.Stringer
		As Outputs Of (at least 2)
			func Info() ([]InfoStat, error)
			func InfoWithContext(ctx context.Context) ([]InfoStat, error)

	 type TimesStat (struct)
		TimesStat contains the amounts of time the CPU has spent performing different
		kinds of work. Time units are in seconds. It is based on linux /proc/stat file.

		Fields (total 11)
			CPU string
			Guest float64
			GuestNice float64
			Idle float64
			Iowait float64
			Irq float64
			Nice float64
			Softirq float64
			Steal float64
			System float64
			User float64
		Methods (total 2)
			( TimesStat) String() string
			( TimesStat) Total() float64
				Deprecated: Total returns the total number of seconds in a CPUTimesStat
				Please do not use this internal function.

		Implements (at least 2)
			 TimesStat : expvar.Var
			 TimesStat : fmt.Stringer
		As Outputs Of (at least 6)
			func Times(percpu bool) ([]TimesStat, error)
			func TimesWithContext(ctx context.Context, percpu bool) ([]TimesStat, error)
			func github.com/shirou/gopsutil/v3/process.(*Process).Threads() (map[int32]*TimesStat, error)
			func github.com/shirou/gopsutil/v3/process.(*Process).ThreadsWithContext(ctx context.Context) (map[int32]*TimesStat, error)
			func github.com/shirou/gopsutil/v3/process.(*Process).Times() (*TimesStat, error)
			func github.com/shirou/gopsutil/v3/process.(*Process).TimesWithContext(ctx context.Context) (*TimesStat, error)


Package-Level Functions (total 8)

	 func Counts(logical bool) (int, error)
		Counts returns the number of physical or logical cores in the system

	 func CountsWithContext(ctx context.Context, logical bool) (int, error)
	 func Info() ([]InfoStat, error)
		CPUInfo on linux will return 1 item per physical thread.
		
		CPUs have three levels of counting: sockets, cores, threads.
		Cores with HyperThreading count as having 2 threads per core.
		Sockets often come with many physical CPU cores.
		For example a single socket board with two cores each with HT will
		return 4 CPUInfoStat structs on Linux and the "Cores" field set to 1.

	 func InfoWithContext(ctx context.Context) ([]InfoStat, error)
	 func Percent(interval time.Duration, percpu bool) ([]float64, error)
		Percent calculates the percentage of cpu used either per CPU or combined.
		If an interval of 0 is given it will compare the current cpu times against the last call.
		Returns one value per cpu, or a single value if percpu is set to false.

	 func PercentWithContext(ctx context.Context, interval time.Duration, percpu bool) ([]float64, error)
	 func Times(percpu bool) ([]TimesStat, error)
	 func TimesWithContext(ctx context.Context, percpu bool) ([]TimesStat, error)
Package-Level Variables (only one)

	  var ClocksPerSec float64

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.