IoThread.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Base/Core/delegate.hxx"
 
namespace Arp::Io::Commons
{
 
class ARP_EXPORT IoThread
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using ThreadLoopBodyDelegate = delegate<void(void)>;
 
public: // canonical construction/destruction/assignment
    IoThread(const IoThread& arg) = delete;
    IoThread(IoThread&& arg)noexcept;
    IoThread& operator=(const IoThread& arg) = delete;
    IoThread& operator=(IoThread&& arg)noexcept;
    ~IoThread(void);
 
public: // construction/destruction/assignment
    IoThread(
        const String& name,                             // thread name
        size_t priority,                                // thread priority, range=0..98
        Duration cycleTime,                             // cycle time
        size_t cpuAffinityMask,                         // CPU bitmask, 0=unbound, 1=core_1, 2=core_2, 3=core_1or2
        ThreadLoopBodyDelegate threadLoopBodyDelegate); // delegate to execute the thread loop body in any cycle
 
public: // setter/getter operations
    const String&   GetName(void)const;
    size_t          GetPriority(void)const;
    Duration        GetCycleTime(void)const;
    size_t          GetCpuAffinityMask(void)const;
 
public: // operations
    void Start(void);
    void Join(bool interrupt = true);
    void Abort(void);
 
public: // internal operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
} // end of namespace Arp::Io::Commons