offapi/com/sun/star/logging/XLogHandler.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_logging_XLogHandler_idl__
  21 #define __com_sun_star_logging_XLogHandler_idl__
  22
  23 #include <com/sun/star/lang/XComponent.idl>
  24 #include <com/sun/star/logging/LogRecord.idl>
  25 #include <com/sun/star/logging/XLogFormatter.idl>
  26
  27
  28 module com { module sun { module star { module logging {
  29
  30
  31 /** provides possibilities to send LogRecords to an arbitrary output
  32     channel.
  33
  34     @see XLogger
  35
  36     @since OOo 2.3
  37  */
  38 interface XLogHandler
  39 {
  40     /** allows life time control for the handler
  41
  42         <p>Disposing the handler effectively means closing the channel
  43         to which the handler forwards the log records.
  44     */
  45     interface ::com::sun::star::lang::XComponent;
  46
  47     /** specifies MIME charset name for the encoding to be used by this handler
  48
  49         <p>It depends on the concrete handler implementation whether or not this
  50         parameter is needed.<p>
  51
  52         @see http://www.iana.org/assignments/character-sets
  53     */
  54     [attribute] string Encoding;
  55
  56     /** specifies the formatter to be used by this handler.
  57     */
  58     [attribute] XLogFormatter   Formatter;
  59
  60     /** specifies the log level of this handler
  61
  62         <p>Different handlers can have different log levels, which again might be
  63         different from the log level of the XLogger for which the handlers
  64         are used.</p>
  65     */
  66     [attribute] long    Level;
  67
  68     /** flushes all buffered output of the handler
  69
  70         <p>Log handlers are allowed to buffer their output. Upon <code>flush</code>
  71         being called, they must flush all their buffers.</p>
  72     */
  73     void    flush();
  74
  75     /** publish the given log record at the handler's output channel.
  76
  77         @return
  78             `TRUE` if and only if the record was actually published. A handler
  79             will not publish a record if its log level doesn't meet the handler's
  80             log level, if the record is filtered, or if any other handler-specified
  81             restrictions apply.
  82     */
  83     boolean publish( [in] LogRecord Record );
  84 };
  85
  86
  87 }; }; }; };
  88
  89
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */