contrib/libpcap/pcap_offline_filter.3pcap

   1 .\" Copyright (c) 1994, 1996, 1997
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .TH PCAP_OFFLINE_FILTER 3PCAP "7 April 2014"
  21 .SH NAME
  22 pcap_offline_filter \- check whether a filter matches a packet
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .ft B
  30 int pcap_offline_filter(const struct bpf_program *fp,
  31 .ti +8
  32 const struct pcap_pkthdr *h, const u_char *pkt)
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_offline_filter()
  37 checks whether a filter matches a packet.
  38 .I fp
  39 is a pointer to a
  40 .I bpf_program
  41 struct, usually the result of a call to
  42 .BR pcap_compile(3PCAP) .
  43 .I h
  44 points to the
  45 .I pcap_pkthdr
  46 structure for the packet, and
  47 .I pkt
  48 points to the data in the packet.
  49 .SH RETURN VALUE
  50 .B pcap_offline_filter()
  51 returns the return value of the filter program.  This will be zero if
  52 the packet doesn't match the filter and non-zero if the packet matches
  53 the filter.
  54 .SH SEE ALSO
  55 pcap(3PCAP)