Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   31170 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

Sys::Statistics::LinuxUsertContributed PerlSys::Statistics::Linux::NetStats(3)

NAME
       Sys::Statistics::Linux::NetStats - Collect linux net statistics.

SYNOPSIS
	   use Sys::Statistics::Linux::NetStats;

	   my $lxs = Sys::Statistics::Linux::NetStats->new;
	   $lxs->init;
	   sleep 1;
	   my $stat = $lxs->get;

       Or

	   my $lxs = Sys::Statistics::Linux::NetStats->new(initfile => $file);
	   $lxs->init;
	   my $stat = $lxs->get;

DESCRIPTION
       Sys::Statistics::Linux::NetStats gathers net statistics from the
       virtual /proc filesystem (procfs).

       For more information read the documentation of the front-end module
       Sys::Statistics::Linux.

NET STATISTICS
       Generated by /proc/net/dev.

	   rxbyt    -  Number of bytes received per second.
	   rxpcks   -  Number of packets received per second.
	   rxerrs   -  Number of errors that happend while received packets per second.
	   rxdrop   -  Number of packets that were dropped per second.
	   rxfifo   -  Number of FIFO overruns that happend on received packets per second.
	   rxframe  -  Number of carrier errors that happend on received packets per second.
	   rxcompr  -  Number of compressed packets received per second.
	   rxmulti  -  Number of multicast packets received per second.
	   txbyt    -  Number of bytes transmitted per second.
	   txpcks   -  Number of packets transmitted per second.
	   txerrs   -  Number of errors that happend while transmitting packets per second.
	   txdrop   -  Number of packets that were dropped per second.
	   txfifo   -  Number of FIFO overruns that happend on transmitted packets per second.
	   txcolls  -  Number of collisions that were detected per second.
	   txcarr   -  Number of carrier errors that happend on transmitted packets per second.
	   txcompr  -  Number of compressed packets transmitted per second.
	   ttpcks   -  Number of total packets (received + transmitted) per second.
	   ttbyt    -  Number of total bytes (received + transmitted) per second.

METHODS
   new()
       Call "new()" to create a new object.

	   my $lxs = Sys::Statistics::Linux::NetStats->new;

       Maybe you want to store/load the initial statistics to/from a file:

	   my $lxs = Sys::Statistics::Linux::NetStats->new(initfile => '/tmp/netstats.yml');

       If you set "initfile" it's not necessary to call sleep before "get()".

       It's also possible to set the path to the proc filesystem.

	    Sys::Statistics::Linux::NetStats->new(
	       files => {
		   # This is the default
		   path	  => '/proc',
		   netdev => 'net/dev',
	       }
	   );

   init()
       Call "init()" to initialize the statistics.

	   $lxs->init;

   get()
       Call "get()" to get the statistics. "get()" returns the statistics as a
       hash reference.

	   my $stat = $lxs->get;

   raw()
       The same as get_raw() but it's not necessary to call init() first.

   get_raw()
       Call "get_raw()" to get the raw data - no deltas.

EXPORTS
       No exports.

SEE ALSO
       proc(5)

REPORTING BUGS
       Please report all bugs to <jschulz.cpan(at)bloonix.de>.

AUTHOR
       Jonny Schulz <jschulz.cpan(at)bloonix.de>.

COPYRIGHT
       Copyright (c) 2006, 2007 by Jonny Schulz. All rights reserved.

       This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

perl v5.14.1			  2011-06-2Sys::Statistics::Linux::NetStats(3)

Vote for polarhome