| JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 1 | .\" @(#) $Header: /tcpdump/master/libpcap/pcap_set_timeout.3pcap,v 1.1 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_SET_TIMEOUT 3PCAP "5 April 2008" |
| 23 | .SH NAME |
| 24 | pcap_set_timeout \- set the read timeout for a not-yet-activated |
| 25 | capture handle |
| 26 | .SH SYNOPSIS |
| 27 | .nf |
| 28 | .ft B |
| 29 | #include <pcap/pcap.h> |
| 30 | .LP |
| 31 | .ft B |
| 32 | int pcap_set_timeout(pcap_t *p, int to_ms); |
| 33 | .ft |
| 34 | .fi |
| 35 | .SH DESCRIPTION |
| 36 | .B pcap_set_timeout() |
| 37 | sets the read timeout that will be used on a capture handle when |
| 38 | the handle is activated to |
| 39 | .IR to_ms , |
| 40 | which is in units of milliseconds. |
| 41 | .LP |
| 42 | The behavior, if the timeout isn't specified, is undefined. We |
| 43 | recommend always setting the timeout to a non-zero value. |
| 44 | .SH RETURN VALUE |
| 45 | .B pcap_set_timeout() |
| 46 | returns 0 on success or |
| 47 | .B PCAP_ERROR_ACTIVATED |
| 48 | if called on a capture handle that has been activated. |
| 49 | .SH SEE ALSO |
| 50 | pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP) |