fc::log_message Class Reference

aggregates a message along with the context and associated meta-information. More...

#include <log_message.hpp>

Public Member Functions
	log_message ()
	log_message (log_context ctx, std::string format, variant_object args=variant_object())
	~log_message ()
	log_message (const variant &v)
variant	to_variant () const
string	get_message () const
string	get_limited_message () const
log_context	get_context () const
string	get_format () const
variant_object	get_data () const

Detailed Description

Note

log_message has reference semantics, all copies refer to the same log message and the message is read-only after construction.

When converted to JSON, log_message has the following form:

{
   "context" : { ... },
   "format"  : "string with ${keys}",
   "data"    : { "keys" : "values" }
}

See also

FC_LOG_MESSAGE

Definition at line 105 of file log_message.hpp.

Constructor & Destructor Documentation

log_message() [1/3]

fc::log_message::log_message

(

)

Definition at line 197 of file log_message.cpp.

   :my( std::make_shared<detail::log_message_impl>() ){}

log_message() [2/3]

fc::log_message::log_message	(	log_context	ctx,
		std::string	format,
		variant_object	args = variant_object() )

Parameters

ctx	- generally provided using the FC_LOG_CONTEXT(LEVEL) macro

Definition at line 200 of file log_message.cpp.

   :my( std::make_shared<detail::log_message_impl>(std::move(ctx)) )
   {
      my->format  = std::move(format);
      my->args    = std::move(args);
   }

~log_message()

fc::log_message::~log_message

(

)

Definition at line 196 of file log_message.cpp.

{}

log_message() [3/3]

fc::log_message::log_message

(

const variant &

v

)

Definition at line 207 of file log_message.cpp.

   :my( std::make_shared<detail::log_message_impl>( log_context( v.get_object()["context"] ) ) )
   {
      my->format = v.get_object()["format"].as_string();
      my->args   = v.get_object()["data"].get_object();
   }

Here is the call graph for this function:

Member Function Documentation

get_context()

log_context fc::log_message::get_context

(

)

const

Definition at line 221 of file log_message.cpp.

{ return my->context; }

Here is the caller graph for this function:

get_data()

variant_object fc::log_message::get_data

(

)

const

Definition at line 223 of file log_message.cpp.

{ return my->args;    }

Here is the caller graph for this function:

get_format()

string fc::log_message::get_format

(

)

const

Definition at line 222 of file log_message.cpp.

{ return my->format;  }

Here is the caller graph for this function:

get_limited_message()

string fc::log_message::get_limited_message

(

)

const

A faster version of get_message which does limited formatting and excludes large variants

Returns

formatted message according to format and variant args

Definition at line 230 of file log_message.cpp.

   {
      const bool minimize = true;
      return format_string( my->format, my->args, minimize );
   }

Here is the call graph for this function:

get_message()

string fc::log_message::get_message

(

)

const

Definition at line 225 of file log_message.cpp.

   {
      return format_string( my->format, my->args );
   }

Here is the call graph for this function:

to_variant()

variant fc::log_message::to_variant

(

)

const

Definition at line 214 of file log_message.cpp.

   {
      return mutable_variant_object( "context", my->context )
                          ( "format",  my->format )
                          ( "data",    my->args   );
   }

Here is the caller graph for this function:

---

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

• libraries/fc/include/fc/log/log_message.hpp
• libraries/fc/src/log/log_message.cpp