FACE::Logging Class Reference

This is the Logging Services client interface. More...

#include <Logging.hpp>

Data Structures
struct	SEVERITY_LEVEL

Public Types
typedef STRING_TYPE	TEXT_MESSAGE_TYPE
	This type represents a text log message.
typedef UnsignedLong	LENGTH_TYPE
	This type is used to represent a size in bytes.

Public Member Functions
virtual void	Log_Text (TEXT_MESSAGE_TYPE message, SEVERITY_LEVEL::Value severity, RETURN_CODE_TYPE::Value &return_code)=0
	Log a text message.
virtual void	Log_Binary (SYSTEM_ADDRESS_TYPE message, LENGTH_TYPE length, SEVERITY_LEVEL::Value severity, RETURN_CODE_TYPE::Value &return_code)=0
	Log a binary message.

---

Detailed Description

This is the Logging Services client interface.

---

Member Typedef Documentation

typedef STRING_TYPE FACE::Logging::TEXT_MESSAGE_TYPE

This type represents a text log message.

typedef UnsignedLong FACE::Logging::LENGTH_TYPE

This type is used to represent a size in bytes.

---

Member Function Documentation

virtual void FACE::Logging::Log_Text ( TEXT_MESSAGE_TYPE  message, SEVERITY_LEVEL::Value  severity, RETURN_CODE_TYPE::Value &  return_code  )

pure virtual

Log a text message.

This method is used to log a message in text format.

Parameters:

[in]	message	contains the log message to be logged
[in]	severity	is the severity level from the interface user perspective
[out]	return_code	contains a status code indicating success or failure

Upon return, return_code will contain:

• NO_ERROR is returned in return_code to indicate successful completion of the operation.
• INVALID_CONFIG to indicate that the interface is not properly configured for use
• INVALID_PARAM to indicate that either the buffer or return_code pointer (in appropriate languages) is invalid or the message is of zero length

virtual void FACE::Logging::Log_Binary ( SYSTEM_ADDRESS_TYPE  message, LENGTH_TYPE  length, SEVERITY_LEVEL::Value  severity, RETURN_CODE_TYPE::Value &  return_code  )

pure virtual

Log a binary message.

The Log_Binary method is used to log a message that is

This method is used to log a message that is expressed in binary form.

Parameters:

[in]	buffer	contains the binary log message to be logged
[in]	severity	is the severity level from the interface user perspective
[out]	return_code	contains a status code indicating success or failure

Upon return, return_code will contain:

• NO_ERROR is returned in return_code to indicate successful completion of the operation.
• INVALID_CONFIG to indicate that the interface is not properly configured for use
• INVALID_PARAM to indicate that either the message or return_code pointer (in appropriate languages) is invalid or the message is of zero length