contrib/libpcap/pcap_fileno.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_FILENO 3PCAP "7 April 2014"
  21 .SH NAME
  22 pcap_fileno \- get the file descriptor for a live capture
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .ft B
  30 int pcap_fileno(pcap_t *p);
  31 .ft
  32 .fi
  33 .SH DESCRIPTION
  34 If
  35 .I p
  36 refers to a network device that was opened for a live capture using
  37 a combination of
  38 .B pcap_create()
  39 and
  40 .BR pcap_activate() ,
  41 or using
  42 .BR pcap_open_live() ,
  43 .B pcap_fileno()
  44 returns the file descriptor from which captured packets are read.
  45 .LP
  46 If
  47 .I p
  48 refers to a ``savefile'' that was opened using functions such as
  49 .BR pcap_open_offline()
  50 or
  51 .BR pcap_fopen_offline() ,
  52 a ``dead''
  53 .B pcap_t
  54 opened using
  55 .BR pcap_open_dead() ,
  56 or a
  57 .B pcap_t
  58 that was created with
  59 .B pcap_create()
  60 but that has not yet been activated with
  61 .BR pcap_activate() ,
  62 it returns \-1.
  63 .SH SEE ALSO
  64 pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
  65 pcap_open_live(3PCAP), pcap_open_offline(3PCAP),
  66 pcap_fopen_offline(3PCAP), pcap_open_dead(3PCAP)