Fawkes API  Fawkes Development Version
fawkes::NetworkLoggerMessageContent Class Reference

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

#include <>>

Inheritance diagram for fawkes::NetworkLoggerMessageContent:

Public Member Functions

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

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. More...
 
- Protected Attributes inherited from fawkes::FawkesNetworkMessageContent
void * _payload
 Pointer to payload. More...
 
size_t _payload_size
 Payloda size. More...
 

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

◆ NetworkLoggerMessageContent() [1/4]

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

Constructor.

Parameters
log_levelLog level
ttime
componentcomponent string
is_exceptiontrue if this message originates from an exception, false otherwise
messagemessage string.

Definition at line 480 of file network.cpp.

References fawkes::Logger::log_level.

◆ NetworkLoggerMessageContent() [2/4]

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_levelLog level
ttime
componentcomponent string
is_exceptiontrue if this message originates from an exception, false otherwise
formatmessage string format
vava_list containing the arguments for the given format

Definition at line 447 of file network.cpp.

References fawkes::Logger::log_level.

◆ NetworkLoggerMessageContent() [3/4]

fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent ( const NetworkLoggerMessageContent content)

Copy constructor.

Parameters
contentcontent to copy

Definition at line 504 of file network.cpp.

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

◆ NetworkLoggerMessageContent() [4/4]

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_idcomponent ID
msg_idmessage ID
payloadpayload
payload_sizepayload size

Definition at line 523 of file network.cpp.

◆ ~NetworkLoggerMessageContent()

fawkes::NetworkLoggerMessageContent::~NetworkLoggerMessageContent ( )
virtual

Destructor.

Definition at line 540 of file network.cpp.

Member Function Documentation

◆ get_component()

const char * fawkes::NetworkLoggerMessageContent::get_component ( ) const

Get component.

Returns
component string

Definition at line 562 of file network.cpp.

Referenced by fawkes::LogView::append_message().

◆ get_loglevel()

Logger::LogLevel fawkes::NetworkLoggerMessageContent::get_loglevel ( ) const

Log level.

Returns
log level.

Definition at line 582 of file network.cpp.

Referenced by fawkes::LogView::append_message().

◆ get_message()

const char * fawkes::NetworkLoggerMessageContent::get_message ( ) const

Get message.

Returns
message string

Definition at line 572 of file network.cpp.

Referenced by fawkes::LogView::append_message().

◆ get_time()

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

Get time.

Returns
time of the log message

Definition at line 549 of file network.cpp.

Referenced by fawkes::LogView::append_message().

◆ is_exception()

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.

Referenced by fawkes::LogView::append_message().

◆ serialize()

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: