Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

pcap_set_timeout (3pcap)

Name

pcap_set_timeout - vated capture handle

Synopsis

#include <pcap/pcap.h>

int pcap_set_timeout(pcap_t *p, int to_ms);

Description

PCAP_SET_TIMEOUT(3pcap)                                PCAP_SET_TIMEOUT(3pcap)



NAME
       pcap_set_timeout  -  set  the packet buffer timeout for a not-yet-acti-
       vated capture handle

SYNOPSIS
       #include <pcap/pcap.h>

       int pcap_set_timeout(pcap_t *p, int to_ms);

DESCRIPTION
       pcap_set_timeout() sets the packet buffer timeout that will be used  on
       a  capture  handle  when  the handle is activated to to_ms, which is in
       units of milliseconds.  (See pcap(3PCAP)  for  an  explanation  of  the
       packet buffer timeout.)

       The  behavior,  if the timeout isn't specified, is undefined, as is the
       behavior if the timeout is set to zero or to a negative value.  We rec-
       ommend  always setting the timeout to a non-zero value unless immediate
       mode is set, in which case the timeout has no effect.

RETURN VALUE
       pcap_set_timeout() returns 0  on  success  or  PCAP_ERROR_ACTIVATED  if
       called on a capture handle that has been activated.


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),
       pcap_set_immediate_mode(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_SET_TIMEOUT(3pcap)