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 "singletonholder.h"
 
namespace LOG4CXX_NS
{
namespace helpers
{
 
typedef std::function<void()> ThreadStartPre;
 
typedef std::function<void( LogString threadName,
    std::thread::id threadId,
    std::thread::native_handle_type nativeHandle )> ThreadStarted;
 
typedef std::function<void()> ThreadStartPost;
 
enum class ThreadConfigurationType
{
    NoConfiguration,
    BlockSignalsOnly,
    NameThreadOnly,
    BlockSignalsAndNameThread,
};
 
class LOG4CXX_EXPORT ThreadUtility
{
    private:
        friend class SingletonHolder<ThreadUtility>;
        ThreadUtility();
 
        LOG4CXX_NS::helpers::ThreadStartPre preStartFunction();
        LOG4CXX_NS::helpers::ThreadStarted threadStartedFunction();
        LOG4CXX_NS::helpers::ThreadStartPost postStartFunction();
 
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(priv_data, m_priv)
    public:
        ~ThreadUtility();
 
        static ThreadUtility* instance();
 
        static void configure( ThreadConfigurationType type );
 
        void configureFuncs( ThreadStartPre pre_start,
            ThreadStarted started,
            ThreadStartPost post_start );
 
        void preThreadBlockSignals();
 
        void threadStartedNameThread(LogString threadName,
            std::thread::id thread_id,
            std::thread::native_handle_type native_handle);
 
        void postThreadUnblockSignals();
 
        template<class Function, class... Args>
        std::thread createThread(LogString name,
            Function&& f,
            Args&& ... args)
        {
            LOG4CXX_NS::helpers::ThreadStartPre pre_start = preStartFunction();
            LOG4CXX_NS::helpers::ThreadStarted thread_start = threadStartedFunction();
            LOG4CXX_NS::helpers::ThreadStartPost post_start = postStartFunction();
 
            if ( pre_start )
            {
                pre_start();
            }
 
            std::thread t( f, args... );
 
            if ( thread_start )
            {
                thread_start( name,
                    t.get_id(),
                    t.native_handle() );
            }
 
            if ( post_start )
            {
                post_start();
            }
 
            return t;
        }
 
        using Period = std::chrono::milliseconds;
 
        void addPeriodicTask(const LogString& taskName, std::function<void()> f, const Period& delay);
 
        bool hasPeriodicTask(const LogString& taskName);
 
        void removeAllPeriodicTasks();
 
        void removePeriodicTask(const LogString& taskName);
 
        void removePeriodicTasksMatching(const LogString& namePrefix);
 
        using Manager = SingletonHolder<ThreadUtility>;
        LOG4CXX_PTR_DEF(Manager);
 
        static ManagerPtr instancePtr();
};
 
} /* namespace helpers */
} /* namespace log4cxx */
 
#endif