blob: 723733e73de98275e726179a74d6dfa525366bfd [file] [log] [blame]
JP Abgrall511eca32014-02-12 13:46:45 -08001.\" @(#) $Header: /tcpdump/master/libpcap/pcap_fileno.3pcap,v 1.3 2008-04-06 02:53:22 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_FILENO 3PCAP "5 April 2008"
23.SH NAME
24pcap_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
32int pcap_fileno(pcap_t *p);
33.ft
34.fi
35.SH DESCRIPTION
36If
37.I p
38refers to a network device that was opened for a live capture using
39a combination of
40.B pcap_create()
41and
42.BR pcap_activate() ,
43or using
44.BR pcap_open_live() ,
45.B pcap_fileno()
46returns the file descriptor from which captured packets are read.
47.LP
48If
49.I p
50refers to a ``savefile'' that was opened using functions such as
51.BR pcap_open_offline()
52or
53.BR pcap_fopen_offline() ,
54a ``dead''
55.B pcap_t
56opened using
57.BR pcap_open_dead() ,
58or a
59.B pcap_t
60that was created with
61.B pcap_create()
62but that has not yet been activated with
63.BR pcap_activate() ,
64it returns \-1.
65.SH SEE ALSO
66pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
67pcap_open_live(3PCAP), pcap_open_offline(3PCAP),
68pcap_fopen_offline(3PCAP), pcap_open_dead(3PCAP)