membasic

Documentation

Overview

Package membasic processes a subset of the /proc/meminfo file. Instead of returning a Go struct, it returns Flatbuffer serialized bytes. A function to deserialize the Flatbuffer serialized bytes into a membasic.Info struct is provided. For more detailed information about a system's memory, use the meminfo package.

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

Index

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

Functions

func Deserialize

func Deserialize(p []byte) *basic.Info

Deserialize takes some Flatbuffer serialized bytes and deserializes them as membasic.Info.

func Get

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

Get returns the current basic memory information as Flatbuffer serialized bytes 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.

func Serialize

func Serialize(inf *basic.Info) (p []byte, err error)

Serialize the basic memory information using Flatbuffers with the package's global Profiler.

Types

type Profiler

type Profiler struct {
	*basic.Profiler
	*fb.Builder
}

Profiler is used to get the basic memory information as Flatbuffer serialized by processing the /proc/meminfo file.

func NewProfiler

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

Returns an initialized Profiler that utilizes FlatBuffers; ready to use.

func (*Profiler) Get

func (prof *Profiler) Get() ([]byte, error)

Get returns the current basic memory information as Flatbuffer serialized bytes.

func (*Profiler) Serialize

func (prof *Profiler) Serialize(inf *basic.Info) []byte

Serialize the basic memory information using Flatbuffers.

type Ticker

type Ticker struct {
	*joe.Ticker
	Data chan []byte
	*Profiler
}

Ticker delivers the system's basic memory 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.