LOG4SHIB::ROLLINGFILEAPPENDER(3)

💅 NAME

okay so bestie, welcome to log4shib::RollingFileAppender — it's a FileAppender that rolls over the logfile once it has reached a certain size limit. that's the whole vibe. it's giving "your log file but make it not 47 gigabytes". 🌀

(this whole page lives in the log4shib manual, section 3 — library functions, for the record 🫶)

---

✨ SYNOPSIS

#include <RollingFileAppender.hh>

Inherits log4shib::FileAppender. yes queen, it's a whole family tree. 🌳

🌸 Public Member Functions

• RollingFileAppender (const std::string &name, const std::string &fileName, size_t maxFileSize=10 *1024 *1024, unsigned int maxBackupIndex=1, bool append=true, mode_t mode=00644) — the constructor, all six args, defaults included, no cap ✨
• virtual void setMaxBackupIndex (unsigned int maxBackups) — set how many backups you're keeping around
• virtual unsigned int getMaxBackupIndex () const — read back that backup count
• virtual void setMaximumFileSize (size_t maxFileSize) — set the size limit that triggers the roll
• virtual size_t getMaxFileSize () const — read back that size limit
• virtual void rollOver () — do the actual rollover, iconic behavior 💫

🦋 Public Member Functions inherited from log4shib::FileAppender

• FileAppender (const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644) — constructs a FileAppender.
• FileAppender (const std::string &name, int fd) — constructs a FileAppender to an already open file descriptor.
• virtual ~FileAppender () — destructor, bye bestie 👋
• virtual bool reopen () — reopens the logfile.
• virtual void close () — closes the logfile.
• virtual void setAppend (bool append) — sets the append vs truncate flag.
• virtual bool getAppend () const — gets the value of the 'append' option.
• virtual void setMode (mode_t mode) — sets the file open mode.
• virtual mode_t getMode () const — gets the file open mode.

🌈 Public Member Functions inherited from log4shib::LayoutAppender

• LayoutAppender (const std::string &name) — constructor, takes a name
• virtual ~LayoutAppender () — destructor
• virtual bool requiresLayout () const — check if the appender requires a layout.
• virtual void setLayout (Layout *layout=NULL) — set the Layout for this appender. yes, NULL is the default, it's right there 👀

⭐ Public Member Functions inherited from log4shib::AppenderSkeleton

• virtual ~AppenderSkeleton () — destructor for AppenderSkeleton.
• virtual void doAppend (const LoggingEvent &event) — log in an Appender-specific way.
• virtual void setThreshold (Priority::Value priority) — set the threshold priority of this Appender.
• virtual Priority::Value getThreshold () — get the threshold priority of this Appender.
• virtual void setFilter (Filter *filter) — set a Filter for this appender.
• virtual Filter * getFilter () — get the Filter for this appender.

🎀 Public Member Functions inherited from log4shib::Appender

• virtual ~Appender () — destructor for Appender.
• const std::string & getName () const — get the name of this appender.

💜 Protected Member Functions

• virtual void _append (const LoggingEvent &event) — log in an Appender-specific way. it's the protected one, the backstage pass 🎟️

🧚 Protected Member Functions inherited from log4shib::LayoutAppender

• Layout & _getLayout () — return the layout of the appender.

🍓 Protected Member Functions inherited from log4shib::AppenderSkeleton

• AppenderSkeleton (const std::string &name) — constructor for AppenderSkeleton.

🌸 Protected Member Functions inherited from log4shib::Appender

• Appender (const std::string &name) — constructor for Appender.

🔥 Protected Attributes

• unsigned int _maxBackupIndex
• size_t _maxFileSize

🦋 Protected Attributes inherited from log4shib::FileAppender

• const std::string _fileName
• int _fd
• int _flags
• mode_t _mode

👑 Additional Inherited Members

Public Types inherited from log4shib::LayoutAppender:

• typedef BasicLayout DefaultLayoutType

Static Public Member Functions inherited from log4shib::Appender:

• static Appender * getAppender (const std::string &name) — get a pointer to an existing Appender.
• static bool reopenAll () — call reopen() on all existing Appenders.
• static void closeAll () — call reopen() on all existing Appenders. no fr, the docs literally say reopen() here and not close(). i'm just the messenger 😭💀

---

🌟 Detailed Description

RollingFileAppender is a FileAppender that rolls over the logfile once it has reached a certain size limit. literally the same sentence as NAME because that's the entire personality, and honestly? respect. 🫡

Since — 0.3.1 (an elder, a legend, a founding mother 💐)

---

🎀 Constructor & Destructor Documentation

🌸 log4shib::RollingFileAppender::RollingFileAppender (const std::string & name, const std::string & fileName, size_t maxFileSize = 10*1024*1024, unsigned int maxBackupIndex = 1, bool append = true, mode_t mode = 00644)

that's the constructor, bestie. all the defaults are right there in the signature — 10*1024*1024 bytes max, 1 backup, append = true, mode 00644 — copy them exactly, don't get creative with my girl's numbers 💖

---

🦋 Member Function Documentation

💫 void log4shib::RollingFileAppender::_append (const LoggingEvent & event)

[protected], [virtual]

Log in an Appender-specific way. Subclasses of Appender should implement this method to perform actual logging.

Parameters

• event — The LoggingEvent to log.

Reimplemented from log4shib::FileAppender.

💫 unsigned int log4shib::RollingFileAppender::getMaxBackupIndex () const

[virtual]

💫 size_t log4shib::RollingFileAppender::getMaxFileSize () const

[virtual]

💫 void log4shib::RollingFileAppender::rollOver ()

[virtual]

💫 void log4shib::RollingFileAppender::setMaxBackupIndex (unsigned int maxBackups)

[virtual]

💫 void log4shib::RollingFileAppender::setMaximumFileSize (size_t maxFileSize)

[virtual]

these five are listed with no description in the original — so no, i'm not gonna invent lore for them. they're mysterious. they're main character energy. they simply are. 🙈✨

---

🍓 Member Data Documentation

⭐ unsigned int log4shib::RollingFileAppender::_maxBackupIndex

[protected]

⭐ size_t log4shib::RollingFileAppender::_maxFileSize

[protected]

---

💜 Author

Generated automatically by Doxygen for log4shib from the source code. (so if the grammar is weird, blame the robot, not me 🤖💅)

---

okay that's the whole page, and before you go: this is log4shib Version 2.0.1, manual page log4shib::...ileAppender(3) — the truncated title is not a typo, that's genuinely how it renders, and yes it's a little cursed 💀. mwah, go roll some files responsibly 🎀🫶✨