netspeed

package

v0.0.0-...-c936f35 Latest Latest Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 9 Imported by: 17

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

Repository

github.com/soumya92/barista

Links

Open Source Insights

Documentation ¶

Overview ¶

Package netspeed provides an i3bar module to display network utilisation.

Index ¶

type Module
- func New(iface string) *Module
type Speeds
- func (s Speeds) Connected() bool
- func (s Speeds) Total() unit.Datarate

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Module ¶

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

Module represents a netspeed bar module. It supports setting the output format, click handler, and update frequency.

func New ¶

func New(iface string) *Module

New constructs an instance of the netspeed module for the given interface.

func (*Module) Output ¶

func (m *Module) Output(outputFunc func(Speeds) bar.Output) *Module

Output configures a module to display the output of a user-defined function.

func (*Module) RefreshInterval ¶

func (m *Module) RefreshInterval(interval time.Duration) *Module

RefreshInterval configures the polling frequency for network speed. Since there is no concept of an instantaneous network speed, the speeds will be averaged over this interval before being displayed.

func (*Module) Stream ¶

func (m *Module) Stream(s bar.Sink)

Stream starts the module.

type Speeds ¶

type Speeds struct {
	Rx, Tx unit.Datarate
	// contains filtered or unexported fields
}

Speeds represents bidirectional network traffic.

func (Speeds) Connected ¶

func (s Speeds) Connected() bool

Connected returns true if the network is connected.

func (Speeds) Total ¶

func (s Speeds) Total() unit.Datarate

Total gets the total speed (both up and down).

Source Files ¶

View all Source files

netspeed.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL