netdev

Documentation

Overview

Package netdev gets the system's network device information: /proc/net/dev. Instead of returning a Go struct, it returns JSON serialized bytes. A function to deserialize the JSON serialized bytes into a structs.DevInfo struct is provided.

Note: the package name is netdev and not the final element of the import path (json).

Index

• func Deserialize(p []byte) (*structs.DevInfo, error)
• func Get() (p []byte, err error)
• func Marshal(inf *structs.DevInfo) ([]byte, error)
• func NewTicker(d time.Duration) (joe.Tocker, error)
• func Serialize(inf *structs.DevInfo) (p []byte, err error)
• func Unmarshal(p []byte) (*structs.DevInfo, error)
• type Profiler
  • func NewProfiler() (prof *Profiler, err error)
  • func (prof *Profiler) Get() (p []byte, err error)
  • func (prof *Profiler) Marshal(inf *structs.DevInfo) ([]byte, error)
  • func (prof *Profiler) Serialize(inf *structs.DevInfo) ([]byte, error)
• type Ticker
  • func (t *Ticker) Close()
  • func (t *Ticker) Run()

Functions

func Deserialize

func Deserialize(p []byte) (*structs.DevInfo, error)

Deserialize takes some JSON serialized bytes and unmarshals them as structs.DevInfo

func Get

func Get() (p []byte, err error)

Get returns the current network device information as JSON serialized bytes using the package's global Profiler.

func Marshal

func Marshal(inf *structs.DevInfo) ([]byte, error)

Marshal is an alias for Serialize; uses 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.

func Serialize

func Serialize(inf *structs.DevInfo) (p []byte, err error)

Serialize network device information as JSON using the package's global Profiler.

func Unmarshal

func Unmarshal(p []byte) (*structs.DevInfo, error)

Unmarshal is an alias for Deserialize.

Types

type Profiler

type Profiler struct {
	*dev.Profiler
}

Profiler is used to process the network device information as JSON 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() (p []byte, err error)

Get returns the current network device information as JSON serialized bytes.

func (*Profiler) Marshal

func (prof *Profiler) Marshal(inf *structs.DevInfo) ([]byte, error)

Marshal is an alias for Serialize.

func (*Profiler) Serialize

func (prof *Profiler) Serialize(inf *structs.DevInfo) ([]byte, error)

Serialize network device information as JSON.

type Ticker

type Ticker struct {
	*joe.Ticker
	Data chan []byte
	*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.