Fawkes API  Fawkes Development Version
network_logger.h
1 
2 /***************************************************************************
3  * network_logger.h - Fawkes network logger
4  *
5  * Created: Sat Dec 15 00:45:54 2007 (after I5 xmas party)
6  * Copyright 2006-2017 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version. A runtime exception applies to
14  * this software (see LICENSE.GPL_WRE file mentioned below for details).
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Library General Public License for more details.
20  *
21  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22  */
23 
24 #ifndef _LOGGING_NETWORK_H_
25 #define _LOGGING_NETWORK_H_
26 
27 #include <core/utils/lock_list.h>
28 #include <core/utils/lock_queue.h>
29 #include <logging/logger.h>
30 #include <netcomm/fawkes/handler.h>
31 #include <netcomm/fawkes/message_content.h>
32 
33 #include <stdint.h>
34 
35 namespace fawkes {
36 
37 class Mutex;
38 class FawkesNetworkHub;
39 
40 class NetworkLogger : public Logger, public FawkesNetworkHandler
41 {
42 public:
43  NetworkLogger(FawkesNetworkHub *hub, LogLevel log_level = LL_DEBUG);
44  virtual ~NetworkLogger();
45 
46  virtual void log_debug(const char *component, const char *format, ...);
47  virtual void log_info(const char *component, const char *format, ...);
48  virtual void log_warn(const char *component, const char *format, ...);
49  virtual void log_error(const char *component, const char *format, ...);
50 
51  virtual void log_debug(const char *component, Exception &e);
52  virtual void log_info(const char *component, Exception &e);
53  virtual void log_warn(const char *component, Exception &e);
54  virtual void log_error(const char *component, Exception &e);
55 
56  virtual void vlog_debug(const char *component, const char *format, va_list va);
57  virtual void vlog_info(const char *component, const char *format, va_list va);
58  virtual void vlog_warn(const char *component, const char *format, va_list va);
59  virtual void vlog_error(const char *component, const char *format, va_list va);
60 
61  virtual void tlog_debug(struct timeval *t, const char *component, const char *format, ...);
62  virtual void tlog_info(struct timeval *t, const char *component, const char *format, ...);
63  virtual void tlog_warn(struct timeval *t, const char *component, const char *format, ...);
64  virtual void tlog_error(struct timeval *t, const char *component, const char *format, ...);
65 
66  virtual void tlog_debug(struct timeval *t, const char *component, Exception &e);
67  virtual void tlog_info(struct timeval *t, const char *component, Exception &e);
68  virtual void tlog_warn(struct timeval *t, const char *component, Exception &e);
69  virtual void tlog_error(struct timeval *t, const char *component, Exception &e);
70 
71  virtual void
72  vtlog_debug(struct timeval *t, const char *component, const char *format, va_list va);
73  virtual void vtlog_info(struct timeval *t, const char *component, const char *format, va_list va);
74  virtual void vtlog_warn(struct timeval *t, const char *component, const char *format, va_list va);
75  virtual void
76  vtlog_error(struct timeval *t, const char *component, const char *format, va_list va);
77 
79  virtual void client_connected(unsigned int clid);
80  virtual void client_disconnected(unsigned int clid);
81 
82  /** NetworkLogger message types. */
83  typedef enum {
84  MSGTYPE_SUBSCRIBE = 1, /**< Subscribe for logging messages. */
85  MSGTYPE_UNSUBSCRIBE = 2, /**< Unsubscribe from receiving logging messages. */
86  MSGTYPE_LOGMESSAGE = 3 /**< Log message. */
88 
89 #pragma pack(push, 4)
90  /** Network logging message header. */
91  typedef struct
92  {
93  uint32_t log_level : 4; /**< LogLevel, @see Logger::LogLevel */
94  uint32_t exception : 1; /**< 1 if message was generated by exception, 0 otherwise */
95  uint32_t reserved : 27; /**< reserved for future use */
96  uint64_t time_sec; /**< time in seconds since the epoch, encoded in network byte order */
97  uint32_t time_usec; /**< addition to time in usec, encoded in network byte order */
99 #pragma pack(pop)
100 
101 private:
102  void send_message(Logger::LogLevel level,
103  struct timeval * t,
104  const char * component,
105  bool is_exception,
106  const char * format,
107  va_list va);
108  void send_message(Logger::LogLevel level,
109  struct timeval * t,
110  const char * component,
111  bool is_exception,
112  const char * message);
113 
114  FawkesNetworkHub *hub;
115 
116  LockQueue<FawkesNetworkMessage *> inbound_queue;
117 
118  LockList<unsigned int> subscribers_;
120 };
121 
123 {
124 public:
126  struct timeval * t,
127  const char * component,
128  bool is_exception,
129  const char * message);
131  struct timeval * t,
132  const char * component,
133  bool is_exception,
134  const char * format,
135  va_list va);
137  NetworkLoggerMessageContent(unsigned int component_id,
138  unsigned int msg_id,
139  void * payload,
140  size_t payload_size);
142 
143  struct timeval get_time() const;
145  const char * get_component() const;
146  const char * get_message() const;
147  bool is_exception() const;
148 
149  virtual void serialize();
150 
151 private:
153  const char * component_;
154  const char * message_;
155  bool own_payload_;
156 };
157 
158 } // end namespace fawkes
159 
160 #endif
fawkes::NetworkLoggerMessageContent
Definition: network_logger.h:126
fawkes::NetworkLogger::network_logger_header_t
Network logging message header.
Definition: network_logger.h:95
fawkes::Logger::log_level
LogLevel log_level
Minimum log level.
Definition: logger.h:125
fawkes::NetworkLogger::vlog_error
virtual void vlog_error(const char *component, const char *format, va_list va)
Definition: network_logger.cpp:161
fawkes::NetworkLogger::~NetworkLogger
virtual ~NetworkLogger()
Destructor.
Definition: network_logger.cpp:68
fawkes::LockList< unsigned int >
fawkes::FawkesNetworkMessageContent::payload
virtual void * payload()
Return pointer to payload.
Definition: message_content.cpp:74
fawkes::NetworkLogger::log_warn
virtual void log_warn(const char *component, const char *format,...)
Definition: network_logger.cpp:189
fawkes::NetworkLoggerMessageContent::get_time
struct timeval get_time() const
Get time.
Definition: network_logger.cpp:527
fawkes::NetworkLogger::vlog_warn
virtual void vlog_warn(const char *component, const char *format, va_list va)
Definition: network_logger.cpp:151
fawkes::NetworkLogger::tlog_debug
virtual void tlog_debug(struct timeval *t, const char *component, const char *format,...)
Definition: network_logger.cpp:295
fawkes::NetworkLogger::handle_network_message
virtual void handle_network_message(FawkesNetworkMessage *msg)
Definition: network_logger.cpp:379
fawkes::NetworkLogger::tlog_error
virtual void tlog_error(struct timeval *t, const char *component, const char *format,...)
Definition: network_logger.cpp:322
fawkes::NetworkLogger::MSGTYPE_SUBSCRIBE
Subscribe for logging messages.
Definition: network_logger.h:88
fawkes::NetworkLogger::log_info
virtual void log_info(const char *component, const char *format,...)
Definition: network_logger.cpp:180
fawkes::Logger::LL_DEBUG
debug output, relevant only when tracking down problems
Definition: logger.h:51
fawkes::NetworkLogger::vtlog_error
virtual void vtlog_error(struct timeval *t, const char *component, const char *format, va_list va)
Definition: network_logger.cpp:285
fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent
NetworkLoggerMessageContent(Logger::LogLevel log_level, struct timeval *t, const char *component, bool is_exception, const char *message)
Constructor.
Definition: network_logger.cpp:452
fawkes::NetworkLogger::network_logger_msgtype_t
network_logger_msgtype_t
NetworkLogger message types.
Definition: network_logger.h:87
fawkes::NetworkLogger::MSGTYPE_UNSUBSCRIBE
Unsubscribe from receiving logging messages.
Definition: network_logger.h:89
fawkes::NetworkLogger::NetworkLogger
NetworkLogger(FawkesNetworkHub *hub, LogLevel log_level=LL_DEBUG)
Constructor.
Definition: network_logger.cpp:59
fawkes::NetworkLoggerMessageContent::serialize
virtual void serialize()
Definition: network_logger.cpp:44
fawkes::NetworkLogger::log_debug
virtual void log_debug(const char *component, const char *format,...)
Definition: network_logger.cpp:171
fawkes::NetworkLoggerMessageContent::is_exception
bool is_exception() const
Check if message was generated by exception.
Definition: network_logger.cpp:566
fawkes::NetworkLogger::tlog_warn
virtual void tlog_warn(struct timeval *t, const char *component, const char *format,...)
Definition: network_logger.cpp:313
fawkes::NetworkLoggerMessageContent::get_loglevel
Logger::LogLevel get_loglevel() const
Log level.
Definition: network_logger.cpp:557
fawkes
fawkes::NetworkLogger::vtlog_warn
virtual void vtlog_warn(struct timeval *t, const char *component, const char *format, va_list va)
Definition: network_logger.cpp:275
fawkes::NetworkLogger::vtlog_debug
virtual void vtlog_debug(struct timeval *t, const char *component, const char *format, va_list va)
Definition: network_logger.cpp:255
fawkes::NetworkLogger::MSGTYPE_LOGMESSAGE
Log message.
Definition: network_logger.h:90
fawkes::NetworkLogger::tlog_info
virtual void tlog_info(struct timeval *t, const char *component, const char *format,...)
Definition: network_logger.cpp:304
fawkes::NetworkLogger::vlog_debug
virtual void vlog_debug(const char *component, const char *format, va_list va)
Definition: network_logger.cpp:131
fawkes::NetworkLogger::vlog_info
virtual void vlog_info(const char *component, const char *format, va_list va)
Definition: network_logger.cpp:141
fawkes::NetworkLogger::client_connected
virtual void client_connected(unsigned int clid)
Definition: network_logger.cpp:391
fawkes::LockQueue< FawkesNetworkMessage * >
fawkes::Logger::LogLevel
LogLevel
Log level.
Definition: logger.h:50
fawkes::NetworkLogger::vtlog_info
virtual void vtlog_info(struct timeval *t, const char *component, const char *format, va_list va)
Definition: network_logger.cpp:265
fawkes::NetworkLogger::client_disconnected
virtual void client_disconnected(unsigned int clid)
Definition: network_logger.cpp:396
fawkes::FawkesNetworkMessage
Definition: message.h:80
fawkes::NetworkLoggerMessageContent::~NetworkLoggerMessageContent
virtual ~NetworkLoggerMessageContent()
Destructor.
Definition: network_logger.cpp:517
fawkes::FawkesNetworkMessageContent::payload_size
virtual size_t payload_size()
Return payload size.
Definition: message_content.cpp:88
fawkes::FawkesNetworkHub
Definition: hub.h:37
fawkes::NetworkLoggerMessageContent::get_component
const char * get_component() const
Get component.
Definition: network_logger.cpp:539
fawkes::NetworkLogger::log_error
virtual void log_error(const char *component, const char *format,...)
Definition: network_logger.cpp:198
fawkes::NetworkLoggerMessageContent::get_message
const char * get_message() const
Get message.
Definition: network_logger.cpp:548
fawkes::FawkesNetworkMessageContent
Definition: message_content.h:37
fawkes::Exception
Definition: exception.h:39