Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

pcap_open_live (3pcap)

Name

pcap_open_live - open a device for capturing

Synopsis

#include <pcap/pcap.h>

char errbuf[PCAP_ERRBUF_SIZE];

pcap_t *pcap_open_live(const char *device, int snaplen,
int promisc, int to_ms, char *errbuf);

Description

PCAP_OPEN_LIVE(3pcap)                                    PCAP_OPEN_LIVE(3pcap)



NAME
       pcap_open_live - open a device for capturing

SYNOPSIS
       #include <pcap/pcap.h>

       char errbuf[PCAP_ERRBUF_SIZE];

       pcap_t *pcap_open_live(const char *device, int snaplen,
               int promisc, int to_ms, char *errbuf);

DESCRIPTION
       pcap_open_live()  is  used to obtain a packet capture handle to look at
       packets on the network.  device is a string that specifies the  network
       device  to  open;  on Linux systems with 2.2 or later kernels, a device
       argument of "any" or NULL can be  used  to  capture  packets  from  all
       interfaces.

       snaplen specifies the snapshot length to be set on the handle.

       promisc specifies if the interface is to be put into promiscuous mode.

       to_ms  specifies the packet buffer timeout, as a non-negative value, in
       milliseconds.  (See pcap(3PCAP) for an explanation of the packet buffer
       timeout.)

RETURN VALUE
       pcap_open_live() returns a pcap_t * on success and NULL on failure.  If
       NULL is returned, errbuf is filled in with an  appropriate  error  mes-
       sage.   errbuf  may  also  be set to warning text when pcap_open_live()
       succeeds; to detect this case the caller  should  store  a  zero-length
       string  in errbuf before calling pcap_open_live() and display the warn-
       ing to the user if errbuf is no longer a zero-length string.  errbuf is
       assumed to be able to hold at least PCAP_ERRBUF_SIZE chars.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE     |
       +---------------+------------------------+
       |Availability   | system/library/libpcap |
       +---------------+------------------------+
       |Stability      | Uncommitted            |
       +---------------+------------------------+

SEE ALSO
       pcap_create(3PCAP), pcap_activate(3PCAP)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://www.tcpdump.org/release/libp-
       cap-1.9.1.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.tcpdump.org/.



                                6 December 2017          PCAP_OPEN_LIVE(3pcap)