src/ipc/StartListening.h

   1 /*
   2  * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 /* DEBUG: section 54    Interprocess Communication */
  10
  11 #ifndef SQUID_IPC_START_LISTENING_H
  12 #define SQUID_IPC_START_LISTENING_H
  13
  14 #include "base/AsyncCall.h"
  15 #include "base/Subscription.h"
  16 #include "comm/forward.h"
  17 #include "ip/forward.h"
  18 #include "ipc/FdNotes.h"
  19
  20 #include <iosfwd>
  21
  22 namespace Ipc
  23 {
  24
  25 /// common API for all StartListening() callbacks
  26 class StartListeningCb
  27 {
  28 public:
  29     StartListeningCb();
  30     virtual ~StartListeningCb();
  31
  32     /// starts printing arguments, return os
  33     std::ostream &startPrint(std::ostream &os) const;
  34
  35 public:
  36     Comm::ConnectionPointer conn; ///< opened listening socket
  37     int errNo; ///< errno value from the comm_open_listener() call
  38     Subscription::Pointer handlerSubscription; ///< The subscription we will pass on to the ConnAcceptor
  39 };
  40
  41 /// Depending on whether SMP is on, either ask Coordinator to send us
  42 /// the listening FD or open a listening socket directly.
  43 void StartListening(int sock_type, int proto, const Comm::ConnectionPointer &listenConn,
  44                     FdNoteId fdNote, AsyncCall::Pointer &callback);
  45
  46 } // namespace Ipc;
  47
  48 #endif /* SQUID_IPC_START_LISTENING_H */
  49