upnpstats

Documentation

Index

• type RouterScanner
  • func New(router *url.URL) (scanner *RouterScanner, err error)
  • func (scanner *RouterScanner) ReportNetworkStats() (stats []Stats, err error)
  • func (scanner *RouterScanner) Routers() (routers []string)
• type Scanner
• type Stats

Types

type RouterScanner

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

RouterScanner scans upnp-enabled routers for network statistics

func New

func New(router *url.URL) (scanner *RouterScanner, err error)

New creates a new RouterScanner. If router is provided, only that URL will be scanned. Otherwise, New will scan the network for compatible routers.

func (*RouterScanner) ReportNetworkStats

func (scanner *RouterScanner) ReportNetworkStats() (stats []Stats, err error)

ReportNetworkStats scans all routers for updated network statistics

func (*RouterScanner) Routers

func (scanner *RouterScanner) Routers() (routers []string)

Routers returns the list of routers

type Scanner

type Scanner interface {
	ReportNetworkStats() (stats []Stats, err error)
	Routers() (routers []string)
}

Scanner interface scans upnp-enabled routers for network statistics

type Stats

type Stats struct {
	RouterURL       string
	PacketsSent     uint32
	PacketsReceived uint32
	BytesSent       uint64
	BytesReceived   uint64
}

Stats contains the statistics scanned from a router