YiThread.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_THREAD_H_
#define _YI_THREAD_H_

#include "framework/YiPredef.h"
#include "thread/YiThreadHandle.h"
#include "utility/YiString.h"

typedef enum
{
    YI_PRIORITY_MIN = 0,
    YI_PRIORITY_LOW,
    YI_PRIORITY_NORMAL,
    YI_PRIORITY_HIGH,
    YI_PRIORITY_MAX,

    YI_PRIORITY_INHERITED,

    YI_PRIORITY_DEFAULT = YI_PRIORITY_INHERITED

} YI_PRIORITY;

const int32_t YI_MAX_THREADS = 100;

class CYIThreadPriv;

class CYIThread
{
    friend class CYIThreadPriv;

public:
    static const uint32_t DEFAULT_STACK_SIZE = 128 * 1024; // 128KB

    enum YI_START_TYPE
    {
        BLOCK_UNTIL_STARTED = true,
        NON_BLOCKING = false
    };

    class Listener
    {
    public:
        Listener() {}
        virtual ~Listener() {}

        virtual void OnThreadStarted(CYIThread * /*pPublisher*/) {}

        virtual void OnThreadTerminated(CYIThread * /*pPublisher*/) {}

        virtual void OnThreadFinished(CYIThread * /*pPublisher*/) {}

        virtual void OnThreadDestroyed(CYIThread * /*pPublisher*/) {}
    };

    CYIThread(const CYIString &name = CYIString(), YI_PRIORITY ePriority = YI_PRIORITY_DEFAULT, uint32_t uStackSize = DEFAULT_STACK_SIZE);

    virtual ~CYIThread();

    static CYIThreadHandle GetCurrentThreadId();

    static const CYIThreadHandle &GetUIThreadId();

    static int32_t GetOSIdealThreadCount();

    static void Sleep(uint32_t uMillis);

    static void YieldCurrentThread();

    static void ReportDefaults();

    bool StartThread(YI_START_TYPE eStartType = BLOCK_UNTIL_STARTED);

    void Terminate();


    void EnableTermination();

    void DisableTermination();

    bool IsTerminationEnabled();

    bool Join();

    bool Join(uint32_t uTimeoutMs);

    bool IsRunning() const;

    CYIThreadHandle GetThreadId() const;

    void SetName(const CYIString &name);

    const CYIString &GetName() const;

    void SetPriority(YI_PRIORITY priority);

    YI_PRIORITY GetPriority() const;

    bool AddThreadListener(Listener *pListener);

    bool RemoveThreadListener(Listener *pListener);

    bool SetStackSize(uint32_t uStackSize);

    uint32_t GetStackSize() const;

protected:

    virtual void Run() = 0;

    bool IsTerminationRequested() const;

private:

    // Hiding copy constructor
    CYIThread(const CYIThread &);

    // Hiding assignment operator.
    CYIThread &operator=(const CYIThread &);

    CYIThreadPriv *m_pPriv;
};

#endif // _YI_THREAD_H_