Interface ILogQueue

All Known Implementing Classes:
LogQueue
public interface ILogQueue
An interface represents a log queue. A log queue is a queue of pending log events to be dispatched to a set of registered ILogEventListeners.
Version:
$Revision$, $Date$

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addLogEventListener(ILogEventListener listener)
    Registers an event listener.
    void
    flush()
    Flushes log queue, flushes all registered listeners.
    void
    init()
    Initializes the log queue.
    void
    log(ILogEvent evt)
    Dispatch the log event to all registered log event listeners.
    void
    removeLogEventListener(ILogEventListener listener)
    Removes an event listener.
    void
    shutdown()
    Stops this log queue:shuts down all registered log event listeners.

  • Method Details

    • log

      void log(ILogEvent evt)
      Dispatch the log event to all registered log event listeners.
      Parameters:
      evt - the log event

    • flush

      void flush()
      Flushes log queue, flushes all registered listeners. Messages should be written to their destination.

    • addLogEventListener

      void addLogEventListener(ILogEventListener listener)
      Registers an event listener.
      Parameters:
      listener - The log event listener to be registered to this queue.

    • removeLogEventListener

      void removeLogEventListener(ILogEventListener listener)
      Removes an event listener.
      Parameters:
      listener - The log event listener to be removed from this queue.

    • init

      void init()
      Initializes the log queue.

    • shutdown

      void shutdown()
      Stops this log queue:shuts down all registered log event listeners.