ICP.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2026 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_ICP_H
#define SQUID_SRC_ICP_H
 
#include "base/RefCount.h"
#include "comm/forward.h"
#include "icp_opcode.h"
#include "ip/Address.h"
#include "LogTags.h"
#include "store_key_md5.h"
#include "StoreClient.h"
 
class AccessLogEntry;
class HttpRequest;
 
typedef RefCount<AccessLogEntry> AccessLogEntryPointer;
 
class icp_common_t {
public:
    unsigned char opcode;
    unsigned char version;
    unsigned short length;
    uint32_t reqnum;
    uint32_t flags;
    uint32_t pad;
    uint32_t shostid;
 
    icp_common_t();
    icp_common_t(char *buf, unsigned int len);
 
    void handleReply(char *buf, Ip::Address &from);
    icp_opcode getOpCode() const;
 
    static icp_common_t *CreateMessage(icp_opcode opcode, int flags, const char *url, int reqnum, int pad);
};
 
// TODO: mempool this
class ICPState: public StoreClient
{
 
public:
    ICPState(icp_common_t &aHeader, HttpRequest *aRequest);
    ~ICPState() override;
 
    bool isHit() const;
 
    icp_common_t header;
    HttpRequest *request;
    int fd;
 
    Ip::Address from;
    char *url;
    mutable AccessLogEntryPointer al;
 
protected:
    /* StoreClient API */
    LogTags *loggingTags() const override;
    void fillChecklist(ACLFilledChecklist &) const override;
 
    bool confirmAndPrepHit(const StoreEntry &) const;
};
 
extern Comm::ConnectionPointer icpIncomingConn;
extern Comm::ConnectionPointer icpOutgoingConn;
extern Ip::Address theIcpPublicHostID;
 
const char *icpGetUrl(const Ip::Address &from, const char *, const icp_common_t &);
 
HttpRequestPointer icpGetRequest(const char *url, int reqnum, int fd, const Ip::Address &from);
 
void icpCreateAndSend(icp_opcode, int flags, char const *url, int reqnum, int pad, int fd, const Ip::Address &from, AccessLogEntryPointer);
 
icp_opcode icpGetCommonOpcode();
 
void icpDenyAccess(const Ip::Address &from, const char *url, int reqnum, int fd);
 
PF icpHandleUdp;
 
void icpHandleIcpV3(int, Ip::Address &, char *, int);
 
void icpOpenPorts(void);
 
void icpConnectionShutdown(void);
 
void icpClosePorts(void);
 
int icpSetCacheKey(const cache_key * key);
 
const cache_key *icpGetCacheKey(const char *url, int reqnum);
 
#endif /* SQUID_SRC_ICP_H */