SyslogUDPTarget.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Utils_Logger_SyslogUDPTarget_
#define HH_SENF_Utils_Logger_SyslogUDPTarget_ 1

// Custom includes
#include <syslog.h>
#include <senf/Socket/Protocols/INet/INetAddressing.hh>
#include <senf/Socket/ClientSocketHandle.hh>
#include <senf/Socket/FramingPolicy.hh>
#include <senf/Socket/ReadWritePolicy.hh>
#include <senf/Socket/CommunicationPolicy.hh>
#include "LogFormat.hh"
#include "Target.hh"

//#include "SyslogUDPTarget.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace log {

    class SyslogUDPTarget
        : public Target, private detail::LogFormat
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        //-////////////////////////////////////////////////////////////////////////
        //\{

        explicit SyslogUDPTarget(INet4Address const & target, int facility = LOG_USER);
        explicit SyslogUDPTarget(INet4SocketAddress const & target, int facility = LOG_USER);
        explicit SyslogUDPTarget(INet6Address const & target, int facility = LOG_USER);
        explicit SyslogUDPTarget(INet6SocketAddress const & target, int facility = LOG_USER);

        //\}
        //-////////////////////////////////////////////////////////////////////////

        using detail::LogFormat::showTime;
        using detail::LogFormat::showStream;
        using detail::LogFormat::showLevel;
        using detail::LogFormat::showArea;
        using detail::LogFormat::timeFormat;
        using detail::LogFormat::tag;

        bool syslog() const;            

        void syslog(bool enabled=true); 

    private:
        void init();
        void v_write(time_type timestamp, std::string const & stream,
                     std::string const & area, unsigned level,
                     std::string const & message);

        void consoleFormat(std::ostream & os);

        int facility_;
        typedef senf::ClientSocketHandle< senf::MakeSocketPolicy<
            senf::DatagramFramingPolicy,
            senf::ConnectedCommunicationPolicy,
            senf::WriteablePolicy>::policy > Handle;
        Handle handle_;
        bool syslogFormat_;

    public:
        enum LogFacility {
            AUTHPRIV = LOG_AUTHPRIV,
            CRON = LOG_CRON,
            DAEMON = LOG_DAEMON,
            FTP = LOG_FTP,
            KERN = LOG_KERN,
            LOCAL0 = LOG_LOCAL0,
            LOCAL1 = LOG_LOCAL1,
            LOCAL2 = LOG_LOCAL2,
            LOCAL3 = LOG_LOCAL3,
            LOCAL4 = LOG_LOCAL4,
            LOCAL5 = LOG_LOCAL5,
            LOCAL6 = LOG_LOCAL6,
            LOCAL7 = LOG_LOCAL7,
            LPR = LOG_LPR,
            MAIL = LOG_MAIL,
            NEWS = LOG_NEWS,
            SYSLOG = LOG_SYSLOG,
            USER = LOG_USER,
            UUCP = LOG_UUCP
        };

    private:

        struct RegisterConsole {
            RegisterConsole();
            static boost::shared_ptr<console::DirectoryNode> create(
                INet4SocketAddress const & target, LogFacility facility = USER);
            static boost::shared_ptr<console::DirectoryNode> create(
                INet4Address const & target, LogFacility facility = USER);
            static boost::shared_ptr<console::DirectoryNode> create(
                INet6SocketAddress const & target, LogFacility facility = USER);
            static boost::shared_ptr<console::DirectoryNode> create(
                INet6Address const & target, LogFacility facility = USER);
            static RegisterConsole instance;
        };
    };

}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "SyslogUDPTarget.cci"
//#include "SyslogUDPTarget.ct"
//#include "SyslogUDPTarget.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: