Svc::BufferLogger Class Reference

#include <Svc/BufferLogger/BufferLogger.hpp>

Inheritance diagram for Svc::BufferLogger:

Public Member Functions
	BufferLogger (const char *const compName)
	Create a BufferLogger object.
void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance)
	Initialize a BufferLogger object.
void	initLog (const char *const logFilePrefix, const char *const logFileSuffix, const U32 maxFileSize, const U8 sizeOfSize)
	Set up log file parameters.
Public Member Functions inherited from Svc::BufferLoggerComponentBase
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Initialize BufferLoggerComponentBase object.
Fw::InputCmdPort *	get_cmdIn_InputPort (NATIVE_INT_TYPE portNum)
Fw::InputBufferSendPort *	get_bufferSendIn_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_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegOut[portNum].
void	set_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum].
void	set_eventOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum].
void	set_timeCaller_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum].
void	set_tlmOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum].
void	set_bufferSendOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferSendOut[portNum].
void	set_pingOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum].
void	regCommands ()
	Register commands with the Command Dispatcher.
Public Member Functions inherited from Fw::ActiveComponentBase
void	start (NATIVE_UINT_TYPE priority=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE stackSize=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE cpuAffinity=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started
	DEPRECATED (void start(NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1), "Please switch to start(NATIVE_UINT_TYPE priority, NATIVE_UINT_TYPE stackSize, NATIVE_UINT_TYPE cpuAffinity, NATIVE_UINT_TYPE identifier)")
	called by instantiator when task is to be started
void	exit ()
	exit task in active component
Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base.
U32	getIdBase () const

Additional Inherited Members
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 }
Protected Types inherited from Svc::BufferLoggerComponentBase
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...
enum	{ NUM_BUFFERSENDIN_INPUT_PORTS = 1 , NUM_COMIN_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 , NUM_SCHEDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{   NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUTTEXT_OUTPUT_PORTS = 1 ,   NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{ NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...
enum	{ OPCODE_BL_OPENFILE = 0x0 , OPCODE_BL_CLOSEFILE = 0x1 , OPCODE_BL_SETLOGGING = 0x2 , OPCODE_BL_FLUSHFILE = 0x3 }
	Command opcodes. More...
enum	{   EVENTID_BL_LOGFILECLOSED = 0x0 , EVENTID_BL_LOGFILEOPENERROR = 0x1 , EVENTID_BL_LOGFILEVALIDATIONERROR = 0x2 , EVENTID_BL_LOGFILEWRITEERROR = 0x3 ,   EVENTID_BL_ACTIVATED = 0x4 , EVENTID_BL_DEACTIVATED = 0x5 , EVENTID_BL_NOLOGFILEOPENINITERROR = 0x6 }
	Event IDs. More...
enum	{ CHANNELID_BUFFERLOGGER_NUMLOGGEDBUFFERS = 0x0 }
	Channel IDs. More...
Protected Member Functions inherited from Svc::BufferLoggerComponentBase
	BufferLoggerComponentBase (const char *compName="")
	Construct BufferLoggerComponentBase object.
virtual	~BufferLoggerComponentBase ()
	Destroy BufferLoggerComponentBase object.
NATIVE_INT_TYPE	getNum_cmdIn_InputPorts ()
NATIVE_INT_TYPE	getNum_bufferSendIn_InputPorts ()
NATIVE_INT_TYPE	getNum_comIn_InputPorts ()
NATIVE_INT_TYPE	getNum_pingIn_InputPorts ()
NATIVE_INT_TYPE	getNum_schedIn_InputPorts ()
NATIVE_INT_TYPE	getNum_cmdRegOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_cmdResponseOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_eventOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_timeCaller_OutputPorts ()
NATIVE_INT_TYPE	getNum_tlmOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_bufferSendOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_pingOut_OutputPorts ()
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_timeCaller_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_tlmOut_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_bufferSendOut_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)
void	bufferSendIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferSendIn.
void	comIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
	Handler base-class function for input port comIn.
void	pingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)
	Handler base-class function for input port pingIn.
void	schedIn_handlerBase (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)
	Handler base-class function for input port schedIn.
virtual void	bufferSendIn_preMsgHook (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Pre-message hook for async input port bufferSendIn.
virtual void	comIn_preMsgHook (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
	Pre-message hook for async input port comIn.
virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)
	Pre-message hook for async input port pingIn.
virtual void	schedIn_preMsgHook (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)
	Pre-message hook for async input port schedIn.
void	bufferSendOut_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Invoke output port bufferSendOut.
void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)
	Invoke output port pingOut.
void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response.
void	BL_OpenFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
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)
virtual void	BL_OpenFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command BL_OpenFile.
virtual void	BL_CloseFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command BL_CloseFile.
virtual void	BL_SetLogging_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command BL_SetLogging.
virtual void	BL_FlushFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command BL_FlushFile.
void	log_DIAGNOSTIC_BL_LogFileClosed (const Fw::LogStringArg &file)
void	log_WARNING_HI_BL_LogFileOpenError (U32 errornum, const Fw::LogStringArg &file)
void	log_WARNING_HI_BL_LogFileValidationError (const Fw::LogStringArg &validationFile, U32 status)
void	log_WARNING_HI_BL_LogFileWriteError (U32 errornum, U32 bytesWritten, U32 bytesToWrite, const Fw::LogStringArg &file)
void	log_ACTIVITY_LO_BL_Activated ()
void	log_ACTIVITY_LO_BL_Deactivated ()
void	log_WARNING_HI_BL_NoLogFileOpenInitError ()
void	tlmWrite_BufferLogger_NumLoggedBuffers (U32 arg, Fw::Time _tlmTime=Fw::Time())
Fw::Time	getTime ()
Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor.
virtual	~ActiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	initialization code
virtual void	preamble ()
	A function that will be called before the event loop is entered.
virtual void	loop ()
	The function that will loop dispatching messages.
virtual void	finalizer ()
	A function that will be called after exiting the loop.
Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor.
virtual	~QueuedComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	initialization function
Os::Queue::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
NATIVE_INT_TYPE	getNumMsgsDropped ()
	return number of messages dropped
void	incNumMsgDropped ()
	increment the number of messages dropped
Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor.
virtual	~PassiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	Initialization function.
NATIVE_INT_TYPE	getInstance () const
Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor.
virtual	~ObjBase ()
	Destructor.
void	init ()
	Object initializer.
Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task	m_task
	task object for active component
Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component

Detailed Description

Definition at line 25 of file BufferLogger.hpp.

Constructor & Destructor Documentation

BufferLogger()

Svc::BufferLogger::BufferLogger

(

const char *const

compName

)

Create a BufferLogger object.

Parameters

compName

The component name

Definition at line 22 of file BufferLogger.cpp.

Member Function Documentation

init()

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 31 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 45 of file BufferLogger.cpp.

---

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

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