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

   1 .\"     $NetBSD: pcap_get_selectable_fd.3pcap,v 1.3 2015/03/31 21:39:42 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_GET_SELECTABLE_FD 3PCAP "22 July 2011"
  23 .SH NAME
  24 pcap_get_selectable_fd \- get a file descriptor on which a select() can
  25 be done for a live capture
  26 .SH SYNOPSIS
  27 .nf
  28 .ft B
  29 #include <pcap/pcap.h>
  30 .ft
  31 .LP
  32 .ft B
  33 int pcap_get_selectable_fd(pcap_t *p);
  34 .ft
  35 .fi
  36 .SH DESCRIPTION
  37 .B pcap_get_selectable_fd()
  38 returns, on UNIX, a file descriptor number for a file descriptor on
  39 which one can
  40 do a
  41 .BR select() ,
  42 .BR poll() ,
  43 or other such call
  44 to wait for it to be possible to read packets without blocking, if such
  45 a descriptor exists, or \-1, if no such descriptor exists.  Some network
  46 devices opened with
  47 .B pcap_create()
  48 and
  49 .BR pcap_activate() ,
  50 or with
  51 .BR pcap_open_live() ,
  52 do not support
  53 .B select()
  54 or
  55 .B poll()
  56 (for example, regular network devices on FreeBSD 4.3 and 4.4, and Endace
  57 DAG devices), so \-1 is returned for those devices.
  58 .PP
  59 Note that a descriptor on which a read can be done without blocking may,
  60 on some platforms, not have any packets to read if the read timeout has
  61 expired.  A call to
  62 .B pcap_dispatch()
  63 will return 0 in this case, but will not block.
  64 .PP
  65 Note that in:
  66 .IP
  67 FreeBSD prior to FreeBSD 4.6;
  68 .IP
  69 NetBSD prior to NetBSD 3.0;
  70 .IP
  71 OpenBSD prior to OpenBSD 2.4;
  72 .IP
  73 Mac OS X prior to Mac OS X 10.7;
  74 .PP
  75 .B select()
  76 and
  77 .B poll()
  78 do not work correctly on BPF devices;
  79 .B pcap_get_selectable_fd()
  80 will return a file descriptor on most of those versions (the exceptions
  81 being FreeBSD 4.3 and 4.4), but a simple
  82 .B select()
  83 or
  84 .B poll()
  85 will not indicate that the descriptor is readable until a full buffer's
  86 worth of packets is received, even if the read timeout expires before
  87 then.  To work around this, an application that uses
  88 .B select()
  89 or
  90 .B poll()
  91 to wait for packets to arrive must put the
  92 .B pcap_t
  93 in non-blocking mode, and must arrange that the
  94 .B select()
  95 or
  96 .B poll()
  97 have a timeout less than or equal to the read timeout,
  98 and must try to read packets after that timeout expires, regardless of
  99 whether
 100 .B select()
 101 or
 102 .B poll()
 103 indicated that the file descriptor for the
 104 .B pcap_t
 105 is ready to be read or not.  (That workaround will not work in FreeBSD
 106 4.3 and later; however, in FreeBSD 4.6 and later,
 107 .B select()
 108 and
 109 .B poll()
 110 work correctly on BPF devices, so the workaround isn't necessary,
 111 although it does no harm.)
 112 .PP
 113 Note also that
 114 .B poll()
 115 doesn't work on character special files, including BPF devices, in Mac
 116 OS X 10.4 and 10.5, so, while
 117 .B select()
 118 can be used on the descriptor returned by
 119 .BR pcap_get_selectable_fd() ,
 120 .B poll()
 121 cannot be used on it those versions of Mac OS X.  Kqueues also don't
 122 work on that descriptor.
 123 .BR poll() ,
 124 but not kqueues, work on that descriptor in Mac OS X releases prior to
 125 10.4;
 126 .B poll()
 127 and kqueues work on that descriptor in Mac OS X 10.6 and later.
 128 .PP
 129 .B pcap_get_selectable_fd()
 130 is not available on Windows.
 131 .SH RETURN VALUE
 132 A selectable file descriptor is returned if one exists; otherwise, \-1
 133 is returned.
 134 .SH SEE ALSO
 135 pcap(3PCAP), select(2), poll(2)