threadutility.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _LOG4CXX_THREADUTILITY_H
#define _LOG4CXX_THREADUTILITY_H
 
#include <thread>
#include <functional>
#include <memory>
#include <chrono>
 
#include <log4cxx/logstring.h>
#include <log4cxx/helpers/singletonholder.h>
 
namespace LOG4CXX_NS
{
namespace helpers
{

using ThreadStartPre = std::function<void()>;

using ThreadStarted = std::function
    < void
        ( LogString                       threadName
        , std::thread::id                 threadId
        , std::thread::native_handle_type nativeHandle
        )
    >;

using ThreadStartPost = std::function<void()>;
 
enum class ThreadConfigurationType
{
    NoConfiguration,
    BlockSignalsOnly,
    NameThreadOnly,
    BlockSignalsAndNameThread,
};
 
class LOG4CXX_EXPORT ThreadUtility
{
    private:
        friend class SingletonHolder<ThreadUtility>;
        ThreadUtility();
 
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(priv_data, m_priv)
    public:
        ~ThreadUtility();
 
        static ThreadUtility* instance();

        static ThreadConfigurationType configure( ThreadConfigurationType new_value );

        ThreadConfigurationType configureFuncs
            ( ThreadStartPre  pre_start
            , ThreadStarted   set_name
            , ThreadStartPost post_start
            );

        template<class Function, class... Args>
        std::thread createThread
            ( LogString name
            , Function&& f
            , Args&& ... args
            )
        {
            ThreadStartContext ctx(this);
            std::thread t( f, args... );
            ctx.setThreadName(name, t.get_id(), t.native_handle());
            return t;
        }
 
        using Period = std::chrono::milliseconds;

        void addPeriodicTask(const LogString& taskName, std::function<void()> f, const Period& delay);

        bool hasPeriodicTask(const LogString& taskName);

        bool isProcessingThreadActive() const;

        void removeAllPeriodicTasks();

        void removePeriodicTask(const LogString& taskName);

        void removePeriodicTasksMatching(const LogString& namePrefix);
 
        using Manager = SingletonHolder<ThreadUtility>;
        LOG4CXX_PTR_DEF(Manager);
 
        static ManagerPtr instancePtr();
 
private:
        struct LOG4CXX_EXPORT ThreadStartContext
        {
            LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(Impl, m_priv)
            ThreadStartContext(ThreadUtility* parent);
            ~ThreadStartContext();
            void setThreadName
                ( LogString                       threadName
                , std::thread::id                 threadId
                , std::thread::native_handle_type nativeHandle
                ) const;
        };
};
 
} /* namespace helpers */
} /* namespace log4cxx */
 
#endif