contrib/libpcap/pcap_set_timeout.3pcap

   1 .\" Copyright (c) 1994, 1996, 1997
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .TH PCAP_SET_TIMEOUT 3PCAP "6 December 2017"
  21 .SH NAME
  22 pcap_set_timeout \- set the packet buffer timeout for a
  23 not-yet-activated capture handle
  24 .SH SYNOPSIS
  25 .nf
  26 .ft B
  27 #include <pcap/pcap.h>
  28 .LP
  29 .ft B
  30 int pcap_set_timeout(pcap_t *p, int to_ms);
  31 .ft
  32 .fi
  33 .SH DESCRIPTION
  34 .BR pcap_set_timeout ()
  35 sets the packet buffer timeout that will be used on a capture handle
  36 when the handle is activated to
  37 .IR to_ms ,
  38 which is in units of milliseconds.  (See
  39 .BR pcap (3PCAP)
  40 for an explanation of the packet buffer timeout.)
  41 .LP
  42 The behavior, if the timeout isn't specified, is undefined, as is the
  43 behavior if the timeout is set to zero or to a negative value.  We
  44 recommend always setting the timeout to a non-zero value unless
  45 immediate mode is set, in which case the timeout has no effect.
  46 .SH RETURN VALUE
  47 .BR pcap_set_timeout ()
  48 returns
  49 .B 0
  50 on success or
  51 .B PCAP_ERROR_ACTIVATED
  52 if called on a capture handle that has been activated.
  53 .SH SEE ALSO
  54 .BR pcap_create (3PCAP),
  55 .BR pcap_activate (3PCAP),
  56 .BR \%pcap_set_immediate_mode (3PCAP)