#include <Svc/BufferLogger/BufferLogger.hpp>

Inheritance diagram for Svc::BufferLogger:

Public Member Functions
	File (BufferLogger &bufferLogger)
	Construct a File object. More...

	~File (void)
	Destroy a File object. More...

void	init (const char const prefix, const char const suffix, const U32 maxSize, const U8 sizeOfSize)
	Set File object parameters. More...

void	setBaseName (const Fw::EightyCharString &baseName)
	Set base file name. More...

void	logBuffer (const U8 *const data, const U32 size)
	Log a buffer. More...

void	closeAndEmitEvent (void)
	Close the file and emit an event. More...

bool	flush (void)
	Flush the file. More...

bool	writeBuffer (const U8 *const data, const U32 size)

bool	writeSize (const U32 size)

bool	writeBytes (const void *const data, const U32 length)

void	writeHashFile (void)
	Write a hash file. More...

void	close (void)
	Close the file. More...

	BufferLogger (const char *const compName)
	Create a BufferLogger object. More...

void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance)
	Initialize a BufferLogger object. More...

void	initLog (const char const logFilePrefix, const char const logFileSuffix, const U32 maxFileSize, const U8 sizeOfSize)
	Set up log file parameters. More...

void	comIn_handler (const NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)

void	pingIn_handler (const NATIVE_INT_TYPE portNum, U32 key)

void	schedIn_handler (const NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)

void	BL_CloseFile_cmdHandler (const FwOpcodeType opCode, const U32 cmdSeq)

void	BL_SetLogging_cmdHandler (const FwOpcodeType opCode, const U32 cmdSeq, LogState state)

void	BL_FlushFile_cmdHandler (const FwOpcodeType opCode, const U32 cmdSeq)

Public Member Functions inherited from Svc::BufferLoggerComponentBase
Fw::InputBufferSendPort *	get_bufferSendIn_InputPort (NATIVE_INT_TYPE portNum)

Fw::InputCmdPort *	get_cmdIn_InputPort (NATIVE_INT_TYPE portNum)

Fw::InputComPort *	get_comIn_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputSchedPort *	get_schedIn_InputPort (NATIVE_INT_TYPE portNum)

void	set_bufferSendOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)

void	set_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdRegPort *port)

void	set_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)

void	set_eventOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)

void	set_pingOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputPingPort *port)

void	set_timeCaller_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)

void	set_tlmOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)

void	regCommands (void)
	Register commands with the Command Dispatcher. More...

void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)

virtual	~BufferLoggerComponentBase (void)

void	comIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)

void	pingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)

void	schedIn_handlerBase (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)

virtual void	comIn_preMsgHook (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)

virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)

virtual void	schedIn_preMsgHook (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)

void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)

NATIVE_INT_TYPE	getNum_cmdIn_InputPorts (void)

NATIVE_INT_TYPE	getNum_comIn_InputPorts (void)

NATIVE_INT_TYPE	getNum_pingIn_InputPorts (void)

NATIVE_INT_TYPE	getNum_schedIn_InputPorts (void)

NATIVE_INT_TYPE	getNum_cmdRegOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_cmdResponseOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_eventOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_pingOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_timeCaller_OutputPorts (void)

NATIVE_INT_TYPE	getNum_tlmOut_OutputPorts (void)

bool	isConnected_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_eventOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_timeCaller_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_tlmOut_OutputPort (NATIVE_INT_TYPE portNum)

virtual void	BL_CloseFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)

virtual void	BL_SetLogging_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)

virtual void	BL_FlushFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)

void	BL_CloseFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

void	BL_SetLogging_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

void	BL_FlushFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

void	log_WARNING_HI_BL_LogFileOpenError (U32 errornum, Fw::LogStringArg &file)

void	log_WARNING_HI_BL_LogFileValidationError (Fw::LogStringArg &validationFile, U32 status)

