contrib/libpcap/pcap_stats.3pcap

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_stats.3pcap,v 1.1.2.3 2008-04-06 03:21:56 guy Exp $
   2 .\"
   3 .\" Copyright (c) 1994, 1996, 1997
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that: (1) source code distributions
   8 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   9 .\" distributions including binary code include the above copyright notice and
  10 .\" this paragraph in its entirety in the documentation or other materials
  11 .\" provided with the distribution, and (3) all advertising materials mentioning
  12 .\" features or use of this software display the following acknowledgement:
  13 .\" ``This product includes software developed by the University of California,
  14 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  15 .\" the University nor the names of its contributors may be used to endorse
  16 .\" or promote products derived from this software without specific prior
  17 .\" written permission.
  18 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  19 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  20 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  21 .\"
  22 .TH PCAP_SNAPSHOT 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_stats \- get capture statistics
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap/pcap.h>
  29 .ft
  30 .LP
  31 .ft B
  32 int pcap_stats(pcap_t *p, struct pcap_stat *ps);
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_stats()
  37 fills in the
  38 .I pcap_stat
  39 structure pointed to by its second argument.  The values represent
  40 packet statistics from the start of the run to the time of the call.
  41 .PP
  42 .B pcap_stats()
  43 is supported only on live captures, not on ``savefiles''; no statistics
  44 are stored in ``savefiles'', so no statistics are available when reading
  45 from a ``savefile''.
  46 .SH RETURN VALUE
  47 .B pcap_stats()
  48 returns 0 on success and returns \-1 if there is an error or the
  49 .I p
  50 doesn't support packet statistics.
  51 If \-1 is returned,
  52 .B pcap_geterr()
  53 or
  54 .B pcap_perror()
  55 may be called with
  56 .I p
  57 as an argument to fetch or display the error text.
  58 .SH SEE ALSO
  59 pcap(3PCAP), pcap_geterr(3PCAP)