MasterXaction.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_MASTERXACTION_H
#define SQUID_SRC_MASTERXACTION_H
 
#include "anyp/forward.h"
#include "anyp/PortCfg.h"
#include "base/InstanceId.h"
#include "base/Lock.h"
#include "base/RefCount.h"
#include "comm/forward.h"
#include "XactionInitiator.h"
 
class MasterXaction : public RefCountable
{
public:
    typedef RefCount<MasterXaction> Pointer;
 
    template <XactionInitiator::Initiator anInitiator>
    static Pointer MakePortless()
    {
        static_assert(anInitiator != XactionInitiator::initClient, "not an HTTP or FTP client");
        return new MasterXaction(anInitiator, nullptr);
    }
 
    static Pointer MakePortful(const AnyP::PortCfgPointer &aPort)
    {
        return new MasterXaction(XactionInitiator::initClient, aPort);
    }
 
    InstanceId<MasterXaction, uint64_t> id;
 
    AnyP::PortCfgPointer squidPort;
 
    Comm::ConnectionPointer tcpClient;
 
    XactionInitiator initiator;
 
    bool generatingConnect = false;
 
    // TODO: add state from other Jobs in the transaction
 
private:
    // use public Make() functions instead
    MasterXaction(const XactionInitiator anInitiator, const AnyP::PortCfgPointer &aPort):
        squidPort(aPort),
        initiator(anInitiator)
    {}
};
 
#endif /* SQUID_SRC_MASTERXACTION_H */