void	log_WARNING_HI_BL_LogFileWriteError (U32 errornum, U32 bytesWritten, U32 bytesToWrite, Fw::LogStringArg &file)

void	log_ACTIVITY_LO_BL_Activated (void)

void	log_ACTIVITY_LO_BL_Deativated (void)

void	log_WARNING_HI_BL_NoLogFileOpenInitError (void)

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1)
	called by instantiator when task is to be started More...

void	exit (void)
	exit task in active component More...

Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL More...

virtual	~ActiveComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	initialization code More...

virtual void	preamble (void)
	A function that will be called before the event loop is entered. More...

virtual void	loop (void)
	The function that will loop dispatching messages. More...

virtual void	finalizer (void)
	A function that will be called after exiting the loop. More...

Public Member Functions inherited from Fw::QueuedComponentBase
virtual	~QueuedComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	initialization function More...

Os::Queue::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)

virtual MsgDispatchStatus	doDispatch (void)=0
	method to dispatch a single message in the queue. More...

NATIVE_INT_TYPE	getNumMsgsDropped (void)
	return number of messages dropped More...

void	incNumMsgDropped (void)
	increment the number of messages dropped More...

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...

U32	getIdBase (void) const

virtual	~PassiveComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	Initialization function. More...

NATIVE_INT_TYPE	getInstance (void) const

Public Attributes
PRIVATE	__pad1__: void open(void)

PRIVATE	__pad2__: BufferLogger& bufferLogger

Fw::EightyCharString	prefix
	The prefix to use for file names. More...

Fw::EightyCharString	suffix
	The suffix to use for file names. More...

Fw::EightyCharString	baseName
	The file name base. More...

NATIVE_UINT_TYPE	fileCounter
	The counter to use for the same file name. More...

U32	maxSize
	The maximum file size. More...

U8	sizeOfSize
	The number of bytes to use when storing the size field at the start of each buffer. More...

Fw::EightyCharString	name
	The name of the currently open file. More...

Mode::t	mode

Os::File	osFile
	The underlying Os::File representation. More...

U32	bytesWritten
	The number of bytes written to the current file. More...

