mxmStatusMessageHandlerInterface Class Reference
[modularMX Runtime Platform Core]

Interface to handlers for the central status message facility. More...

#include <mxmStatusMessageHandlerInterface.h>

Inheritance diagram for mxmStatusMessageHandlerInterface:

mxmInterface mx::FrameworkMessageHandler mxmNopStatusMessageHandler List of all members.

Public Member Functions

virtual void sendStatusMessage (mxm::StatusMessageType msg_type, const mxmString &msg, const mxmObject *sending_object=0)=0
 Processes the status message as it sees it fit.
virtual void setStatusMessageVerbosity (mxm::StatusMessageType msg_level)=0
 Used (e.g.
virtual mxm::StatusMessageType statusMessageVerbosity ()=0
 Returns the verbosity level currently supported/expected by the handler.

Detailed Description

Interface to handlers for the central status message facility.

An installed custom status message handler could for example output the messages to a nifty GUI widget.

Author:
[khe] Kai Hergenroether


Member Function Documentation

virtual void mxmStatusMessageHandlerInterface::sendStatusMessage mxm::StatusMessageType  msg_type,
const mxmString msg,
const mxmObject sending_object = 0
[pure virtual]
 

Processes the status message as it sees it fit.

Note that implementations for multithreaded environments need to be thread safe!

Implemented in mxmNopStatusMessageHandler, and mx::FrameworkMessageHandler.

virtual void mxmStatusMessageHandlerInterface::setStatusMessageVerbosity mxm::StatusMessageType  msg_level  )  [pure virtual]
 

Used (e.g.

by the central status message facility) to switch the handler to a given verbosity level - the handler is free to ignore the request, though.

Implemented in mxmNopStatusMessageHandler, and mx::FrameworkMessageHandler.

virtual mxm::StatusMessageType mxmStatusMessageHandlerInterface::statusMessageVerbosity  )  [pure virtual]
 

Returns the verbosity level currently supported/expected by the handler.

Through the return value the handler tells the calling context (the central status message facility, and thus application code) which status messages it is interested in. By returning sensible values it can help application code to reduce overhead by only composing status messages that are actually needed. Application code can use mxm::statusMessageUseful() to determine whether or not a message for a given level is currently useful.

Implemented in mxmNopStatusMessageHandler, and mx::FrameworkMessageHandler.


The documentation for this class was generated from the following file:
Generated on Fri Jun 29 17:21:05 2007 for MxPEG SDK by  doxygen 1.4.6