xapian-core/net/tcpclient.h

   1 /** @file
   2  *  @brief Open a TCP connection to a server.
   3  */
   4 /* Copyright (C) 2007,2008,2010,2024 Olly Betts
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef XAPIAN_INCLUDED_TCPCLIENT_H
  22 #define XAPIAN_INCLUDED_TCPCLIENT_H
  23
  24 #include <string>
  25 #include <string_view>
  26
  27 namespace TcpClient {
  28     /** Attempt to open a TCP/IP socket connection to a server.
  29      *
  30      *  Connect to the server running on port @a port of host @a hostname.
  31      *  Give up trying to connect after @a timeout_connect seconds.
  32      */
  33     int open_socket(std::string_view hostname, int port,
  34                     double timeout_connect, bool tcp_nodelay,
  35                     const std::string& context);
  36 }
  37
  38 #endif  // XAPIAN_INCLUDED_TCPCLIENT_H