log4cpp::FileAppender(3)

💖 log4cpp::FileAppender(3) 💖

okay bestie, so this is the manual page for log4cpp::FileAppender from the log4cpp library (Version 1.1, she's iconic). It's literally the file appender class and it's giving main character energy for all your logging needs. Let me break it down for you, no cap. ✨

---

🌸 SYNOPSIS 🌸

#include <FileAppender.hh>

okay so first things first: it inherits from log4cpp::LayoutAppender. and guess what? it's also inherited by log4cpp::DailyRollingFileAppender and log4cpp::RollingFileAppender. the family tree is thriving, we love to see it. 🌳

🎀 Public Member Functions 🎀

• FileAppender(const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644) — constructs a FileAppender. we'll get into the details later, don't worry.
• FileAppender(const std::string &name, int fd) — constructs a FileAppender to an already open file descriptor. fancy.
• virtual ~FileAppender() — the destructor, she cleans up.
• virtual bool reopen() — reopens the logfile. super useful for external rotation, iykyk.
• virtual void close() — closes the logfile. bye bestie.
• virtual void setAppend(bool append) — sets the append vs truncate flag. (spoiler: it's a little late for the first open, more on that below)
• 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) — constructor.
• 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.

🦋 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. this is the one subclasses override.

✨ 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 🍓

• const std::string _fileName — protected, she's the file name.
• int _fd — protected, the file descriptor.
• int _flags — protected, the flags.
• mode_t _mode — protected, the mode.

🎀 Additional Inherited Members 🎀

🌸 Public Types inherited from log4cpp::LayoutAppender 🌸

• typedef BasicLayout DefaultLayoutType — the default layout type, periodt.

💅 Static Public Member Functions inherited from log4cpp::Appender 💅

• static Appender *getAppender(const std::string &name) — get a pointer to an existing Appender. (the original says "exitsing", but we know what they mean, bestie 😭)
• static bool reopenAll() — call reopen() on all existing Appenders.
• static void closeAll() — call reopen() on all existing Appenders. (yes, the original says reopen() here too, not close(), so I'm keeping it exactly as written—don't come for me 💀)

---

👑 Constructor & Destructor Documentation 👑

💖 log4cpp::FileAppender::FileAppender(const std::string &name, const std::string &fileName, bool append = true, mode_t mode = 00644) 💖

Constructs a FileAppender. literally creating the whole vibe.

Parameters:

• name — the name of the Appender.
• fileName — the name of the file to which the Appender has to log.
• append — whether the Appender has to truncate the file or just append to it if it already exists. Defaults to 'true'.
• mode — file mode to open the logfile with. Defaults to 00644.

💖 log4cpp::FileAppender::FileAppender(const std::string &name, int fd) 💖

Constructs a FileAppender to an already open file descriptor. so you're bringing your own fd, okay queen.

Parameters:

• name — the name of the Appender.
• fd — the file descriptor to which the Appender has to log.

💖 log4cpp::FileAppender::~FileAppender() [virtual] 💖

the destructor. she's virtual and she's doing her thing.

---

🔥 Member Function Documentation 🔥

🌟 void log4cpp::FileAppender::_append(const LoggingEvent &event) [protected], [virtual] 🌟

Log in Appender specific way. Subclasses of Appender should implement this method to perform actual logging. it's the behind-the-scenes queen.

Parameters:

• event — The LoggingEvent to log.

Implements: log4cpp::AppenderSkeleton.

Reimplemented in: log4cpp::DailyRollingFileAppender, and log4cpp::RollingFileAppender. the whole squad is on it.

🌟 void log4cpp::FileAppender::close() [virtual] 🌟

Closes the logfile. simple as that.

Implements: log4cpp::AppenderSkeleton.

🌟 bool log4cpp::FileAppender::getAppend() const [virtual] 🌟

Gets the value of the 'append' option. just a little getter, no drama.

🌟 mode_t log4cpp::FileAppender::getMode() const [virtual] 🌟

Gets the file open mode. yup, that's it.

🌟 bool log4cpp::FileAppender::reopen() [virtual] 🌟

Reopens the logfile. This can be useful for logfiles that are rotated externally, e.g. by logrotate. This method is a NOOP for FileAppenders that have been constructed with a file descriptor. (so if you used the fd constructor, reopen() does literally nothing—don't @ me, that's what the manpage says.)

Returns: true if the reopen succeeded.

Reimplemented from: log4cpp::AppenderSkeleton.

🌟 void log4cpp::FileAppender::setAppend(bool append) [virtual] 🌟

Sets the append vs truncate flag. NB. currently the FileAppender opens the logfile in the constructor. Therefore this method is too late to influence the first file opening. We'll need something similar to log4j's activateOptions(). (so like, it works but not for the first open—important caveat, bestie.)

Parameters:

• append — false to truncate, true to append

🌟 void log4cpp::FileAppender::setMode(mode_t mode) [virtual] 🌟

Sets the file open mode. that's the whole thing.

---

💀 Member Data Documentation 💀

• int log4cpp::FileAppender::_fd [protected] — the file descriptor, protected.
• const std::string log4cpp::FileAppender::_fileName [protected] — the file name, protected and const.
• int log4cpp::FileAppender::_flags [protected] — the flags, protected.
• mode_t log4cpp::FileAppender::_mode [protected] — the mode, protected.

---

🌈 Author 🌈

Generated automatically by Doxygen for log4cpp from the source code. (so you can thank Doxygen for this masterpiece, no cap.)

---

this page is brought to you by log4cpp Version 1.1, and the manpage name is log4cpp::FileAppender(3). slay. 💅✨🦋🌸💖

okay that's the whole thing, bestie. go forth and log your little heart out. 🫶👑