Search Toolkit Book for IMessageListener
#include <corelib/ncbi_message.hpp>
Inheritance diagram for IMessageListener:
Collaboration diagram for IMessageListener:
Public Types | |
| enum | EPostResult { eHandled , eUnhandled } |
| Result of PostXXXX() operation. More... | |
| enum | EListenFlag { eListen_Unhandled , eListen_All } |
| Which messages should be passed to the listener. More... | |
| Public Types inherited from CObject | |
| enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
| Control filling of newly allocated memory. More... | |
| typedef CObjectCounterLocker | TLockerType |
| Default locker type for CRef. More... | |
| typedef atomic< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
Public Member Functions | |
| virtual | ~IMessageListener (void) |
| virtual EPostResult | PostMessage (const IMessage &message)=0 |
| Post new message to the listener. More... | |
| virtual EPostResult | PostProgress (const IProgressMessage &progress)=0 |
| Report progress. More... | |
| virtual const IMessage & | GetMessage (size_t index) const =0 |
| Get a previously collected message. More... | |
| virtual size_t | Count (void) const =0 |
| Get total number of collected messages. More... | |
| virtual void | Clear (void)=0 |
| Clear all collected messages. More... | |
| ~IMessageListener () override | |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (const CObject &src) THROWS_NONE |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const THROWS_NONE |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const THROWS_NONE |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const THROWS_NONE |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const THROWS_NONE |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const |
| Remove reference to object. More... | |
| void | ReleaseReference (void) const |
| Remove reference without deleting object. More... | |
| virtual void | DoNotDeleteThisObject (void) |
| Mark this object as not allocated in heap – do not delete this object. More... | |
| virtual void | DoDeleteThisObject (void) |
| Mark this object as allocated in heap – object can be deleted. More... | |
| void * | operator new (size_t size) |
| Define new operator for memory allocation. More... | |
| void * | operator new[] (size_t size) |
| Define new[] operator for 'array' memory allocation. More... | |
| void | operator delete (void *ptr) |
| Define delete operator for memory deallocation. More... | |
| void | operator delete[] (void *ptr) |
| Define delete[] operator for memory deallocation. More... | |
| void * | operator new (size_t size, void *place) |
| Define new operator. More... | |
| void | operator delete (void *ptr, void *place) |
| Define delete operator. More... | |
| void * | operator new (size_t size, CObjectMemoryPool *place) |
| Define new operator using memory pool. More... | |
| void | operator delete (void *ptr, CObjectMemoryPool *place) |
| Define delete operator. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| Public Member Functions inherited from CDebugDumpable | |
| CDebugDumpable (void) | |
| virtual | ~CDebugDumpable (void) |
| void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
| void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
| void | DumpToConsole (void) const |
| Public Member Functions inherited from ILineErrorListener | |
| ~ILineErrorListener () override | |
| virtual bool | PutError (const ILineError &)=0 |
| Store error in the container, and return true if error was stored fine, and return false if the caller should terminate all further processing. More... | |
| bool | PutMessage (const IObjtoolsMessage &message) override |
| virtual const ILineError & | Get (size_t index) const |
| virtual const ILineError & | GetError (size_t) const =0 |
| 0-based error retrieval. More... | |
| virtual size_t | LevelCount (EDiagSev)=0 |
| Returns the number of errors seen so far at the given severity. More... | |
| virtual void | ClearAll ()=0 |
| Clear all accumulated messages. More... | |
| virtual void | Progress (const string &message, Uint8 current, Uint8 total) |
| virtual void | PutProgress (const string &sMessage, const Uint8 iNumDone=0, const Uint8 iNumTotal=0)=0 |
| This is used for processing progress messages. More... | |
| Public Member Functions inherited from IObjtoolsListener | |
| virtual | ~IObjtoolsListener (void)=default |
| virtual bool | SevEnabled (EDiagSev severity) const |
Static Public Member Functions | |
| static size_t | PushListener (IMessageListener &listener, EListenFlag flag=eListen_Unhandled) |
| Push a new listener to the stack in the current thread. More... | |
| static void | PopListener (size_t depth=0) |
| Remove listener(s) from the current thread's stack. More... | |
| static bool | HaveListeners (void) |
| Check if there are any listeners installed in the current thread. More... | |
| static EPostResult | Post (const IMessage &message) |
| Post the message to listener(s), if any. More... | |
| static EPostResult | Post (const IProgressMessage &progress) |
| Post the progress to listener(s), if any. More... | |
| Static Public Member Functions inherited from CObject | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
| Define method to throw null pointer exception. More... | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
| static EAllocFillMode | GetAllocFillMode (void) |
| static void | SetAllocFillMode (EAllocFillMode mode) |
| static void | SetAllocFillMode (const string &value) |
| Set mode from configuration parameter value. More... | |
| Static Public Member Functions inherited from CDebugDumpable | |
| static void | EnableDebugDump (bool on) |
Additional Inherited Members | |
| Static Public Attributes inherited from CObject | |
| static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
| Define possible object states. More... | |
| static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
| Heap signature was found. More... | |
| static const TCount | eCounterBitsPlaceMask |
| Mask for 'in heap' state flags. More... | |
| static const int | eCounterStep = 1 << 2 |
| Skip over the "in heap" bits. More... | |
| static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
| Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
| static const TCount | eCounterStateMask |
| Valid object, and object in heap. More... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Detailed Description
Interface for IMessage listener/collector.
Definition at line 190 of file ncbi_message.hpp.
Constructor & Destructor Documentation
◆ ~IMessageListener()
|
inlineoverride |
Definition at line 111 of file message_listener.hpp.
The documentation for this class was generated from the following files:
- include/corelib/ncbi_message.hpp
- include/objtools/readers/message_listener.hpp
- src/corelib/ncbi_message.cpp
