FormattedLog.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_LOG_FORMATTEDLOG_H
#define SQUID_SRC_LOG_FORMATTEDLOG_H
 
#include "acl/forward.h"
#include "log/Formats.h"
#include "log/forward.h"
 
#include <iosfwd>
#include <optional>
 
class ConfigParser;
 
class FormattedLog
{
public:
    FormattedLog() = default;
    ~FormattedLog();
 
    FormattedLog(FormattedLog &&) = delete; // no need to support copying of any kind
 
    bool usesDaemon() const;
 
    void parseOptions(ConfigParser&, const char *defaultFormat);
 
    void dumpOptions(std::ostream &os) const;
 
    void setLogformat(const char *logformatName);
 
    void open();
 
    void rotate();
 
    void close();
 
    Logfile *logfile = nullptr;
 
    char *filename = nullptr;
 
    ACLList *aclList = nullptr;
 
    Format::Format *logFormat = nullptr;
 
    Log::Format::log_type type = Log::Format::CLF_UNKNOWN;
 
    size_t bufferSize = 8*MAX_URL;
 
    std::optional<unsigned int> rotationsToKeep;
 
    bool fatal = true;
};
 
#endif /* SQUID_SRC_LOG_FORMATTEDLOG_H */