9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 #ifndef SHARE_VM_LOGGING_LOGOUTPUT_HPP
  25 #define SHARE_VM_LOGGING_LOGOUTPUT_HPP
  26 
  27 #include "logging/logDecorators.hpp"
  28 #include "logging/logLevel.hpp"

  29 #include "memory/allocation.hpp"
  30 #include "utilities/globalDefinitions.hpp"
  31 
  32 class LogDecorations;

  33 class LogTagSet;
  34 
  35 // The base class/interface for log outputs.
  36 // Keeps track of the latest configuration string,
  37 // and its selected decorators.
  38 class LogOutput : public CHeapObj<mtLogging> {
  39   // Make LogConfiguration a friend to allow it to modify the configuration string.
  40   friend class LogConfiguration;
  41 
  42  private:
  43   static const size_t InitialConfigBufferSize = 256;
  44   char* _config_string;
  45   size_t _config_string_buffer_size;
  46 
  47  protected:
  48   LogDecorators _decorators;
  49 
  50   // Clears any previous config description in preparation of reconfiguration.
  51   void clear_config_string();
  52   // Adds the tagset on the given level to the config description (e.g. "tag1+tag2=level").

  66     return _decorators;
  67   }
  68 
  69   const char* config_string() const {
  70     return _config_string;
  71   }
  72 
  73   LogOutput() : _config_string(NULL), _config_string_buffer_size(0) {
  74   }
  75 
  76   virtual ~LogOutput();
  77 
  78   // If the output can be rotated, trigger a forced rotation, otherwise do nothing.
  79   // Log outputs with rotation capabilities should override this.
  80   virtual void force_rotate() {
  81     // Do nothing by default.
  82   }
  83 
  84   virtual const char* name() const = 0;
  85   virtual bool initialize(const char* options) = 0;
  86   virtual int write(const LogDecorations &decorations, const char* msg) = 0;

  87 };
  88 
  89 #endif // SHARE_VM_LOGGING_LOGOUTPUT_HPP

   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 #ifndef SHARE_VM_LOGGING_LOGOUTPUT_HPP
  25 #define SHARE_VM_LOGGING_LOGOUTPUT_HPP
  26 
  27 #include "logging/logDecorators.hpp"
  28 #include "logging/logLevel.hpp"
  29 #include "logging/logMessageBuffer.hpp"
  30 #include "memory/allocation.hpp"
  31 #include "utilities/globalDefinitions.hpp"
  32 
  33 class LogDecorations;
  34 class LogMessageBuffer;
  35 class LogTagSet;
  36 
  37 // The base class/interface for log outputs.
  38 // Keeps track of the latest configuration string,
  39 // and its selected decorators.
  40 class LogOutput : public CHeapObj<mtLogging> {
  41   // Make LogConfiguration a friend to allow it to modify the configuration string.
  42   friend class LogConfiguration;
  43 
  44  private:
  45   static const size_t InitialConfigBufferSize = 256;
  46   char* _config_string;
  47   size_t _config_string_buffer_size;
  48 
  49  protected:
  50   LogDecorators _decorators;
  51 
  52   // Clears any previous config description in preparation of reconfiguration.
  53   void clear_config_string();
  54   // Adds the tagset on the given level to the config description (e.g. "tag1+tag2=level").

  68     return _decorators;
  69   }
  70 
  71   const char* config_string() const {
  72     return _config_string;
  73   }
  74 
  75   LogOutput() : _config_string(NULL), _config_string_buffer_size(0) {
  76   }
  77 
  78   virtual ~LogOutput();
  79 
  80   // If the output can be rotated, trigger a forced rotation, otherwise do nothing.
  81   // Log outputs with rotation capabilities should override this.
  82   virtual void force_rotate() {
  83     // Do nothing by default.
  84   }
  85 
  86   virtual const char* name() const = 0;
  87   virtual bool initialize(const char* options) = 0;
  88   virtual int write(const LogDecorations& decorations, const char* msg) = 0;
  89   virtual int write(LogMessageBuffer::Iterator msg_iterator) = 0;
  90 };
  91 
  92 #endif // SHARE_VM_LOGGING_LOGOUTPUT_HPP