core/logic/thread/ThreadWorker.h
author Asher Baker <asherkin@gmail.com>
Fri Dec 14 15:16:35 2012 -0500 (2012-12-14)
changeset 3704 dd325be8f8a1
parent 3552 7abe4f5b1749
child 4025 542dde661d5c
permissions -rw-r--r--
Made thread worker processing limits configurable at runtime (bug 5326, r=psychonic).
dvander@2726
     1
/**
dvander@2726
     2
 * vim: set ts=4 :
dvander@2726
     3
 * =============================================================================
dvander@2726
     4
 * SourceMod
dvander@2726
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
dvander@2726
     6
 * =============================================================================
dvander@2726
     7
 *
dvander@2726
     8
 * This program is free software; you can redistribute it and/or modify it under
dvander@2726
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
dvander@2726
    10
 * Free Software Foundation.
dvander@2726
    11
 * 
dvander@2726
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@2726
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@2726
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@2726
    15
 * details.
dvander@2726
    16
 *
dvander@2726
    17
 * You should have received a copy of the GNU General Public License along with
dvander@2726
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@2726
    19
 *
dvander@2726
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@2726
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@2726
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@2726
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@2726
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@2726
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
dvander@2726
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@2726
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@2726
    28
 *
dvander@2726
    29
 * Version: $Id$
dvander@2726
    30
 */
dvander@2726
    31
dvander@2726
    32
#ifndef _INCLUDE_SOURCEMOD_THREADWORKER_H
dvander@2726
    33
#define _INCLUDE_SOURCEMOD_THREADWORKER_H
dvander@2726
    34
dvander@2726
    35
#include "BaseWorker.h"
dvander@2726
    36
asherkin@3552
    37
#define DEFAULT_THINK_TIME_MS	20
dvander@2726
    38
dvander@2726
    39
class ThreadWorker : public BaseWorker, public IThread
dvander@2726
    40
{
dvander@2726
    41
public:
dvander@2726
    42
	ThreadWorker(IThreadWorkerCallbacks *hooks);
dvander@2726
    43
	ThreadWorker(IThreadWorkerCallbacks *hooks, IThreader *pThreader, unsigned int thinktime=DEFAULT_THINK_TIME_MS);
dvander@2726
    44
	virtual ~ThreadWorker();
dvander@2726
    45
public:	//IThread
dvander@2726
    46
	virtual void OnTerminate(IThreadHandle *pHandle, bool cancel);
dvander@2726
    47
	virtual void RunThread(IThreadHandle *pHandle);
dvander@2726
    48
public:	//IWorker
dvander@2726
    49
	//Controls the worker
dvander@2726
    50
	virtual bool Pause();
dvander@2726
    51
	virtual bool Unpause();
dvander@2726
    52
	virtual bool Start();
dvander@2726
    53
	virtual bool Stop(bool flush_cancel);
dvander@2726
    54
	//returns status and number of threads in queue
dvander@2726
    55
	virtual WorkerState GetStatus(unsigned int *numThreads);
asherkin@3704
    56
	//virtual void SetMaxThreadsPerFrame(unsigned int threads);
asherkin@3704
    57
	virtual void SetThinkTimePerFrame(unsigned int thinktime);
dvander@2726
    58
public:	//BaseWorker
dvander@2726
    59
	virtual void AddThreadToQueue(SWThreadHandle *pHandle);
dvander@2726
    60
	virtual SWThreadHandle *PopThreadFromQueue();
dvander@2726
    61
protected:
dvander@2726
    62
	IThreader *m_Threader;
dvander@2726
    63
	IMutex *m_QueueLock;
dvander@2726
    64
	IMutex *m_StateLock;
dvander@2726
    65
	IEventSignal *m_PauseSignal;
dvander@2726
    66
	IEventSignal *m_AddSignal;
dvander@2726
    67
	IThreadHandle *me;
dvander@2726
    68
	unsigned int m_think_time;
dvander@2726
    69
	volatile bool m_Waiting;
dvander@2726
    70
	volatile bool m_FlushType;
dvander@2726
    71
};
dvander@2726
    72
dvander@2726
    73
#endif //_INCLUDE_SOURCEMOD_THREADWORKER_H