coroutine.h

Go to the documentation of this file.

/*===========================================================================
     _____        _____        _____        _____
 ___|    _|__  __|_    |__  __|__   |__  __| __  |__  ______
|    \  /  | ||    \      ||     |     ||  |/ /     ||___   |
|     \/   | ||     \     ||     \     ||     \     ||___   |
|__/\__/|__|_||__|\__\  __||__|\__\  __||__|\__\  __||______|
    |_____|      |_____|      |_____|      |_____|

--[Mark3 Realtime Platform]--------------------------------------------------

Copyright (c) 2012 - 2019 m0slevin, all rights reserved.
See license.txt for more information
=========================================================================== */
#pragma once

#include "mark3cfg.h"
#include "ll.h"
#include "priomapl1.h"
#include "priomapl2.h"

namespace Mark3 {

// Priority map type declaration, based on port configuration
#if PORT_COROUTINE_PRIORITIES <= (PORT_PRIO_MAP_WORD_SIZE * 8u)
using CoPrioMap = PriorityMapL1<PORT_PRIO_TYPE, PORT_COROUTINE_PRIORITIES>;
#else
using CoPrioMap = PriorityMapL2<PORT_PRIO_TYPE, PORT_COROUTINE_PRIORITIES>;
#endif

// Forward declarations
class CoList;
class Coroutine;

// CoRoutine functino handler type definition
using CoroutineHandler = void (*)(Coroutine* pclCaller_, void* pvContext_);

class Coroutine : public TypedLinkListNode<Coroutine>
{
public:
    void* operator new(size_t sz, void* pv) { return reinterpret_cast<Coroutine*>(pv); }
    ~Coroutine();

    void Init(PORT_PRIO_TYPE uPriority_, CoroutineHandler pfHandler_, void* pvContext_);

    void Run();

    void Activate();

    void SetPriority(PORT_PRIO_TYPE uPriority_);

    PORT_PRIO_TYPE GetPriority();

private:
    CoList* m_pclOwner;
    CoroutineHandler m_pfHandler;
    void* m_pvContext;
    PORT_PRIO_TYPE m_uPriority;
    bool m_bQueued;
};
} // namespace Mark3