log4shib::FileAppender(3)

💾 log4shib::FileAppender — the manual page, bestie edition 🎀

okay so this is the log4shib::FileAppender(3) page from the log4shib Library Functions Manual, and it's literally the appender that writes your logs to a file. yes, that's the whole vibe. let's get into it ✨

---

🌸 NAME 🌸

log4shib::FileAppender — it's a class! it appends. to files. iykyk 💅

---

✨ SYNOPSIS ✨

#include <FileAppender.hh>

Inherits log4shib::LayoutAppender.

Inherited by log4shib::RollingFileAppender. (yes, the rolling one is the child, we love a nepo baby 👑)

🫶 Public Member Functions

• 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 () — the destructor, she's virtual
• 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, incoming
• virtual ~LayoutAppender () — destructor, outgoing
• 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 log4shib::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 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 Appender specific way.

🌸 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 🎀

• const std::string _fileName — the file name, and it's const, so don't even try it
• int _fd — the file descriptor, bestie
• int _flags — the flags
• mode_t _mode — the mode

---

⭐ Additional Inherited Members ⭐

🦋 Public Types inherited from log4shib::LayoutAppender

• typedef BasicLayout DefaultLayoutType — that's the default layout type, iconic

🌈 Static Public Member Functions inherited from log4shib::Appender

• static Appender * getAppender (const std::string &name) — Get a pointer to an exitsing Appender. (yes, "exitsing" — that's how the page spells it, i'm not fixing her typo, she's doing great 😭)
• static bool reopenAll () — Call reopen() on all existing Appenders.
• static void closeAll () — Call reopen() on all existing Appenders. (that's what the page says, drink water, don't @ me 💀)

---

🌟 Constructor & Destructor Documentation 🌟

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

Constructs a FileAppender. slay.

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.

---

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

Constructs a FileAppender to an already open file descriptor. like, the fd is already out here living its life, we just join the party 🫶

Parameters

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

---

log4shib::FileAppender::~FileAppender () [virtual]

the virtual destructor, no notes, she cleans up after herself 💅

---

💖 Member Function Documentation 💖

void log4shib::FileAppender::_append (const LoggingEvent & event)

[protected], [virtual]

Log in Appender specific way. Subclasses of Appender should implement this method to perform actual logging. (yes bestie, you do the work, this is just the blueprint ✨)

Parameters

• event — The LoggingEvent to log.

Implements log4shib::AppenderSkeleton.

Reimplemented in log4shib::RollingFileAppender.

---

void log4shib::FileAppender::close () [virtual]

Closes the logfile. bye girl 👋

Implements log4shib::AppenderSkeleton.

---

bool log4shib::FileAppender::getAppend () const [virtual]

Gets the value of the 'append' option.

---

mode_t log4shib::FileAppender::getMode () const [virtual]

Gets the file open mode.

---

bool log4shib::FileAppender::reopen () [virtual]

Reopens the logfile. This can be useful for logfiles that are rotated externally, e.g. by logrotate. lowkey the most useful thing here ngl 🌀

⚠️ heads up: this method is a NOOP for FileAppenders that have been constructed with a file descriptor. like, nothing happens. zero. nada. 💀

Returns

true if the reopen succeeded.

Reimplemented from log4shib::AppenderSkeleton.

---

void log4shib::FileAppender::setAppend (bool append) [virtual]

Sets the append vs truncate flag.

🚨 real talk: 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 yeah, it's giving "we know, we know" 😭

Parameters

• append — false to truncate, true to append

---

void log4shib::FileAppender::setMode (mode_t mode) [virtual]

Sets the file open mode.

---

🍓 Member Data Documentation 🍓

• int log4shib::FileAppender::_fd [protected]
• const std::string log4shib::FileAppender::_fileName [protected]
• int log4shib::FileAppender::_flags [protected]
• mode_t log4shib::FileAppender::_mode [protected]

---

👑 Author 👑

Generated automatically by Doxygen for log4shib from the source code. (yes, a robot wrote this, and she ate 🤖✨)

---

and that's the page!! 🫶 this was log4shib Version 2.0.1, manual page log4shib::FileAppender(3), bestie — go forth and log responsibly 💜🦋