1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
|
/** @file
* @brief Socket handling utilities.
*/
/* Copyright (C) 2006,2007,2008,2015 Olly Betts
* Copyright (C) 2008 Lemur Consulting Ltd
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef XAPIAN_INCLUDED_SOCKET_UTILS_H
#define XAPIAN_INCLUDED_SOCKET_UTILS_H
#include "safeunistd.h"
#ifdef __WIN32__
#include "safewinsock2.h"
/// Convert an fd (which might be a socket) to a WIN32 HANDLE.
extern HANDLE fd_to_handle(int fd);
/// Close an fd, which might be a socket.
extern void close_fd_or_socket(int fd);
#else
// There's no distinction between sockets and other fds on UNIX.
inline void close_fd_or_socket(int fd) { close(fd); }
#endif
/** Attempt to set socket-level timeouts.
*
* These aren't supported by all platforms, and some platforms allow them to
* set but ignore them, so we can't easily report failure.
*
* Also sets SO_KEEPALIVE (if supported), which should ensure a stuck
* connection will eventually time out, though it may take up to ~2 hours.
*/
void set_socket_timeouts(int fd, double timeout);
#endif // XAPIAN_INCLUDED_SOCKET_UTILS_H
|