#include <Svc/ComLogger/ComLogger.hpp>

Inheritance diagram for Svc::ComLogger:

Public Member Functions
	ComLogger (const char compName, const char filePrefix, U32 maxFileSize, bool storeBufferLength=true)

	ComLogger (const char *compName)

void	init_log_file (const char *filePrefix, U32 maxFileSize, bool storeBufferLength=true)

	~ComLogger ()

Public Member Functions inherited from Svc::ComLoggerComponentBase
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize ComLoggerComponentBase object. More...

Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)

Fw::InputComPort *	get_comIn_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)

void	set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegOut[portNum]. More...

void	set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum]. More...

void	set_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to logOut[portNum]. More...

void	set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum]. More...

void	set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum]. More...

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

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

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

Os::Task::Status	join ()
	Join the thread. More...

	DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
	Join to thread with discarded value_ptr. More...

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

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::ComLoggerComponentBase
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...

enum	{ NUM_COMIN_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_LOGOUT_OUTPUT_PORTS = 1 , NUM_TIMECALLER_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ OPCODE_CLOSEFILE = 0x0 }
	Command opcodes. More...

enum	{ EVENTID_FILEOPENERROR = 0x0 , EVENTID_FILEWRITEERROR = 0x1 , EVENTID_FILEVALIDATIONERROR = 0x2 , EVENTID_FILECLOSED = 0x3 , EVENTID_FILENOTINITIALIZED = 0x4 }
	Event IDs. More...

enum	{ EVENTID_FILENOTINITIALIZED_THROTTLE = 5 }
	Event throttle values: sets initial value of countdown variables. More...

Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE }
	Tracks the lifecycle of the component. More...

Protected Member Functions inherited from Svc::ComLoggerComponentBase
	ComLoggerComponentBase (const char *compName="")
	Construct ComLoggerComponentBase object. More...

virtual	~ComLoggerComponentBase ()
	Destroy ComLoggerComponentBase object. More...

FwIndexType	getNum_cmdIn_InputPorts () const

FwIndexType	getNum_comIn_InputPorts () const

FwIndexType	getNum_pingIn_InputPorts () const

FwIndexType	getNum_cmdRegOut_OutputPorts () const

FwIndexType	getNum_cmdResponseOut_OutputPorts () const

FwIndexType	getNum_logOut_OutputPorts () const

FwIndexType	getNum_timeCaller_OutputPorts () const

FwIndexType	getNum_pingOut_OutputPorts () const

bool	isConnected_cmdRegOut_OutputPort (FwIndexType portNum)

bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum)

bool	isConnected_logOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)

bool	isConnected_pingOut_OutputPort (FwIndexType portNum)

void	comIn_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Handler base-class function for input port comIn. More...

void	pingIn_handlerBase (FwIndexType portNum, U32 key)
	Handler base-class function for input port pingIn. More...

virtual void	comIn_preMsgHook (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Pre-message hook for async input port comIn. More...

virtual void	pingIn_preMsgHook (FwIndexType portNum, U32 key)
	Pre-message hook for async input port pingIn. More...

void	pingOut_out (FwIndexType portNum, U32 key)
	Invoke output port pingOut. More...

void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...

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

virtual void	CloseFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CloseFile. More...

void	log_WARNING_HI_FileOpenError (U32 errornum, const Fw::StringBase &file)

void	log_WARNING_HI_FileWriteError (U32 errornum, U32 bytesWritten, U32 bytesToWrite, const Fw::StringBase &file)

void	log_WARNING_LO_FileValidationError (const Fw::StringBase &validationFile, const Fw::StringBase &file, U32 status)

void	log_DIAGNOSTIC_FileClosed (const Fw::StringBase &file)

void	log_WARNING_LO_FileNotInitialized ()
	Log event FileNotInitialized. More...

void	log_WARNING_LO_FileNotInitialized_ThrottleClear ()
	Reset throttle value for FileNotInitialized. More...

Fw::Time	getTime ()

Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...

virtual	~ActiveComponentBase ()
	Destructor. More...

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

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

MsgDispatchStatus	dispatch ()
	The function that will dispatching messages. More...

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

Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor. More...

virtual	~QueuedComponentBase ()
	Destructor. More...

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

Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)

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

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

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

virtual	~PassiveComponentBase ()
	Destructor. More...

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

NATIVE_INT_TYPE	getInstance () const

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

virtual	~ObjBase ()
	Destructor. More...

void	init ()
	Object initializer. More...

Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task	m_task
	task object for active component More...

Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component More...

Detailed Description

Definition at line 36 of file ComLogger.hpp.

Constructor & Destructor Documentation

◆ ComLogger() [1/2]

Svc::ComLogger::ComLogger	(	const char *	compName,
		const char *	filePrefix,
		U32	maxFileSize,
		bool	storeBufferLength = `true`
	)

Definition at line 20 of file ComLogger.cpp.

◆ ComLogger() [2/2]

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

Definition at line 34 of file ComLogger.cpp.

◆ ~ComLogger()

Svc::ComLogger::~ComLogger ( )

Definition at line 70 of file ComLogger.cpp.

Member Function Documentation

◆ init_log_file()

void Svc::ComLogger::init_log_file	(	const char *	filePrefix,
		U32	maxFileSize,
		bool	storeBufferLength = `true`
	)

Definition at line 50 of file ComLogger.cpp.

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

Svc/ComLogger/ComLogger.hpp
Svc/ComLogger/ComLogger.cpp

Public Member Functions