Urho3D::Log Class Reference

Logging subsystem. More...

#include <Urho3D/IO/Log.h>

Inheritance diagram for Urho3D::Log:

Public Member Functions
	Log (Context *context)
	Construct.
	~Log () override
	Destruct. Close the log file if open.
void	Open (const ea::string &fileName)
	Open the log file.
void	Close ()
	Close the log file.
void	SetLevel (LogLevel level)
void	SetLogFormat (const ea::string &format)
void	SetQuiet (bool quiet)
LogLevel	GetLevel () const
bool	IsQuiet () const
void	PumpThreadMessages ()
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static Logger	GetLogger (const ea::string &name)
	Returns a logger with specified name.
static Logger	GetLogger ()
	Returns default logger.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (Log, Object)
void	SendMessageEvent (LogLevel level, time_t timestamp, const ea::string &logger, const ea::string &message)
void	HandleEndFrame (StringHash eventType, VariantMap &eventData)
	Handle end of frame. Process the threaded log messages.
Logger	GetOrCreateLogger (const ea::string &name)
	Return new or existing logger for this Log instance.

Private Attributes
SharedPtr< LogImpl >	impl_
	Implementation hiding spdlog class types from public headers.
ea::string	formatPattern_ {}
	Log format pattern.
Mutex	logMutex_ {}
	Mutex for threaded operation.
ea::list< StoredLogMessage >	threadMessages_ {}
	Log messages from other threads.
LogLevel	level_ = LOG_INFO
	Logging level.
bool	inWrite_ = false
	In write flag to prevent recursion.
bool	quiet_ = false
	Quiet mode flag.
Logger	defaultLogger_
	Default logger used to log messages from Urho3D library.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Logging subsystem.

Member Function Documentation

GetLevel()

LogLevel Urho3D::Log::GetLevel ( ) const

inline

Return logging level.

IsQuiet()

bool Urho3D::Log::IsQuiet ( ) const

inline

Return whether log is in quiet mode (only errors printed to standard error stream).

SetLevel()

void Urho3D::Log::SetLevel

(

LogLevel

level

)

Set logging level.

SetLogFormat()

void Urho3D::Log::SetLogFormat

(

const ea::string &

format

)

Set whether to timestamp log messages.

SetQuiet()

void Urho3D::Log::SetQuiet

(

bool

quiet

)

Set quiet mode ie. only print error entries to standard error stream (which is normally redirected to console also). Output to log file is not affected by this mode.

---

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

• Urho3D/IO/Log.h
• Urho3D/IO/Log.cpp