1/*
2 * libjingle
3 * Copyright 2004--2009, Google Inc.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 *  1. Redistributions of source code must retain the above copyright notice,
9 *     this list of conditions and the following disclaimer.
10 *  2. Redistributions in binary form must reproduce the above copyright notice,
11 *     this list of conditions and the following disclaimer in the documentation
12 *     and/or other materials provided with the distribution.
13 *  3. The name of the author may not be used to endorse or promote products
14 *     derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#ifndef TALK_BASE_LINUXFDWALK_H_
29#define TALK_BASE_LINUXFDWALK_H_
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35// Linux port of SunOS's fdwalk(3) call. It loops over all open file descriptors
36// and calls func on each one. Additionally, it is safe to use from the child
37// of a fork that hasn't exec'ed yet, so you can use it to close all open file
38// descriptors prior to exec'ing a daemon.
39// The return value is 0 if successful, or else -1 and errno is set. The
40// possible errors include any error that can be returned by opendir(),
41// readdir(), or closedir(), plus EBADF if there are problems parsing the
42// contents of /proc/self/fd.
43// The file descriptors that are enumerated will not include the file descriptor
44// used for the enumeration itself.
45int fdwalk(void (*func)(void *, int), void *opaque);
46
47#ifdef __cplusplus
48}  // extern "C"
49#endif
50
51#endif  // TALK_BASE_LINUXFDWALK_H_
52