Thread.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
 * Copyright (C) 2006-2010 RobotCub Consortium
 * All rights reserved.
 *
 * This software may be modified and distributed under the terms of the
 * BSD-3-Clause license. See the accompanying LICENSE file for details.
 */
 
#ifndef YARP_OS_THREAD_H
#define YARP_OS_THREAD_H
 
#include <yarp/os/api.h>
 
namespace yarp {
namespace os {
 
 
class YARP_os_API Thread
{
public:
    Thread();
 
    virtual ~Thread();
 
    virtual void run() = 0;
 
    virtual void onStop();
 
    bool start();
 
    bool stop();
 
 
    virtual void beforeStart();
 
    virtual void afterStart(bool success);
 
 
    virtual bool threadInit()
    {
        return true;
    }
 
    virtual void threadRelease()
    {
    }
 
 
    bool isStopping();
 
    bool isRunning();
 
    static int getCount();
 
    long int getKey();
 
    static long int getKeyOfCaller();
 
    int setPriority(int priority, int policy = -1);
 
    int getPriority();
 
 
    int getPolicy();
 
    bool join(double seconds = -1);
 
    static void yield();
 
 
#ifndef YARP_NO_DEPRECATED // since YARP 3.0.0
    YARP_DEPRECATED
    void setOptions(int stackSize = 0)
    {
    }
 
    YARP_DEPRECATED
    static void setDefaultStackSize(int stackSize)
    {
    }
#endif // YARP_NO_DEPRECATED
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
    class Private;
    Private* const mPriv;
#endif
};
 
} // namespace os
} // namespace yarp
 
#endif // YARP_OS_THREAD_H