log.h File Reference

Debug message logging. More...

#include "log-macros-disabled.h"
#include "log-macros-enabled.h"
#include "node-printer.h"
#include "time-printer.h"
#include <iostream>
#include <stdint.h>
#include <string>
#include <type_traits>
#include <unordered_map>
#include <vector>

Include dependency graph for log.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	ns3::LogComponent
	A single log component configuration. More...
class	ns3::ParameterLogger
	Insert , when streaming function arguments. More...

Namespaces
namespace	ns3
	Every class exported by the ns3 library is enclosed in the ns3 namespace.

Macros
#define	NS_LOG_COMPONENT_DEFINE(name)    static ns3::LogComponent g_log = ns3::LogComponent(name, __FILE__)
	Define a Log component with a specific name.
#define	NS_LOG_COMPONENT_DEFINE_MASK(name, mask)    static ns3::LogComponent g_log = ns3::LogComponent(name, __FILE__, mask)
	Define a logging component with a mask.
#define	NS_LOG_DEBUG(msg)   NS_LOG(ns3::LOG_DEBUG, msg)
	Use NS_LOG to output a message of level LOG_DEBUG.
#define	NS_LOG_ERROR(msg)   NS_LOG(ns3::LOG_ERROR, msg)
	Use NS_LOG to output a message of level LOG_ERROR.
#define	NS_LOG_INFO(msg)   NS_LOG(ns3::LOG_INFO, msg)
	Use NS_LOG to output a message of level LOG_INFO.
#define	NS_LOG_LOGIC(msg)   NS_LOG(ns3::LOG_LOGIC, msg)
	Use NS_LOG to output a message of level LOG_LOGIC.
#define	NS_LOG_STATIC_TEMPLATE_DEFINE(name)    static LogComponent& g_log [[maybe_unused]] = GetLogComponent(name)
	Declare and initialize a reference to a Log component.
#define	NS_LOG_TEMPLATE_DECLARE   LogComponent& g_log
	Declare a reference to a Log component.
#define	NS_LOG_TEMPLATE_DEFINE(name)   g_log(GetLogComponent(name))
	Initialize a reference to a Log component.
#define	NS_LOG_WARN(msg)   NS_LOG(ns3::LOG_WARN, msg)
	Use NS_LOG to output a message of level LOG_WARN.

Enumerations
enum	ns3::LogLevel {   ns3::LOG_NONE = 0x00000000 , ns3::LOG_ERROR = 0x00000001 , ns3::LOG_LEVEL_ERROR = 0x00000001 , ns3::LOG_WARN = 0x00000002 ,   ns3::LOG_LEVEL_WARN = 0x00000003 , ns3::LOG_INFO = 0x00000004 , ns3::LOG_LEVEL_INFO = 0x00000007 , ns3::LOG_FUNCTION = 0x00000008 ,   ns3::LOG_LEVEL_FUNCTION = 0x0000000f , ns3::LOG_LOGIC = 0x00000010 , ns3::LOG_LEVEL_LOGIC = 0x0000001f , ns3::LOG_DEBUG = 0x00000020 ,   ns3::LOG_LEVEL_DEBUG = 0x0000003f , ns3::LOG_ALL = 0x0fffffff , ns3::LOG_LEVEL_ALL = LOG_ALL , ns3::LOG_PREFIX_FUNC = 0x80000000 ,   ns3::LOG_PREFIX_TIME = 0x40000000 , ns3::LOG_PREFIX_NODE = 0x20000000 , ns3::LOG_PREFIX_LEVEL = 0x10000000 , ns3::LOG_PREFIX_ALL = 0xf0000000 }
	Logging severity classes and levels. More...

Functions
LogComponent &	ns3::GetLogComponent (const std::string name)
	Get the LogComponent registered with the given name.
void	ns3::LogComponentDisable (const std::string &name, LogLevel level)
	Disable the logging output associated with that log component.
void	ns3::LogComponentDisableAll (LogLevel level)
	Disable all logging for all components.
void	ns3::LogComponentEnable (const std::string &name, LogLevel level)
	Enable the logging output associated with that log component.
void	ns3::LogComponentEnableAll (LogLevel level)
	Enable the logging output for all registered log components.
void	ns3::LogComponentPrintList ()
	Print the list of logging messages available.
NodePrinter	ns3::LogGetNodePrinter ()
	Get the LogNodePrinter function currently in use.
TimePrinter	ns3::LogGetTimePrinter ()
	Get the LogTimePrinter function currently in use.
void	ns3::LogSetNodePrinter (NodePrinter np)
	Set the LogNodePrinter function to be used to prepend log messages with the node id.
void	ns3::LogSetTimePrinter (TimePrinter lp)
	Set the TimePrinter function to be used to prepend log messages with the simulation time.
template<>
ParameterLogger &	ns3::ParameterLogger::operator<<< std::string > (const std::string &param)
	Specialization for strings.

Detailed Description

Debug message logging.

Definition in file log.h.