Logging subsystem. More...

#include <Urho3D/IO/Log.h>

Inheritance diagram for Urho3D::Log:
[legend]
Collaboration diagram for Urho3D::Log:
[legend]

Public Member Functions

 Log (Context *context)
 Construct.
 
 ~Log () override
 Destruct. Close the log file if open.
 
void Open (const String &fileName)
 Open the log file.
 
void Close ()
 Close the log file.
 
void SetLevel (int level)
 
void SetTimeStamp (bool enable)
 
void SetQuiet (bool quiet)
 
int GetLevel () const
 
bool GetTimeStamp () const
 
String GetLastMessage () const
 
bool IsQuiet () const
 
- 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 StringGetTypeName () const =0
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
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 SubscribeToEvent (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
void SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 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 PODVector< StringHash > &exceptions, bool onlyUserData)
 Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMapGetEventDataMap () 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, Args... args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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 StringGetCategory () const
 
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.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
 
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Static Public Member Functions

static void Write (int level, const String &message)
 
static void WriteRaw (const String &message, bool error=false)
 Write raw output to the log.
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Private Member Functions

 URHO3D_OBJECT (Log, Object)
 
void HandleEndFrame (StringHash eventType, VariantMap &eventData)
 Handle end of frame. Process the threaded log messages.
 

Private Attributes

Mutex logMutex_
 Mutex for threaded operation.
 
List< StoredLogMessagethreadMessages_
 Log messages from other threads.
 
SharedPtr< FilelogFile_
 Log file.
 
String lastMessage_
 Last log message.
 
int level_
 Logging level.
 
bool timeStamp_
 Timestamp log messages flag.
 
bool inWrite_
 In write flag to prevent recursion.
 
bool quiet_
 Quiet mode flag.
 

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.
 

Detailed Description

Logging subsystem.

Member Function Documentation

◆ GetLastMessage()

String Urho3D::Log::GetLastMessage ( ) const
inline

Return last log message.

◆ GetLevel()

int Urho3D::Log::GetLevel ( ) const
inline

Return logging level.

◆ GetTimeStamp()

bool Urho3D::Log::GetTimeStamp ( ) const
inline

Return whether log messages are timestamped.

◆ 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 ( int  level)

Set logging level.

◆ 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.

◆ SetTimeStamp()

void Urho3D::Log::SetTimeStamp ( bool  enable)

Set whether to timestamp log messages.

◆ Write()

void Urho3D::Log::Write ( int  level,
const String message 
)
static

Write to the log. If logging level is higher than the level of the message, the message is ignored.

Here is the call graph for this function:
Here is the caller graph for this function:

The documentation for this class was generated from the following files:
  • Source/Urho3D/IO/Log.h
  • Source/Urho3D/IO/Log.cpp