Target.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_Target_
#define HH_SENF_Utils_Logger_Target_ 1

// Custom includes
#include <vector>
#include <boost/noncopyable.hpp>
#include <senf/Utils/Exception.hh>
#include <senf/Utils/Console/LazyDirectory.hh>
#include "TimeSource.hh"
#include "Levels.hh"

//#include "Target.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace log {

    namespace detail { class TargetRegistry; }
    namespace detail { struct AreaBase; }
    namespace detail { struct LogParameters; }
    namespace detail { struct StreamBase; }

    class Target : private boost::noncopyable
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        enum action_t {
            ACCEPT 
          , REJECT 
        };

        struct RoutingEntry
        {
            std::string stream() const; 
            std::string area() const;   
            unsigned level() const;     
            action_t action() const;    

#           ifdef DOXYGEN
        private:
#           endif

            RoutingEntry();
            bool operator==(RoutingEntry const & other) const;

        private:
            RoutingEntry(detail::StreamBase const * stream, detail::AreaBase const * area,
                         unsigned level, action_t action);

            detail::StreamBase const * stream_;
            detail::AreaBase const * area_;
            unsigned level_;
            action_t action_;

            friend class Target;
        };

    private:
        typedef std::vector<RoutingEntry> RIB;

    public:
        typedef RIB::const_iterator iterator; 
        typedef RIB::size_type size_type;

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

        explicit Target(std::string const & name);
        virtual ~Target();

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

#       ifdef DOXYGEN

        template <class Stream, class Area, class Level> void route(
            action_t action = ACCEPT, int index = -1); 

#       endif

        void route(std::string const & stream, std::string const & area = "",
                   unsigned level = NONE::value, action_t action = ACCEPT, int index = -1);

#       ifdef DOXYGEN

        template <class Stream, class Area, class Level>
        void unroute(action_t action = ACCEPT);

#       endif

        void unroute(std::string const & stream, std::string const & area = "",
                     unsigned level = NONE::value, action_t action = ACCEPT);

        void unroute(int index=-1);     

#       ifndef DOXYGEN

        void route(action_t action = ACCEPT, int index = -1);
        template <class A1>
        void route(action_t action = ACCEPT, int index = -1);
        template <class A1, class A2>
        void route(action_t action = ACCEPT, int index = -1);
        template <class A1, class A2, class A3>
        void route(action_t action = ACCEPT, int index = -1);

        void unroute(action_t action = ACCEPT);
        template <class A1>
        void unroute(action_t action = ACCEPT);
        template <class A1, class A2>
        void unroute(action_t action = ACCEPT);
        template <class A1, class A2, class A3>
        void unroute(action_t action = ACCEPT);

#       endif

        //\}

        struct InvalidStreamException : public senf::Exception
        { InvalidStreamException()
              : senf::Exception("senf::log::Target::InvalidStreamException") {} };

        struct InvalidAreaException : public senf::Exception
        { InvalidAreaException()
              : senf::Exception("senf::log::Target::InvalidAreaException") {} };

        iterator begin() const;         
        iterator end() const;           

        RoutingEntry const & operator[](size_type i) const; 

        size_type size() const;         
        bool empty() const;             

        void flush();                   

        senf::console::ScopedDirectory<> & consoleDir(); 

    private:
        void route(detail::StreamBase const * stream, detail::AreaBase const * area,
                   unsigned level, action_t action, int index);
        void unroute(detail::StreamBase const * stream, detail::AreaBase const * area,
                     unsigned level, action_t action);

        void updateRoutingCache(detail::StreamBase const * stream, detail::AreaBase const * area);

        void write(time_type timestamp, detail::StreamBase const & stream,
                   detail::AreaBase const & area, unsigned level, std::string const & message);

        void consoleList(std::ostream & os);
        void consoleRoute(int index, detail::LogParameters const & pm, action_t action);
        void consoleUnroute(detail::LogParameters const & pm, action_t action);

#   ifdef DOXYGEN
    protected:
#   endif

        virtual void v_write(time_type timestamp, std::string const & stream,
                             std::string const & area, unsigned level,
                             std::string const & message) = 0;

#   ifdef DOXYGEN
    private:
#   endif

        RIB rib_;

        console::LazyDirectory consoleDir_;

        friend struct detail::AreaBase;
        friend class detail::TargetRegistry;
    };

    std::ostream & operator<<(std::ostream & os, Target::action_t const & action);

}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "Target.cci"
//#include "Target.ct"
#include "Target.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: