mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-06 18:26:22 +03:00
42cf5bc1ca
Automatic upgrade of OCCT code by command "occt_upgrade . -nocdl": - WOK-generated header files from inc and sources from drv are moved to src - CDL files removed - All packages are converted to nocdlpack
146 lines
4.4 KiB
C++
146 lines
4.4 KiB
C++
// Created on: 2006-03-10
|
|
// Created by: data exchange team
|
|
// Copyright (c) 2006-2014 OPEN CASCADE SAS
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License version 2.1 as published
|
|
// by the Free Software Foundation, with special exception defined in the file
|
|
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
// distribution for complete text of the license and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#ifndef _OSD_Thread_HeaderFile
|
|
#define _OSD_Thread_HeaderFile
|
|
|
|
#include <Standard.hxx>
|
|
#include <Standard_DefineAlloc.hxx>
|
|
#include <Standard_Handle.hxx>
|
|
|
|
#include <OSD_ThreadFunction.hxx>
|
|
#include <OSD_PThread.hxx>
|
|
#include <Standard_ThreadId.hxx>
|
|
#include <Standard_Integer.hxx>
|
|
#include <Standard_Boolean.hxx>
|
|
#include <Standard_Address.hxx>
|
|
|
|
|
|
//! A simple platform-intependent interface to execute
|
|
//! and control threads.
|
|
class OSD_Thread
|
|
{
|
|
public:
|
|
|
|
DEFINE_STANDARD_ALLOC
|
|
|
|
|
|
//! Empty constructor
|
|
Standard_EXPORT OSD_Thread();
|
|
|
|
//! Initialize the tool by the thread function
|
|
//!
|
|
//! Note: On Windows, you might have to take an address of the thread
|
|
//! function explicitly to pass it to this constructor without compiler error
|
|
Standard_EXPORT OSD_Thread(const OSD_ThreadFunction& func);
|
|
|
|
//! Copy constructor
|
|
Standard_EXPORT OSD_Thread(const OSD_Thread& other);
|
|
|
|
//! Copy thread handle from other OSD_Thread object.
|
|
Standard_EXPORT void Assign (const OSD_Thread& other);
|
|
void operator = (const OSD_Thread& other)
|
|
{
|
|
Assign(other);
|
|
}
|
|
|
|
//! Destructor. On Windows, closes handle to the thread.
|
|
//! On UNIX/Linux, does nothing.
|
|
Standard_EXPORT void Destroy();
|
|
~OSD_Thread()
|
|
{
|
|
Destroy();
|
|
}
|
|
|
|
Standard_EXPORT void SetPriority (const Standard_Integer thePriority);
|
|
|
|
//! Initialize the tool by the thread function.
|
|
//! If the current thread handle is not null, nullifies it.
|
|
//!
|
|
//! Note: On Windows, you might have to take an address of the thread
|
|
//! function explicitly to pass it to this method without compiler error
|
|
Standard_EXPORT void SetFunction (const OSD_ThreadFunction& func);
|
|
|
|
//! Starts a thread with thread function given in constructor,
|
|
//! passing the specified input data (as void *) to it.
|
|
//! The parameter \a WNTStackSize (on Windows only)
|
|
//! specifies size of the stack to be allocated for the thread
|
|
//! (by default - the same as for the current executable).
|
|
//! Returns True if thread started successfully
|
|
Standard_EXPORT Standard_Boolean Run (const Standard_Address data = 0, const Standard_Integer WNTStackSize = 0);
|
|
|
|
//! Detaches the execution thread from this Thread object,
|
|
//! so that it cannot be waited.
|
|
//! Note that mechanics of this operation is different on
|
|
//! UNIX/Linux (the thread is put to detached state) and Windows
|
|
//! (the handle is closed).
|
|
//! However, the purpose is the same: to instruct the system to
|
|
//! release all thread data upon its completion.
|
|
Standard_EXPORT void Detach();
|
|
|
|
Standard_EXPORT Standard_Boolean Wait() const;
|
|
|
|
//! Wait till the thread finishes execution.
|
|
//! Returns True if wait was successful, False in case of error.
|
|
//!
|
|
//! If successful and \a result argument is provided, saves the pointer
|
|
//! (void*) returned by the thread function in \a result.
|
|
//!
|
|
//! Note however that it is advisable not to rely upon returned result
|
|
//! value, as it is not always the value actually returned by the thread
|
|
//! function. In addition, on Windows it is converted via DWORD.
|
|
Standard_EXPORT Standard_Boolean Wait (Standard_Address& result) const;
|
|
|
|
//! Waits for some time and if the thread is finished,
|
|
//! it returns the result.
|
|
//! The function returns false if the thread is not finished yet.
|
|
Standard_EXPORT Standard_Boolean Wait (const Standard_Integer time, Standard_Address& result) const;
|
|
|
|
//! Returns ID of the currently controlled thread ID,
|
|
//! or 0 if no thread is run
|
|
Standard_EXPORT Standard_ThreadId GetId() const;
|
|
|
|
//! Auxiliary: returns ID of the current thread
|
|
Standard_EXPORT static Standard_ThreadId Current();
|
|
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
OSD_ThreadFunction myFunc;
|
|
OSD_PThread myThread;
|
|
Standard_ThreadId myThreadId;
|
|
Standard_Integer myPriority;
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif // _OSD_Thread_HeaderFile
|