XactionInitiator.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_XACTIONINITIATOR_H
#define SQUID_SRC_XACTIONINITIATOR_H
 
class XactionInitiator {
public:
    enum Initiator {
        initUnknown = 0,
        initClient = 1 << 0, 
        initPeerPool = 1 << 1, 
        initCertFetcher = 1 << 2, 
        initCacheDigest = 1 << 4, 
        initHtcp = 1<< 5, 
        initIcp = 1 << 6, 
        initIcmp = 1 << 7, 
        initIpc = 1 << 9, 
        initAdaptation = 1 << 10,  
        initIcon = 1 << 11, 
        initPeerMcast = 1 << 12, 
        initServer = 1 << 13, 
 
        initAdaptationOrphan_ = 1 << 31 
    };
 
    typedef uint32_t Initiators; 
 
    // this class is a just a trivial wrapper so we allow explicit conversions
    XactionInitiator(Initiator i) : initiator(i) {}
 
    bool in(Initiators setOfInitiators) const {return (initiator & setOfInitiators) != 0;}
 
    bool internalClient() const {
        return (initiator & InternalInitiators()) != 0;
    }
 
    static Initiators InternalInitiators() {
        return initPeerPool | initCertFetcher | initCacheDigest | initIcp | initIcmp | initIpc | initAdaptation | initIcon | initPeerMcast;
    }
 
    static Initiators AllInitiators() {
        return 0xFFFFFFFF;
    }
 
    static Initiators ParseInitiators(const char *name);
 
private:
    XactionInitiator() {}
 
    Initiator initiator;
};
 
#endif /* SQUID_SRC_XACTIONINITIATOR_H */