PRIVATE	__pad3__: void bufferSendIn_handler( const NATIVE_INT_TYPE portNum
	The port number. More...

PRIVATE Fw::Buffer &	fwBuffer

PRIVATE	__pad4__: void BL_OpenFile_cmdHandler( const FwOpcodeType opCode

PRIVATE const U32	cmdSeq

PRIVATE const U32 const Fw::CmdStringArg &	file

PRIVATE	__pad5__: LogState m_state

File	m_file
	The file. More...

Public Attributes inherited from Svc::BufferLoggerComponentBase
PROTECTED	__pad0__: BufferLoggerComponentBase(void)

PROTECTED	__pad1__: virtual void bufferSendIn_handler( NATIVE_INT_TYPE portNum

PROTECTED Fw::Buffer &	fwBuffer = 0

PROTECTED	__pad2__: void bufferSendIn_handlerBase( NATIVE_INT_TYPE portNum

PROTECTED	__pad3__: virtual void bufferSendIn_preMsgHook( NATIVE_INT_TYPE portNum

PROTECTED	__pad4__: void bufferSendOut_out( NATIVE_INT_TYPE portNum

PROTECTED	__pad5__: NATIVE_INT_TYPE getNum_bufferSendIn_InputPorts(void)

PROTECTED	__pad6__: NATIVE_INT_TYPE getNum_bufferSendOut_OutputPorts(void)

PROTECTED	__pad7__: bool isConnected_bufferSendOut_OutputPort( NATIVE_INT_TYPE portNum )

PROTECTED	__pad8__: typedef enum { LOGGING_ON

PROTECTED	LOGGING_OFF

PROTECTED LogState_MAX	LogState

PROTECTED	__pad9__: enum { OPCODE_BL_OPENFILE = 0x00

PROTECTED	OPCODE_BL_CLOSEFILE = 0x01

PROTECTED	OPCODE_BL_SETLOGGING = 0x02

PROTECTED	OPCODE_BL_FLUSHFILE = 0x03

PROTECTED	PROTECTED: virtual void BL_OpenFile_cmdHandler( FwOpcodeType opCode

PROTECTED U32	cmdSeq

PROTECTED U32 const Fw::CmdStringArg &	file = 0

PROTECTED	__pad10__: virtual void BL_OpenFile_preMsgHook( FwOpcodeType opCode

PROTECTED	__pad11__: void BL_OpenFile_cmdHandlerBase( FwOpcodeType opCode

PROTECTED U32 Fw::CmdArgBuffer &	args

PROTECTED	__pad12__: void cmdResponse_out( FwOpcodeType opCode

PROTECTED U32 Fw::CommandResponse	response

PROTECTED	__pad13__: enum { EVENTID_BL_LOGFILECLOSED = 0x00

PROTECTED	EVENTID_BL_LOGFILEOPENERROR = 0x01

PROTECTED	EVENTID_BL_LOGFILEVALIDATIONERROR = 0x02

PROTECTED	EVENTID_BL_LOGFILEWRITEERROR = 0x03

PROTECTED	EVENTID_BL_ACTIVATED = 0x04

PROTECTED	EVENTID_BL_DEATIVATED = 0x05

PROTECTED	EVENTID_BL_NOLOGFILEOPENINITERROR = 0x06

PROTECTED	__pad14__: enum { CHANNELID_BUFFERLOGGER_NUMLOGGEDBUFFERS = 0
	Channel ID for BufferLogger_NumLoggedBuffers. More...

PROTECTED	__pad15__: Fw::Time getTime(void)

PRIVATE	__pad16__: Fw::InputBufferSendPort m_bufferSendIn_InputPort[NUM_BUFFERSENDIN_INPUT_PORTS]

Fw::InputCmdPort	m_cmdIn_InputPort [NUM_CMDIN_INPUT_PORTS]

Fw::InputComPort	m_comIn_InputPort [NUM_COMIN_INPUT_PORTS]

Svc::InputPingPort	m_pingIn_InputPort [NUM_PINGIN_INPUT_PORTS]

Svc::InputSchedPort	m_schedIn_InputPort [NUM_SCHEDIN_INPUT_PORTS]

PRIVATE	__pad17__: Fw::OutputBufferSendPort m_bufferSendOut_OutputPort[NUM_BUFFERSENDOUT_OUTPUT_PORTS]

Fw::OutputCmdRegPort	m_cmdRegOut_OutputPort [NUM_CMDREGOUT_OUTPUT_PORTS]

Fw::OutputCmdResponsePort	m_cmdResponseOut_OutputPort [NUM_CMDRESPONSEOUT_OUTPUT_PORTS]

Fw::OutputLogPort	m_eventOut_OutputPort [NUM_EVENTOUT_OUTPUT_PORTS]

Svc::OutputPingPort	m_pingOut_OutputPort [NUM_PINGOUT_OUTPUT_PORTS]

Fw::OutputTimePort	m_timeCaller_OutputPort [NUM_TIMECALLER_OUTPUT_PORTS]

Fw::OutputTlmPort	m_tlmOut_OutputPort [NUM_TLMOUT_OUTPUT_PORTS]

PRIVATE	__pad18__: static void m_p_bufferSendIn_in( Fw::PassiveComponentBase* callComp

PRIVATE NATIVE_INT_TYPE	portNum

PRIVATE NATIVE_INT_TYPE Fw::Buffer &	fwBuffer

PRIVATE	__pad19__: virtual MsgDispatchStatus doDispatch(void)

Public Attributes inherited from Fw::ActiveComponentBase
PROTECTED	__pad0__: ActiveComponentBase(const char* name)
	Constructor. More...

Os::Task	m_task
	task object for active component More...

PRIVATE	__pad1__: static void s_baseTask(void*)
	function provided to task class for new thread. More...

Public Attributes inherited from Fw::QueuedComponentBase
PROTECTED	__pad0__: QueuedComponentBase(const char* name)
	Constructor. More...

Os::Queue	m_queue
	queue object for active component More...

PRIVATE	__pad1__: NATIVE_INT_TYPE m_msgsDropped
	number of messages dropped from full queue More...

Public Attributes inherited from Fw::PassiveComponentBase
PROTECTED	__pad0__: PassiveComponentBase(const char* name)
	Named constructor. More...

PRIVATE	__pad1__: U32 m_idBase
	ID base for opcodes etc. More...

NATIVE_INT_TYPE	m_instance
	instance of component object More...

Additional Inherited Members
Public Types inherited from Svc::BufferLoggerComponentBase
enum	{ NUM_BUFFERSENDIN_INPUT_PORTS = 1, NUM_CMDIN_INPUT_PORTS = 1, NUM_COMIN_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1, NUM_SCHEDIN_INPUT_PORTS = 1 }

enum	{ NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1, NUM_CMDREGOUT_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_EVENTOUT_OUTPUT_PORTS = 1, NUM_EVENTOUTTEXT_OUTPUT_PORTS = 1, NUM_PINGOUT_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1, NUM_TLMOUT_OUTPUT_PORTS = 1 }

Public Types inherited from Fw::ActiveComponentBase
enum	{ ACTIVE_COMPONENT_EXIT }

Public Types inherited from Fw::QueuedComponentBase
enum	MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT }

Static Public Member Functions inherited from Svc::BufferLoggerComponentBase
static void	m_p_cmdIn_in (Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

static void	m_p_comIn_in (Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)

static void	m_p_pingIn_in (Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, U32 key)

static void	m_p_schedIn_in (Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)

Static Public Member Functions inherited from Fw::ActiveComponentBase
static void	s_baseBareTask (void *)
	function provided to task class for new thread. More...

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...

virtual	~ObjBase ()
	Destructor. More...

void	init (void)
	Object initializer. More...

Detailed Description

Definition at line 25 of file BufferLogger.hpp.

Constructor & Destructor Documentation

◆ ~File()

Svc::BufferLogger::~File ( void )

Destroy a File object.

◆ BufferLogger()

Svc::BufferLogger::BufferLogger ( const char *const compName )

Create a BufferLogger object.

Parameters

compName The component name

Definition at line 21 of file BufferLogger.cpp.

Member Function Documentation

◆ BL_CloseFile_cmdHandler()

void Svc::BufferLogger::BL_CloseFile_cmdHandler	(	const FwOpcodeType	opCode,
		const U32	cmdSeq
	)

virtual

Implementation for BL_CloseFile command handler Close the currently open log file, if any

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Implements Svc::BufferLoggerComponentBase.

Definition at line 118 of file BufferLogger.cpp.

◆ BL_FlushFile_cmdHandler()

void Svc::BufferLogger::BL_FlushFile_cmdHandler	(	const FwOpcodeType	opCode,
		const U32	cmdSeq
	)

virtual

Implementation for BL_FlushFile command handler Flushes the current open log file to disk

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Implements Svc::BufferLoggerComponentBase.

Definition at line 142 of file BufferLogger.cpp.

◆ BL_SetLogging_cmdHandler()

void Svc::BufferLogger::BL_SetLogging_cmdHandler	(	const FwOpcodeType	opCode,
		const U32	cmdSeq,
		LogState	state
	)

virtual

Implementation for BL_SetLogging command handler Sets the volatile logging state

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Implements Svc::BufferLoggerComponentBase.

Definition at line 128 of file BufferLogger.cpp.

◆ close()

void Svc::BufferLogger::close ( void )

Close the file.

◆ closeAndEmitEvent()

void Svc::BufferLogger::closeAndEmitEvent ( void )

Close the file and emit an event.

◆ comIn_handler()

void Svc::BufferLogger::comIn_handler	(	const NATIVE_INT_TYPE	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

virtual

Handler implementation for comIn

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Implements Svc::BufferLoggerComponentBase.

Definition at line 73 of file BufferLogger.cpp.

◆ File()

Svc::BufferLogger::File ( BufferLogger & bufferLogger )

Construct a File object.

Parameters

bufferLogger The enclosing BufferLogger instance

◆ flush()

bool Svc::BufferLogger::flush ( void )

Flush the file.

◆ init() [1/2]

void Svc::BufferLogger::init	(	const char *const	prefix,
		const char *const	suffix,
		const U32	maxSize,
		const U8	sizeOfSize
	)

Set File object parameters.

Parameters

prefix	The file name prefix
suffix	The file name suffix
maxSize	The maximum file size
sizeOfSize	The number of bytes to use when storing the size field and the start of each buffer)

◆ init() [2/2]

void Svc::BufferLogger::init	(	const NATIVE_INT_TYPE	queueDepth,
		const NATIVE_INT_TYPE	instance
	)

Initialize a BufferLogger object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 30 of file BufferLogger.cpp.

◆ initLog()

void Svc::BufferLogger::initLog	(	const char *const	logFilePrefix,
		const char *const	logFileSuffix,
		const U32	maxFileSize,
		const U8	sizeOfSize
	)

Set up log file parameters.

Parameters

logFilePrefix	The log file name prefix
logFileSuffix	The log file name suffix
maxFileSize	The maximum file size
sizeOfSize	The number of bytes to use when storing the size field at the start of each buffer

Definition at line 44 of file BufferLogger.cpp.

◆ logBuffer()

void Svc::BufferLogger::logBuffer	(	const U8 *const	data,
		const U32	size
	)

Log a buffer.

Parameters

data	The buffer data
size	The size

◆ pingIn_handler()

void Svc::BufferLogger::pingIn_handler	(	const NATIVE_INT_TYPE	portNum,
		U32	key
	)

virtual

Handler implementation for pingIn

Parameters

portNum	The port number
key	Value to return to pinger

Implements Svc::BufferLoggerComponentBase.

Definition at line 87 of file BufferLogger.cpp.

◆ schedIn_handler()

void Svc::BufferLogger::schedIn_handler	(	const NATIVE_INT_TYPE	portNum,
		NATIVE_UINT_TYPE	context
	)

virtual

Handler implementation for schedIn

Parameters

portNum	The port number
context	The call order

Implements Svc::BufferLoggerComponentBase.

Definition at line 93 of file BufferLogger.cpp.

◆ setBaseName()

void Svc::BufferLogger::setBaseName ( const Fw::EightyCharString & baseName )

Set base file name.

Parameters

baseName The base file name; used with prefix, unique counter value, and suffix

◆ writeBuffer()

bool Svc::BufferLogger::writeBuffer	(	const U8 *const	data,
		const U32	size
	)

Write a buffer to a file

Returns: Success or failure

Parameters

data	The buffer data
size	The number of bytes to write

◆ writeBytes()

bool Svc::BufferLogger::writeBytes	(	const void *const	data,
		const U32	length
	)

Write bytes to a file

Returns: Success or failure

Parameters

data	The data
length	The number of bytes to write

◆ writeHashFile()

void Svc::BufferLogger::writeHashFile ( void )

Write a hash file.

◆ writeSize()

bool Svc::BufferLogger::writeSize ( const U32 size )

Write the size field of a buffer

Returns: Success or failure

Parameters

size The size

Member Data Documentation

◆ pad1

PRIVATE Svc::BufferLogger::__pad1__

Definition at line 85 of file BufferLogger.hpp.

◆ pad2

PRIVATE Svc::BufferLogger::__pad2__

Definition at line 116 of file BufferLogger.hpp.

◆ pad3

PRIVATE Svc::BufferLogger::__pad3__

The port number.

Definition at line 182 of file BufferLogger.hpp.

◆ pad4

PRIVATE Svc::BufferLogger::__pad4__

The opcode

Definition at line 217 of file BufferLogger.hpp.

◆ pad5

PRIVATE Svc::BufferLogger::__pad5__

Definition at line 253 of file BufferLogger.hpp.

◆ baseName

Fw::EightyCharString Svc::BufferLogger::baseName

The file name base.

Definition at line 128 of file BufferLogger.hpp.

◆ bytesWritten

U32 Svc::BufferLogger::bytesWritten

The number of bytes written to the current file.

Definition at line 149 of file BufferLogger.hpp.

◆ cmdSeq

PRIVATE const U32 Svc::BufferLogger::cmdSeq

The command sequence number

Definition at line 227 of file BufferLogger.hpp.

◆ file

PRIVATE const U32 const Fw::CmdStringArg& Svc::BufferLogger::file

Definition at line 228 of file BufferLogger.hpp.

◆ fileCounter

NATIVE_UINT_TYPE Svc::BufferLogger::fileCounter

The counter to use for the same file name.

Definition at line 131 of file BufferLogger.hpp.

◆ fwBuffer

PRIVATE Fw::Buffer& Svc::BufferLogger::fwBuffer

Definition at line 192 of file BufferLogger.hpp.

◆ m_file

File Svc::BufferLogger::m_file

The file.

Definition at line 263 of file BufferLogger.hpp.

◆ maxSize

U32 Svc::BufferLogger::maxSize

The maximum file size.

Definition at line 134 of file BufferLogger.hpp.

◆ mode

Mode::t Svc::BufferLogger::mode

Definition at line 143 of file BufferLogger.hpp.

◆ name

Fw::EightyCharString Svc::BufferLogger::name

The name of the currently open file.

Definition at line 140 of file BufferLogger.hpp.

◆ osFile

Os::File Svc::BufferLogger::osFile

The underlying Os::File representation.

Definition at line 146 of file BufferLogger.hpp.

◆ prefix

Fw::EightyCharString Svc::BufferLogger::prefix

The prefix to use for file names.

Definition at line 122 of file BufferLogger.hpp.

◆ sizeOfSize

U8 Svc::BufferLogger::sizeOfSize

The number of bytes to use when storing the size field at the start of each buffer.

Definition at line 137 of file BufferLogger.hpp.

◆ suffix

Fw::EightyCharString Svc::BufferLogger::suffix

The suffix to use for file names.

Definition at line 125 of file BufferLogger.hpp.

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

Svc/BufferLogger/BufferLogger.hpp
Svc/BufferLogger/BufferLogger.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~File()

◆ BufferLogger()

Member Function Documentation

◆ BL_CloseFile_cmdHandler()

◆ BL_FlushFile_cmdHandler()

◆ BL_SetLogging_cmdHandler()

◆ close()

◆ closeAndEmitEvent()

◆ comIn_handler()

◆ File()

◆ flush()

◆ init() [1/2]

◆ init() [2/2]

◆ initLog()

◆ logBuffer()

◆ pingIn_handler()

◆ schedIn_handler()

◆ setBaseName()

◆ writeBuffer()

◆ writeBytes()

◆ writeHashFile()

◆ writeSize()

Member Data Documentation

◆ __pad1__

◆ __pad2__

◆ __pad3__

◆ __pad4__

◆ __pad5__

◆ baseName

◆ bytesWritten

◆ cmdSeq

◆ file

◆ fileCounter

◆ fwBuffer

◆ m_file

◆ maxSize

◆ mode

◆ name

◆ osFile

◆ prefix

◆ sizeOfSize

◆ suffix

◆ pad1

◆ pad2

◆ pad3

◆ pad4

◆ pad5