Logging subsystem. More...

#include <Urho3D/IO/Log.h>

Inheritance diagram for Urho3D::Log:
Collaboration diagram for Urho3D::Log:

Public Member Functions

 Log (Context *context)
virtual ~Log ()
 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)
 Set logging level.
void SetTimeStamp (bool enable)
 Set whether to timestamp log messages.
void 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.
int GetLevel () const
 Return logging level.
bool GetTimeStamp () const
 Return whether log messages are timestamped.
String GetLastMessage () const
 Return last log message.
bool IsQuiet () const
 Return whether log is in quiet mode (only errors printed to standard error stream).
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
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.
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 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. More...
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
ContextGetContext () const
 Return execution context.
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
const VariantMapGetGlobalVars () const
 Return all global variables.
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and 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
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
- 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.
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
 Return reference count.
int WeakRefs () const
 Return weak reference count.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.

Static Public Member Functions

static void Write (int level, const String &message)
 Write to the log. If logging level is higher than the level of the message, the message is ignored.
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.
static bool IsTypeOf (StringHash type)
 Check current type is type of specified type.
static bool IsTypeOf (const TypeInfo *typeInfo)
 Check current type is type of specified type.
template<typename T >
static bool IsTypeOf ()
 Check current type is type of specified class.

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
 Execution context.

Detailed Description

Logging subsystem.

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