external/bsd/libpcap/dist/pcap_fileno.3pcap

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