netdev

Documentation

Overview

Package netdev gets the system's network device information: /proc/net/dev.

Index

• Constants
• func Get() (inf *structs.DevInfo, err error)
• func NewTicker(d time.Duration) (joe.Tocker, error)
• type Profiler
  • func NewProfiler() (prof *Profiler, err error)
  • func (prof *Profiler) Get() (*structs.DevInfo, error)
  • func (prof *Profiler) Reset() error
• type Ticker
  • func (t *Ticker) Close()
  • func (t *Ticker) Run()

Constants

const ProcFile = "/proc/net/dev"

ProcFile is the file used by the netdev Profiler.

Functions

func Get

func Get() (inf *structs.DevInfo, err error)

Get returns the current network device information using the package's global Profiler.

func NewTicker

func NewTicker(d time.Duration) (joe.Tocker, error)

NewTicker returns a new Ticker containing a Data channel that delivers the data at intervals and an error channel that delivers any errors encountered. Stop the ticker to signal the ticker to stop running. Stopping the ticker does not close the Data channel; call Close to close both the ticker and the data channel.

Types

type Profiler

type Profiler struct {
	joe.Procer
	*joe.Buffer
}

Profiler is used to process the network device information using the /proc/net/dev file.

func NewProfiler

func NewProfiler() (prof *Profiler, err error)

Returns an initialized Profiler; ready to use.

func (*Profiler) Get

func (prof *Profiler) Get() (*structs.DevInfo, error)

Get returns the current network device information.

func (*Profiler) Reset

func (prof *Profiler) Reset() error

Reset resources: after reset, the profiler is ready to be used again.

type Ticker

type Ticker struct {
	*joe.Ticker
	Data chan *structs.DevInfo
	*Profiler
}

Ticker delivers the system's network device information at intervals.

func (*Ticker) Close

func (t *Ticker) Close()

Close closes the ticker resources.

func (*Ticker) Run

func (t *Ticker) Run()

Run runs the ticker.