ConnOpener.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_COMM_CONNOPENER_H
#define SQUID_SRC_COMM_CONNOPENER_H
 
#include "base/AsyncCall.h"
#include "base/AsyncJob.h"
#include "cbdata.h"
#include "comm/Flag.h"
#include "comm/forward.h"
#include "CommCalls.h"
 
namespace Comm
{
 
class ConnOpener : public AsyncJob
{
    CBDATA_CHILD(ConnOpener);
 
public:
    typedef CbcPointer<ConnOpener> Pointer;
 
    bool doneAll() const override;
 
    ConnOpener(const Comm::ConnectionPointer &, const AsyncCall::Pointer &handler, time_t connect_timeout);
    ~ConnOpener() override;
 
    void setHost(const char *);    
    const char * getHost() const;  
 
protected:
    void start() override;
    void swanSong() override;
 
private:
    // Undefined because two openers cannot share a connection
    ConnOpener(const ConnOpener &);
    ConnOpener & operator =(const ConnOpener &c);
 
    void earlyAbort(const CommCloseCbParams &);
    void timeout(const CommTimeoutCbParams &);
    void sendAnswer(Comm::Flag errFlag, int xerrno, const char *why);
    static void InProgressConnectRetry(int fd, void *data);
    static void DelayedConnectRetry(void *data);
    void doConnect();
    void connected();
    void lookupLocalAddress();
 
    void retrySleep();
    void restart();
 
    bool createFd();
    void closeFd();
    void keepFd();
    void cleanFd();
 
    void cancelSleep();
 
private:
    char *host_;                         
    int temporaryFd_;                    
    Comm::ConnectionPointer conn_;       
    AsyncCall::Pointer callback_;        
 
    int totalTries_;   
    int failRetries_;  
 
    time_t deadline_;
 
    struct Calls {
        AsyncCall::Pointer earlyAbort_;
        AsyncCall::Pointer timeout_;
        bool sleep_;
    } calls_;
};
 
}; // namespace Comm
 
#endif /* SQUID_SRC_COMM_CONNOPENER_H */