Kid.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 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_IPC_KID_H
#define SQUID_SRC_IPC_KID_H
 
#include "SquidString.h"
#include "tools.h"
 
class Kid
{
public:
 
    enum { badFailureLimit = 4 };
 
    enum { fastFailureTimeLimit = 10 }; // seconds
 
public:
    Kid();
 
    Kid(const char *role, const int id);
 
    void start(pid_t cpid);
 
    void stop(PidStatus const exitStatus);
 
    bool running() const;
 
    bool shouldRestart() const;
 
    pid_t getPid() const;
 
    bool hopeless() const;
 
    void forgetFailures() { badFailures = 0; }
 
    time_t deathDuration() const;
 
    bool calledExit() const;
 
    int exitStatus() const;
 
    bool calledExit(int code) const;
 
    bool exitedHappy() const;
 
    bool signaled() const;
 
    int termSignal() const;
 
    bool signaled(int sgnl) const;
 
    SBuf processName() const;
 
    SBuf gist() const;
 
private:
    void reportStopped() const;
 
    // Information preserved across restarts
    SBuf processRole;
    int processId = 0;
    int badFailures = 0; 
 
    // Information specific to a running or stopped kid
    pid_t  pid = -1; 
    time_t startTime = 0; 
    time_t stopTime = 0; 
    bool isRunning = false; 
    PidStatus status = 0; 
};
 
// TODO: processes may not be kids; is there a better place to put this?
 
typedef enum {
    pkOther  = 0, 
    pkCoordinator = 1, 
    pkWorker = 2, 
    pkDisker = 4, 
    pkHelper = 8  
} ProcessKind;
 
extern int TheProcessKind;
 
#endif /* SQUID_SRC_IPC_KID_H */