ThreadPool.h

Go to the documentation of this file.

// Copyright Onix Solutions Limited [OnixS]. All rights reserved.
//
// This software owned by Onix Solutions Limited [OnixS] and is 
// protected by copyright law and international copyright treaties.
//
// Access to and use of the software is governed by the terms of the applicable 
// OnixS Software Services Agreement (the Agreement) and Customer end user license 
// agreements granting a non-assignable, non-transferable and non-exclusive license 
// to use the software for it's own data processing purposes under the terms defined 
// in the Agreement.
//
// Except as otherwise granted within the terms of the Agreement, copying or 
// reproduction of any part of this source code or associated reference material 
// to any other location for further reproduction or redistribution, and any 
// amendments to this copyright notice, are expressly prohibited.
//
// Any reproduction or redistribution for sale or hiring of the Software not in 
// accordance with the terms of the Agreement is a violation of copyright law.
//
 
#pragma once
 
#include <vector>
 
#include <OnixS/CME/ConflatedUDP/String.h>
#include <OnixS/CME/ConflatedUDP/Integral.h>
#include <OnixS/CME/ConflatedUDP/TinySet.h>
 
ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN

ONIXS_CONFLATEDUDP_EXPORTED_STRUCT Task
{
    virtual void run() = 0;
};

typedef Int32 CpuIndex;

typedef 
TinySet<CpuIndex> 
CpuIndices;

ONIXS_CONFLATEDUDP_LTWT_CLASS ThreadAffinity
{
    CpuIndices indices_;
 
public:
    ThreadAffinity()
    {
    }

    ThreadAffinity(
        const ThreadAffinity& other)
        : indices_(other.indices_)
    {
    }

    ~ThreadAffinity()
    {
    }

    operator bool() const
    {
        return indices_.empty();
    }

    const CpuIndices& cpus() const
    {
        return indices_;
    }

    CpuIndices& cpus()
    {
        return indices_;
    }
};

ONIXS_CONFLATEDUDP_EXPORTED 
void 
toStr(
    std::string&, 
    const ThreadAffinity&);

inline 
std::string 
toStr(
    const ThreadAffinity& affinity)
{
    std::string str;
 
    toStr(str, affinity);
 
    return str;
}
 
//
 
ONIXS_CONFLATEDUDP_INTERNAL_CLASS_DECL
(
    TaskRunner
);

ONIXS_CONFLATEDUDP_LTWT_CLASS ThreadPool
{
    typedef 
    std::vector<TaskRunner*> 
    Tasks;
 
    Tasks tasks_;
 
    const size_t capacity_;
 
    ThreadPool(
        const ThreadPool&);
 
    ThreadPool& 
    operator =(
        const ThreadPool&);
 
public:
    explicit 
    ThreadPool(
        size_t capacity)
        : capacity_(capacity)
    {
        tasks_.reserve(capacity);
    }

    ~ThreadPool()
    {
        joinAll();
    }

    size_t size() const
    {
        return tasks_.size();
    }

    size_t capacity() const
    {
        return capacity_;
    }

    void
    start(
        Task& task)
    {
        start(
            task, 
            ThreadAffinity());
    }

    ONIXS_CONFLATEDUDP_LTWT_EXPORTED
    void 
    start(
        Task&, 
        const ThreadAffinity&);

    ONIXS_CONFLATEDUDP_LTWT_EXPORTED
    void 
    joinAll();
};

ONIXS_CONFLATEDUDP_LTWT_CLASS 
ThreadPoolSettings
{
    ThreadAffinity affinity_;
    UInt32 size_;
 
public:
    ThreadPoolSettings()
      : affinity_()
      , size_(1)
    {
    }

    ~ThreadPoolSettings()
    {
    }

    const 
    ThreadAffinity& 
    affinity() const
    {
        return affinity_;
    }

    ThreadAffinity& affinity()
    {
        return affinity_;
    }

    UInt32 
    size() const
    {
        return size_;
    }

    void 
    size(
        UInt32 value)
    {
        size_ = value;
    }
};

ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&,
    const 
    ThreadPoolSettings&);

inline 
std::string
toStr(
    const 
    ThreadPoolSettings& settings)
{
    std::string str;
 
    toStr(str, settings);
 
    return str;
}
 
ONIXS_CONFLATEDUDP_NAMESPACE_END