TcpLogger.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_TCPLOGGER_H
#define SQUID_SRC_LOG_TCPLOGGER_H
 
#include "base/AsyncJob.h"
#include "base/JobWait.h"
#include "comm/forward.h"
#include "ip/Address.h"
#include "log/forward.h"
 
#include <list>
 
class CommCloseCbParams;
class CommConnectCbParams;
class CommIoCbParams;
class MemBlob;
typedef RefCount<MemBlob> MemBlobPointer;
 
namespace Log
{
 
class TcpLogger : public AsyncJob
{
    CBDATA_CHILD(TcpLogger);
 
public:
    typedef CbcPointer<TcpLogger> Pointer;
 
    /* Logfile API */
    static int Open(Logfile *lf, const char *path, size_t bufSz, int fatalFlag);
 
protected:
    TcpLogger(size_t, bool, Ip::Address);
    ~TcpLogger() override;
 
    void endGracefully();
 
    void logRecord(const char *buf, size_t len);
 
    void flush();
 
    /* AsyncJob API */
    void start() override;
    bool doneAll() const override;
    void swanSong() override;
 
private:
    /* Logfile API. Map c-style Logfile calls to TcpLogger method calls. */
    static void Flush(Logfile *lf);
    static void WriteLine(Logfile *lf, const char *buf, size_t len);
    static void StartLine(Logfile *lf);
    static void EndLine(Logfile *lf);
    static void Rotate(Logfile *lf, const int16_t);
    static void Close(Logfile *lf);
 
    static TcpLogger *StillLogging(Logfile *lf);
 
    static void DelayedReconnect(void *data);
    void delayedReconnect();
 
    bool canFit(const size_t len) const;
    void appendRecord(const char *buf, size_t len);
    void appendChunk(const char *chunk, const size_t len);
    void writeIfNeeded();
    void writeIfPossible();
    void doConnect();
    void disconnect();
 
    /* comm callbacks */
    void connectDone(const CommConnectCbParams &conn);
    void writeDone(const CommIoCbParams &io);
    void handleClosure(const CommCloseCbParams &io);
 
    static const size_t IoBufSize; 
    static const size_t BufferCapacityMin; 
 
    bool dieOnError;
 
    std::list<MemBlobPointer> buffers; 
    size_t bufferCapacity; 
    size_t bufferedSize; 
    size_t flushDebt; 
 
    bool quitOnEmpty; 
    bool reconnectScheduled; 
    bool writeScheduled; 
 
    Comm::ConnectionPointer conn; 
    Ip::Address remote; 
    AsyncCall::Pointer closer; 
 
    JobWait<Comm::ConnOpener> connWait;
 
    uint64_t connectFailures; 
    uint64_t drops; 
};
 
} // namespace Log
 
#endif /* SQUID_SRC_LOG_TCPLOGGER_H */