log4cpp::R...leAppender(3)

🌸 log4cpp::RollingFileAppender 🌸

okay so bestie, this is from the Library Functions Manual for log4cpp, and it's literally the manual page for RollingFileAppender. it's a FileAppender that rolls over the logfile once it hits a size limit — iconic behavior for keeping your logs from becoming a whole mess 💅

---

✨ NAME ✨

log4cpp::RollingFileAppender — okay so it's a FileAppender that rolls over the logfile once it's reached a certain size limit. literally that's the whole vibe.

---

🎀 SYNOPSIS 🎀

#include <RollingFileAppender.hh>

it inherits from log4cpp::FileAppender. slay.

💖 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)
• virtual void setMaxBackupIndex (unsigned int maxBackups)
• virtual unsigned int getMaxBackupIndex () const
• virtual void setMaximumFileSize (size_t maxFileSize)
• virtual size_t getMaxFileSize () const
• virtual void rollOver ()

🌈 Public Member Functions inherited from log4cpp::FileAppender

• FileAppender (const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644) — Constructs a FileAppender. periodt.
• FileAppender (const std::string &name, int fd) — Constructs a FileAppender to an already open file descriptor. iykyk.
• virtual ~FileAppender ()
• 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 log4cpp::LayoutAppender

• LayoutAppender (const std::string &name)
• virtual ~LayoutAppender ()
• virtual bool requiresLayout () const — Check if the appender requires a layout.
• virtual void setLayout (Layout *layout=NULL) — Set the Layout for this appender.

🧚 Public Member Functions inherited from log4cpp::AppenderSkeleton

• virtual ~AppenderSkeleton () — Destructor for AppenderSkeleton.
• virtual void doAppend (const LoggingEvent &event) — Log in 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 log4cpp::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 Appender specific way.

🌸 Protected Member Functions inherited from log4cpp::LayoutAppender

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

🌺 Protected Member Functions inherited from log4cpp::AppenderSkeleton

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

🌷 Protected Member Functions inherited from log4cpp::Appender

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

🎀 Protected Attributes 🎀

• unsigned int _maxBackupIndex
• unsigned short int _maxBackupIndexWidth
• size_t _maxFileSize

🌼 Protected Attributes inherited from log4cpp::FileAppender

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

🫶 Additional Inherited Members 🫶

💫 Public Types inherited from log4cpp::LayoutAppender

• typedef BasicLayout DefaultLayoutType

⭐ Static Public Member Functions inherited from log4cpp::Appender

• static Appender * getAppender (const std::string &name) — Get a pointer to an exitsing Appender. (yes, "exitsing" — that's exactly what the original says, bestie, not me 😭)
• static bool reopenAll () — Call reopen() on all existing Appenders.
• static void closeAll () — Call reopen() on all existing Appenders.

---

💅 Detailed Description 💅

RollingFileAppender is a FileAppender that rolls over the logfile once it has reached a certain size limit.

Since: 0.3.1 — it's been iconic since day one, no cap.

---

🔥 Constructor & Destructor Documentation 🔥

log4cpp::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 main character constructor right there. defaults are literally all laid out for you: maxFileSize = 10*1024*1024, maxBackupIndex = 1, append = true, mode = 00644.

---

✨ Member Function Documentation ✨

void log4cpp::RollingFileAppender::_append (const LoggingEvent & event)

[protected], [virtual] — Log in Appender specific way. Subclasses of Appender should implement this method to perform actual logging.

Parameters:

• event — The LoggingEvent to log.

Reimplemented from log4cpp::FileAppender.

unsigned int log4cpp::RollingFileAppender::getMaxBackupIndex () const

[virtual] — gets the max backup index, periodt.

size_t log4cpp::RollingFileAppender::getMaxFileSize () const

[virtual] — gets the max file size, obviously 💁‍♀️

void log4cpp::RollingFileAppender::rollOver ()

[virtual] — the rollover moment. it's giving main character energy.

void log4cpp::RollingFileAppender::setMaxBackupIndex (unsigned int maxBackups)

[virtual] — sets the max backup index.

void log4cpp::RollingFileAppender::setMaximumFileSize (size_t maxFileSize)

[virtual] — sets the maximum file size.

---

🌈 Member Data Documentation 🌈

• unsigned int log4cpp::RollingFileAppender::_maxBackupIndex [protected]
• unsigned short int log4cpp::RollingFileAppender::_maxBackupIndexWidth [protected]
• size_t log4cpp::RollingFileAppender::_maxFileSize [protected]

---

👑 Author 👑

Generated automatically by Doxygen for log4cpp from the source code. (so not a human author, bestie — it's the Doxygen machine doing its thing 🫶)

---

and that's the whole page, fr fr. this manual page is Version 1.1 of log4cpp, dated in the footer — so when you see that footer line at the bottom, just know it's the source/version/date sign-off. slay, you made it to the end, ily 💖✨