Inquirer.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.
 */
 
/* DEBUG: section 54    Interprocess Communication */
 
#ifndef SQUID_SRC_IPC_INQUIRER_H
#define SQUID_SRC_IPC_INQUIRER_H
 
#include "base/AsyncJob.h"
#include "base/AsyncJobCalls.h"
#include "base/forward.h"
#include "ipc/forward.h"
#include "ipc/Request.h"
#include "ipc/Response.h"
#include "ipc/StrandCoords.h"
 
namespace Ipc
{
 
class Inquirer: public AsyncJob
{
    CBDATA_INTERMEDIATE();
 
public:
    Inquirer(Request::Pointer aRequest, const Ipc::StrandCoords& coords, double aTimeout);
    ~Inquirer() override;
 
    static void HandleRemoteAck(const Response& response);
 
    /* has-to-be-public AsyncJob API */
    void callException(const std::exception& e) override;
 
    CodeContextPointer codeContext;
 
protected:
    /* AsyncJob API */
    void start() override;
    void swanSong() override;
    bool doneAll() const override;
    const char *status() const override;
 
    virtual void inquire();
    virtual void cleanup();
    virtual void handleException(const std::exception& e);
    virtual void sendResponse() = 0;
    virtual bool aggregate(Response::Pointer aResponse) = 0;
 
private:
    void handleRemoteAck(Response::Pointer response);
 
    static void RequestTimedOut(void* param);
    void requestTimedOut();
    void removeTimeoutEvent();
 
protected:
    Request::Pointer request; 
 
    Ipc::StrandCoords strands; 
    Ipc::StrandCoords::const_iterator pos; 
 
    const double timeout; 
 
    static RequestId::Index LastRequestId; 
};
 
} // namespace Ipc
 
#endif /* SQUID_SRC_IPC_INQUIRER_H */