AppenderFile Class Reference

#include <AppenderFile.h>

Public Types
typedef std::integral_constant < AppenderType, APPENDER_FILE > ::type	TypeIndex

Public Member Functions
	AppenderFile (uint8 id, std::string const &name, LogLevel level, AppenderFlags flags, ExtraAppenderArgs extraArgs)
	~AppenderFile ()
FILE *	OpenFile (std::string const &name, std::string const &mode, bool backup)
AppenderType	getType () const override
Public Member Functions inherited from Appender
	Appender (uint8 _id, std::string const &name, LogLevel level=LOG_LEVEL_DISABLED, AppenderFlags flags=APPENDER_FLAGS_NONE)
virtual	~Appender ()
uint8	getId () const
std::string const &	getName () const
LogLevel	getLogLevel () const
AppenderFlags	getFlags () const
void	setLogLevel (LogLevel)
void	write (LogMessage *message)
virtual void	setRealmId (uint32)

Private Member Functions
void	CloseFile ()
void	_write (LogMessage const *message) override

Private Attributes
FILE *	logfile
std::string	_fileName
std::string	_logDir
bool	_dynamicName
bool	_backup
uint64	_maxFileSize
std::atomic< uint64 >	_fileSize

Additional Inherited Members
Static Public Member Functions inherited from Appender
static const char *	getLogLevelString (LogLevel level)

Member Typedef Documentation

typedef std::integral_constant<AppenderType, APPENDER_FILE>::type AppenderFile::TypeIndex

Constructor & Destructor Documentation

AppenderFile::AppenderFile	(	uint8	id,
		std::string const &	name,
		LogLevel	level,
		AppenderFlags	flags,
		ExtraAppenderArgs	extraArgs
	)

 :
 Appender(id, name, level, flags),
 logfile(NULL),
 _logDir(sLog->GetLogsDir()),
 _maxFileSize(0),
 _fileSize(0)
{
 if (extraArgs.empty())
 throw InvalidAppenderArgsException(Trinity::StringFormat("Log::CreateAppenderFromConfig: Missing file name for appender %s\n", name.c_str()));

 _fileName = extraArgs[0];

 char const* mode = "a";
 if (extraArgs.size() > 1)
 mode = extraArgs[1];

 if (flags & APPENDER_FLAGS_USE_TIMESTAMP)
 {
 size_t dot_pos = _fileName.find_last_of(".");
 if (dot_pos != std::string::npos)
 _fileName.insert(dot_pos, sLog->GetLogsTimestamp());
 else
 _fileName += sLog->GetLogsTimestamp();
 }

 if (extraArgs.size() > 2)
 _maxFileSize = atoi(extraArgs[2]);
 else
 _maxFileSize = 0;

 _dynamicName = std::string::npos != _fileName.find("%s");
 _backup = (flags & APPENDER_FLAGS_MAKE_FILE_BACKUP) != 0;

 if (!_dynamicName)
 logfile = OpenFile(_fileName, mode, !strcmp(mode, "w") && _backup);
}

Here is the call graph for this function:

AppenderFile::~AppenderFile

(

)

{
 CloseFile();
}

Here is the call graph for this function:

Member Function Documentation

void AppenderFile::_write ( LogMessage const *  message )

overrideprivatevirtual

Implements Appender.

{
 bool exceedMaxSize = _maxFileSize > 0 && (_fileSize.load() + message->Size()) > _maxFileSize;

 if (_dynamicName)
 {
 char namebuf[TRINITY_PATH_MAX];
 snprintf(namebuf, TRINITY_PATH_MAX, _fileName.c_str(), message->param1.c_str());
 // always use "a" with dynamic name otherwise it could delete the log we wrote in last _write() call
 FILE* file = OpenFile(namebuf, "a", _backup || exceedMaxSize);
 if (!file)
 return;
 fprintf(file, "%s%s\n", message->prefix.c_str(), message->text.c_str());
 fflush(file);
 _fileSize += uint64(message->Size());
 fclose(file);
 return;
 }
 else if (exceedMaxSize)
 logfile = OpenFile(_fileName, "w", true);

 if (!logfile)
 return;

 fprintf(logfile, "%s%s\n", message->prefix.c_str(), message->text.c_str());
 fflush(logfile);
 _fileSize += uint64(message->Size());
}

Here is the call graph for this function:

void AppenderFile::CloseFile ( )

private

{
 if (logfile)
 {
 fclose(logfile);
 logfile = NULL;
 }
}

Here is the caller graph for this function:

AppenderType AppenderFile::getType ( ) const

inlineoverridevirtual

Implements Appender.

{ return TypeIndex::value; }

FILE * AppenderFile::OpenFile	(	std::string const &	name,
		std::string const &	mode,
		bool	backup
	)

{
 std::string fullName(_logDir + filename);
 if (backup)
 {
 CloseFile();
 std::string newName(fullName);
 newName.push_back('.');
 newName.append(LogMessage::getTimeStr(time(NULL)));
 std::replace(newName.begin(), newName.end(), ':', '-');
 rename(fullName.c_str(), newName.c_str()); // no error handling... if we couldn't make a backup, just ignore
 }

 if (FILE* ret = fopen(fullName.c_str(), mode.c_str()))
 {
 _fileSize = ftell(ret);
 return ret;
 }

 return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bool AppenderFile::_backup

private

bool AppenderFile::_dynamicName

private

std::string AppenderFile::_fileName

private

std::atomic<uint64> AppenderFile::_fileSize

private

std::string AppenderFile::_logDir

private

uint64 AppenderFile::_maxFileSize

private

FILE* AppenderFile::logfile

private

---

The documentation for this class was generated from the following files:

• src/common/Logging/AppenderFile.h
• src/common/Logging/AppenderFile.cpp