AsyncJob.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_BASE_ASYNCJOB_H
#define SQUID_SRC_BASE_ASYNCJOB_H
 
#include "base/AsyncCall.h"
#include "base/InstanceId.h"
#include "cbdata.h"
 
template <class Cbc>
class CbcPointer;
 
// See AsyncJobs.dox for details.
 
class AsyncJob: public CbdataParent
{
public:
    typedef CbcPointer<AsyncJob> Pointer;
 
public:
    AsyncJob(const char *aTypeName);
 
    static void Start(const Pointer &job);
 
    static void RegisterWithCacheManager();
 
protected:
    // XXX: temporary method to replace "delete this" in jobs-in-transition.
    // Will be replaced with calls to mustStop() when transition is complete.
    void deleteThis(const char *aReason);
 
    // force done() for a reason but continue with the current method
    void mustStop(const char *aReason);
 
    bool done() const; 
 
    virtual void start(); 
    virtual bool doneAll() const; 
    virtual void swanSong() {}; 
    virtual const char *status() const; 
 
public:
    bool canBeCalled(AsyncCall &call) const; 
    void callStart(AsyncCall &call); 
    virtual void callEnd(); 
    virtual void callException(const std::exception &e);
 
    void handleStopRequest() { mustStop("externally aborted"); }
 
    const InstanceId<AsyncJob> id; 
 
protected:
    // external destruction prohibited to ensure swanSong() is called
    ~AsyncJob() override;
 
    static void ReportAllJobs(StoreEntry *);
 
    const char *stopReason; 
    const char *typeName; 
    AsyncCall::Pointer inCall; 
 
    bool started_ = false; 
    bool swanSang_ = false; 
};
 
#endif /* SQUID_SRC_BASE_ASYNCJOB_H */