fawkes::NetworkLoggerMessageContent Class Reference

Message sent over the network with a log message. More...

#include <>>

Inheritance diagram for fawkes::NetworkLoggerMessageContent:

List of all members.

Public Member Functions
	NetworkLoggerMessageContent (Logger::LogLevel log_level, struct timeval *t, const char *component, bool is_exception, const char *message)
	Constructor.
	NetworkLoggerMessageContent (Logger::LogLevel log_level, struct timeval *t, const char *component, bool is_exception, const char *format, va_list va)
	Constructor.
	NetworkLoggerMessageContent (const NetworkLoggerMessageContent *content)
	Copy constructor.
	NetworkLoggerMessageContent (unsigned int component_id, unsigned int msg_id, void *payload, size_t payload_size)
	Message parsing constructor.
virtual	~NetworkLoggerMessageContent ()
	Destructor.
struct timeval	get_time () const
	Get time.
Logger::LogLevel	get_loglevel () const
	Log level.
const char *	get_component () const
	Get component.
const char *	get_message () const
	Get message.
bool	is_exception () const
	Check if message was generated by exception.
virtual void	serialize ()
	Serialize message content.
Public Member Functions inherited from fawkes::FawkesNetworkMessageContent
	FawkesNetworkMessageContent ()
	Constructor.
virtual	~FawkesNetworkMessageContent ()
	Virtual empty destructor.
virtual void *	payload ()
	Return pointer to payload.
virtual size_t	payload_size ()
	Return payload size.

Additional Inherited Members
Protected Member Functions inherited from fawkes::FawkesNetworkMessageContent
void	copy_payload (size_t offset, const void *buf, size_t len)
	Copy payload into payload buffer to a specified offset.
Protected Attributes inherited from fawkes::FawkesNetworkMessageContent
void *	_payload
	Pointer to payload.
size_t	_payload_size
	Payloda size.

---

Detailed Description

Message sent over the network with a log message.

Contains a buffer with a small header and two null-terminated strings, the first being the component and the second being the real message.

Author:

Tim Niemueller

Definition at line 120 of file network.h.

---

Constructor & Destructor Documentation

fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent	(	Logger::LogLevel	log_level,
		struct timeval *	t,
		const char *	component,
		bool	is_exception,
		const char *	message
	)

Constructor.

Parameters:

log_level	Log level
t	time
component	component string
is_exception	true if this message originates from an exception, false otherwise
message	message string.

Definition at line 480 of file network.cpp.

References fawkes::FawkesNetworkMessageContent::_payload, fawkes::FawkesNetworkMessageContent::_payload_size, fawkes::FawkesNetworkMessageContent::copy_payload(), fawkes::NetworkLogger::network_logger_header_t::log_level, fawkes::NetworkLogger::network_logger_header_t::time_sec, and fawkes::NetworkLogger::network_logger_header_t::time_usec.

fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent	(	Logger::LogLevel	log_level,
		struct timeval *	t,
		const char *	component,
		bool	is_exception,
		const char *	format,
		va_list	va
	)

Constructor.

Parameters:

log_level	Log level
t	time
component	component string
is_exception	true if this message originates from an exception, false otherwise
format	message string format
va	va_list containing the arguments for the given format

Definition at line 447 of file network.cpp.

References fawkes::FawkesNetworkMessageContent::_payload, fawkes::FawkesNetworkMessageContent::_payload_size, fawkes::FawkesNetworkMessageContent::copy_payload(), fawkes::NetworkLogger::network_logger_header_t::log_level, fawkes::NetworkLogger::network_logger_header_t::time_sec, and fawkes::NetworkLogger::network_logger_header_t::time_usec.

fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent

(

const NetworkLoggerMessageContent *

content

)

Copy constructor.

Parameters:

content

content to copy

Definition at line 504 of file network.cpp.

References fawkes::FawkesNetworkMessageContent::_payload, and fawkes::FawkesNetworkMessageContent::_payload_size.

fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent	(	unsigned int	component_id,
		unsigned int	msg_id,
		void *	payload,
		size_t	payload_size
	)

Message parsing constructor.

To be used with FawkesNetworkMessage::msgc().

Parameters:

component_id	component ID
msg_id	message ID
payload	payload
payload_size	payload size

Definition at line 523 of file network.cpp.

References fawkes::FawkesNetworkMessageContent::_payload, fawkes::FawkesNetworkMessageContent::_payload_size, fawkes::FawkesNetworkMessageContent::payload(), and fawkes::FawkesNetworkMessageContent::payload_size().

fawkes::NetworkLoggerMessageContent::~NetworkLoggerMessageContent ( )

virtual

Destructor.

Definition at line 540 of file network.cpp.

References fawkes::FawkesNetworkMessageContent::_payload.

---

Member Function Documentation

const char * fawkes::NetworkLoggerMessageContent::get_component

(

)

const

Get component.

Returns:

component string

Definition at line 562 of file network.cpp.

Logger::LogLevel fawkes::NetworkLoggerMessageContent::get_loglevel

(

)

const

Log level.

Returns:

log level.

Definition at line 582 of file network.cpp.

References fawkes::NetworkLogger::network_logger_header_t::log_level.

const char * fawkes::NetworkLoggerMessageContent::get_message

(

)

const

Get message.

Returns:

message string

Definition at line 572 of file network.cpp.

struct timeval fawkes::NetworkLoggerMessageContent::get_time ( ) const

read

Get time.

Returns:

time of the log message

Definition at line 549 of file network.cpp.

bool fawkes::NetworkLoggerMessageContent::is_exception

(

)

const

Check if message was generated by exception.

Returns:

true if message was generated by exception, false otherwise

Definition at line 592 of file network.cpp.

void fawkes::NetworkLoggerMessageContent::serialize ( )

virtual

Serialize message content.

Generate a single contiguous buffer. Make _payload point to this buffer and _payload_size contain the size of the buffer.

Implements fawkes::FawkesNetworkMessageContent.

Definition at line 41 of file network.cpp.

---

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

• src/libs/logging/network.h
• src/libs/logging/network.cpp