logog
logger optimized for games
Message Class Reference

#include <message.hpp>

+ Inheritance diagram for Message:

Public Member Functions

 Message (const LOGOG_LEVEL_TYPE level=LOGOG_LEVEL_ALL, const LOGOG_CHAR *sFileName=NULL, const int nLineNumber=0, const LOGOG_CHAR *sGroup=NULL, const LOGOG_CHAR *sCategory=NULL, const LOGOG_CHAR *sMessage=NULL, const double dTimestamp=0.0f, bool *bIsCreated=NULL)
 
virtual ~Message ()
 
virtual bool Republish ()
 
- Public Member Functions inherited from Checkpoint
 Checkpoint (const LOGOG_LEVEL_TYPE level=LOGOG_LEVEL_ALL, const LOGOG_CHAR *sFileName=NULL, const int nLineNumber=0, const LOGOG_CHAR *sGroup=NULL, const LOGOG_CHAR *sCategory=NULL, const LOGOG_CHAR *sMessage=NULL, const double dTimestamp=0.0f)
 
virtual int Send (const Topic &node)
 
- Public Member Functions inherited from TopicSource
 TopicSource (const LOGOG_LEVEL_TYPE level=LOGOG_LEVEL_ALL, const LOGOG_CHAR *sFileName=NULL, const int nLineNumber=0, const LOGOG_CHAR *sGroup=NULL, const LOGOG_CHAR *sCategory=NULL, const LOGOG_CHAR *sMessage=NULL, const double dTimestamp=0.0f)
 
virtual bool SubscribeTo (Node &)
 
virtual bool UnsubscribeTo (Node &)
 
virtual bool CanSubscribe () const
 
- Public Member Functions inherited from Topic
 Topic (const LOGOG_LEVEL_TYPE level=LOGOG_LEVEL_ALL, const LOGOG_CHAR *sFileName=NULL, const int nLineNumber=0, const LOGOG_CHAR *sGroup=NULL, const LOGOG_CHAR *sCategory=NULL, const LOGOG_CHAR *sMessage=NULL, const double dTimestamp=0.0f)
 
virtual bool IsTopic () const
 
virtual int Transmit ()
 
virtual int Receive (const Topic &node)
 
virtual bool CanSubscribeTo (const Node &otherNode)
 
virtual bool CanSubscribeCheckTopic (const Topic &other)
 
virtual bool PublishTo (Node &subscriber)
 
virtual void Format (const LOGOG_CHAR *cFormatMessage,...)
 
const LOGOG_STRINGFileName () const
 
void FileName (const LOGOG_STRING &s)
 
const LOGOG_STRINGMessage () const
 
void Message (const LOGOG_STRING &s)
 
const LOGOG_STRINGCategory () const
 
void Category (const LOGOG_STRING &s)
 
const LOGOG_STRINGGroup () const
 
void Group (const LOGOG_STRING &s)
 
int LineNumber () const
 
void LineNumber (const int num)
 
LOGOG_LEVEL_TYPE Level () const
 
void Level (LOGOG_LEVEL_TYPE level)
 
LOGOG_TIME Timestamp () const
 
void Timestamp (const LOGOG_TIME t)
 
TOPIC_FLAGS GetTopicFlags () const
 
- Public Member Functions inherited from Node
 Node ()
 
 ~Node ()
 
virtual void Initialize ()
 
virtual bool CanPublish () const
 
virtual bool PublishToMultiple (LockableNodesType &nodes)
 
virtual bool UnpublishTo (Node &subscriber)
 
virtual bool UnpublishToMultiple (LockableNodesType &nodes)
 
virtual bool SubscribeToMultiple (LockableNodesType &nodes)
 
virtual bool UnsubscribeToMultiple (LockableNodesType &nodes)
 
void Clear ()
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
void * operator new (size_t nSize)
 
void * operator new[] (size_t nSize)
 
void operator delete (void *ptr)
 
void operator delete[] (void *ptr)
 

Public Attributes

Mutex m_Transmitting
 
bool * m_pbIsCreated
 
- Public Attributes inherited from Node
void * m_pUserData1
 
void * m_pUserData2
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static void * Allocate (size_t nSize)
 
static void Deallocate (void *ptr)
 
- Protected Attributes inherited from Topic
LOGOG_STRING m_vStringProps [TOPIC_STRING_COUNT]
 
int m_vIntProps [TOPIC_INT_COUNT]
 
LOGOG_TIME m_tTime
 
TOPIC_FLAGS m_TopicFlags
 
- Protected Attributes inherited from Node
LockableNodesType m_Subscribers
 
LockableNodesType m_Publishers
 

Detailed Description

A message is a piece of text that's actually transmitted to outputs. Messages can be asked to Transmit() themselves once they are created.

Constructor & Destructor Documentation

Message ( const LOGOG_LEVEL_TYPE  level = LOGOG_LEVEL_ALL,
const LOGOG_CHAR sFileName = NULL,
const int  nLineNumber = 0,
const LOGOG_CHAR sGroup = NULL,
const LOGOG_CHAR sCategory = NULL,
const LOGOG_CHAR sMessage = NULL,
const double  dTimestamp = 0.0f,
bool *  bIsCreated = NULL 
)
virtual ~Message ( )
virtual

Member Function Documentation

virtual bool Republish ( )
virtual

Causes this checkpoint to republish itself to all existing filters after unpublishing itself. This can be necessary if the message within this message has changed in such a way that the downstream Filter objects might react differently to it.

Member Data Documentation

bool* m_pbIsCreated
Mutex m_Transmitting

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