ThreadCommon.hpp

Go to the documentation of this file.

#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADCOMMON_HPP_
#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADCOMMON_HPP_

#include "distortos/internal/scheduler/RunnableThread.hpp"
#include "distortos/internal/scheduler/ThreadControlBlock.hpp"

#include "distortos/Semaphore.hpp"

namespace distortos
{

namespace internal
{

class ThreadCommon : public RunnableThread
{
public:

    using StackStorageUniquePointer = Stack::StorageUniquePointer;

    ThreadCommon(Stack&& stack, uint8_t priority, SchedulingPolicy schedulingPolicy,
            ThreadGroupControlBlock* threadGroupControlBlock, SignalsReceiver* signalsReceiver);

    ~ThreadCommon() override;

#if DISTORTOS_SIGNALS_ENABLE == 1

    int generateSignal(uint8_t signalNumber) override;

#endif  // DISTORTOS_SIGNALS_ENABLE == 1

    uint8_t getEffectivePriority() const override;

    ThreadIdentifier getIdentifier() const override;

#if DISTORTOS_SIGNALS_ENABLE == 1

    SignalSet getPendingSignalSet() const override;

#endif  // DISTORTOS_SIGNALS_ENABLE == 1

    uint8_t getPriority() const override;

    SchedulingPolicy getSchedulingPolicy() const override;

    size_t getStackHighWaterMark() const override;

    size_t getStackSize() const override;

    ThreadState getState() const override;

    int join() override;

#if DISTORTOS_SIGNALS_ENABLE == 1

    int queueSignal(uint8_t signalNumber, sigval value) override;

#endif  // DISTORTOS_SIGNALS_ENABLE == 1

    void setPriority(uint8_t priority, bool alwaysBehind = {}) override;

    void setSchedulingPolicy(SchedulingPolicy schedulingPolicy) override;

    ThreadCommon(const ThreadCommon&) = delete;
    ThreadCommon(ThreadCommon&&) = default;
    const ThreadCommon& operator=(const ThreadCommon&) = delete;
    ThreadCommon& operator=(ThreadCommon&&) = delete;

protected:

    void exit0Hook() override;

    void exit1Hook() override;

    ThreadControlBlock& getThreadControlBlock()
    {
        return threadControlBlock_;
    }

    const ThreadControlBlock& getThreadControlBlock() const
    {
        return threadControlBlock_;
    }

    int startInternal();

private:

    ThreadControlBlock threadControlBlock_;

    Semaphore joinSemaphore_;
};

}   // namespace internal

}   // namespace distortos

#endif  // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADCOMMON_HPP_