deviceappender.hxx
Go to the documentation of this file.
// Copyright (C) 2009-2017, Vaclav Haisman. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modifica-
// tion, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
// FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
// DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
// OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#ifndef LOG4CPLUS_BOOST_DEVICEAPPENDER_HXX
#define LOG4CPLUS_BOOST_DEVICEAPPENDER_HXX
#include <log4cplus/config.hxx>
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
#include <boost/utility/enable_if.hpp>
#include <boost/type_traits/is_same.hpp>
#include <boost/mpl/not.hpp>
#include <boost/iostreams/operations.hpp>
#include <boost/shared_ptr.hpp>
#include <log4cplus/appender.h>
namespace log4cplus
{
namespace device_appender_detail
{
template <typename T>
struct device_type_traits
{
typedef T & device_type;
static
device_type
unwrap (device_type x)
{
return x;
}
};
template <typename T>
struct device_type_traits<boost::shared_ptr<T> >
{
typedef boost::shared_ptr<T> device_type;
static
T &
unwrap (device_type const & ptr)
{
return *ptr;
}
};
} // namespace device_appender_detail
template <typename Device>
class DeviceAppender
: public Appender
{
public:
typedef device_appender_detail::device_type_traits<Device> device_traits;
typedef typename device_traits::device_type device_type;
template <typename D>
DeviceAppender (D & d, bool close_device = true)
: device (d)
, close_flag (close_device)
{ }
template <typename D>
DeviceAppender (boost::shared_ptr<D> const & d, bool close_device = true)
: device (d)
, close_flag (close_device)
{ }
template <typename D>
DeviceAppender (D & d, const helpers::Properties & props)
: Appender (props)
, device (d)
{
if (props.exists (LOG4CPLUS_TEXT ("CloseDevice")))
close_flag = true;
else
close_flag = false;
}
template <typename D>
DeviceAppender (boost::shared_ptr<D> const & d,
const helpers::Properties & props)
: Appender (props)
, device (d)
{
if (props.exists (LOG4CPLUS_TEXT ("CloseDevice")))
close_flag = true;
else
close_flag = false;
}
virtual
~DeviceAppender ()
{ }
virtual
void
close ()
{
if (close_flag)
boost::iostreams::close (device_traits::unwrap (device));
}
protected:
virtual
void
append (log4cplus::spi::InternalLoggingEvent const & event)
{
tstring & str = formatEvent (event);
boost::iostreams::write (device_traits::unwrap (device),
str.c_str (), str.size ());
}
device_type device;
bool close_flag;
private:
DeviceAppender (DeviceAppender const &);
DeviceAppender & operator = (DeviceAppender const &);
};
template <typename T>
inline
SharedAppenderPtr
make_device_appender (T & d, bool close_device = true)
{
SharedAppenderPtr app (new DeviceAppender<T> (d, close_device));
return app;
}
template <typename T>
inline
SharedAppenderPtr
make_device_appender (T & d, const helpers::Properties & props)
{
SharedAppenderPtr app (new DeviceAppender<T> (d, props));
return app;
}
template <typename T>
inline
SharedAppenderPtr
make_device_appender_sp (boost::shared_ptr<T> const & p,
bool close_device = true)
{
SharedAppenderPtr app (
new DeviceAppender<boost::shared_ptr<T> > (p, close_device));
return app;
}
template <typename T>
inline
SharedAppenderPtr
make_device_appender_sp (boost::shared_ptr<T> const & p,
const helpers::Properties & props)
{
SharedAppenderPtr app (
new DeviceAppender<boost::shared_ptr<T> > (p, props));
return app;
}
} // namespace log4cplus
#endif // LOG4CPLUS_BOOST_DEVICEAPPENDER_HXX
appender.h
log4cplus::Appender::formatEvent
tstring & formatEvent(const log4cplus::spi::InternalLoggingEvent &event) const
log4cplus::Appender::Appender
Appender()
log4cplus::DeviceAppender
Definition deviceappender.hxx:83
log4cplus::DeviceAppender::device
device_type device
Definition deviceappender.hxx:145
log4cplus::DeviceAppender::DeviceAppender
DeviceAppender(D &d, const helpers::Properties &props)
Definition deviceappender.hxx:101
log4cplus::DeviceAppender::device_type
device_traits::device_type device_type
Definition deviceappender.hxx:86
log4cplus::DeviceAppender::DeviceAppender
DeviceAppender(boost::shared_ptr< D > const &d, bool close_device=true)
Definition deviceappender.hxx:95
log4cplus::DeviceAppender::append
virtual void append(log4cplus::spi::InternalLoggingEvent const &event)
Subclasses of Appender should implement this method to perform actual logging.
Definition deviceappender.hxx:138
log4cplus::DeviceAppender::device_traits
device_appender_detail::device_type_traits< Device > device_traits
Definition deviceappender.hxx:85
log4cplus::DeviceAppender::close_flag
bool close_flag
Definition deviceappender.hxx:146
log4cplus::DeviceAppender::close
virtual void close()
Release any resources allocated within the appender such as file handles, network connections,...
Definition deviceappender.hxx:129
log4cplus::DeviceAppender::DeviceAppender
DeviceAppender(D &d, bool close_device=true)
Definition deviceappender.hxx:89
log4cplus::DeviceAppender::~DeviceAppender
virtual ~DeviceAppender()
Definition deviceappender.hxx:124
log4cplus::DeviceAppender::DeviceAppender
DeviceAppender(boost::shared_ptr< D > const &d, const helpers::Properties &props)
Definition deviceappender.hxx:112
log4cplus::helpers::Properties
Definition property.h:43
log4cplus::helpers::Properties::exists
bool exists(const log4cplus::tstring &key) const
Tests to see if key can be found in this map.
log4cplus::spi::InternalLoggingEvent
The internal representation of logging events.
Definition loggingevent.h:51
LOG4CPLUS_TEXT
#define LOG4CPLUS_TEXT(STRING)
Definition clogger.h:72
config.hxx
log4cplus::device_appender_detail
Definition deviceappender.hxx:46
log4cplus
Definition appender.h:46
log4cplus::SharedAppenderPtr
helpers::SharedObjectPtr< Appender > SharedAppenderPtr
This is a pointer to an Appender.
Definition appender.h:336
log4cplus::make_device_appender_sp
SharedAppenderPtr make_device_appender_sp(boost::shared_ptr< T > const &p, bool close_device=true)
Definition deviceappender.hxx:177
log4cplus::tstring
std::basic_string< tchar > tstring
Definition tstring.h:39
log4cplus::make_device_appender
SharedAppenderPtr make_device_appender(T &d, bool close_device=true)
Definition deviceappender.hxx:157
log4cplus::device_appender_detail::device_type_traits< boost::shared_ptr< T > >::device_type
boost::shared_ptr< T > device_type
Definition deviceappender.hxx:66
log4cplus::device_appender_detail::device_type_traits< boost::shared_ptr< T > >::unwrap
static T & unwrap(device_type const &ptr)
Definition deviceappender.hxx:70
log4cplus::device_appender_detail::device_type_traits
Definition deviceappender.hxx:51
log4cplus::device_appender_detail::device_type_traits::device_type
T & device_type
Definition deviceappender.hxx:52
log4cplus::device_appender_detail::device_type_traits::unwrap
static device_type unwrap(device_type x)
Definition deviceappender.hxx:56