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 "log4cxx/logstring.h"

namespace log4cxx {
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 ThreadUtility;
LOG4CXX_PTR_DEF(ThreadUtility);

class LOG4CXX_EXPORT ThreadUtility {
private:
    ThreadUtility();

    log4cxx::helpers::ThreadStartPre preStartFunction();
    log4cxx::helpers::ThreadStarted threadStartedFunction();
    log4cxx::helpers::ThreadStartPost postStartFunction();

    struct priv_data;
    std::unique_ptr<priv_data> m_priv;

public:
    ~ThreadUtility();

    static std::shared_ptr<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::helpers::ThreadStartPre pre_start = preStartFunction();
        log4cxx::helpers::ThreadStarted thread_start = threadStartedFunction();
        log4cxx::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;
    }
};

} /* namespace helpers */
} /* namespace log4cxx */

#endif