libcrystalspace-dev 2.0+dfsg-1build1 / usr / include / crystalspace-2.0 / iutil / threadmanager.h

This file is indexed.

/usr/include/crystalspace-2.0/iutil/threadmanager.h is in libcrystalspace-dev 2.0+dfsg-1build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/*
  Copyright (C) 2008 by Michael Gist

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public
  License along with this library; if not, write to the Free
  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IUTIL_THREADMANAGER_H__
#define __CS_IUTIL_THREADMANAGER_H__

#include "csutil/refcount.h"
#include "csutil/refarr.h"
#include "csutil/threading/condition.h"
#include "csutil/threading/mutex.h"

struct iConfigManager;
struct iJob;

struct iThreadReturn : public virtual iBase
{
  SCF_INTERFACE(iThreadReturn, 1, 2, 0);

  virtual bool IsFinished() = 0;
  virtual bool WasSuccessful() = 0;
  virtual void* GetResultPtr() = 0;
  virtual csRef<iBase> GetResultRefPtr() = 0;

  virtual void MarkFinished() = 0;
  virtual void MarkSuccessful() = 0;
  virtual void SetResult(void* result) = 0;
  virtual void SetResult(csRef<iBase> result) = 0;

  virtual void Copy(iThreadReturn* other) = 0;

  virtual void Wait(bool process = true) = 0;
  virtual void SetWaitPtrs(CS::Threading::Condition* c, CS::Threading::Mutex* m) = 0;

  virtual void SetJob(iJob* job) = 0;
  virtual iJob* GetJob() const = 0;
};

enum QueueType
{
  THREADED = 0,
  THREADEDL,
  HIGH,
  MED,
  LOW
};

/**
 * This is the thread manager.
 *
 * Main creators of instances implementing this interface:
 * - csInitializer::CreateEnvironment()
 * - csInitializer::CreateThreadManager()
 * 
 * Main ways to get pointers to this interface:
 * - csQueryRegistry()
 */

struct iThreadManager : public virtual iBase
{
  SCF_INTERFACE(iThreadManager, 3, 0, 1);

  virtual void Init(iConfigManager* config) = 0;
  virtual void Process(uint num = 1) = 0;
  virtual void PushToQueue(QueueType queueType, iJob* job) = 0;
  virtual bool Wait(csRefArray<iThreadReturn>& threadReturns, bool process = true) = 0;
  virtual bool RunNow(QueueType queueType, bool wait, bool forceQueue) = 0;
  virtual int32 GetThreadCount() = 0;
  virtual void SetAlwaysRunNow(bool v) = 0;
  virtual bool GetAlwaysRunNow() = 0;
  virtual bool Exiting() = 0;
  /// Process all pending events
  virtual void ProcessAll () = 0;
};

// Interface macros
#define THREADED_INTERFACE(function) \
  virtual csRef<iThreadReturn> function() = 0; \
  virtual csRef<iThreadReturn> function##Wait() = 0

#define THREADED_INTERFACE1(function, arg1) \
  virtual csRef<iThreadReturn> function(arg1) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1) = 0

#define THREADED_INTERFACE2(function, arg1, arg2) \
  virtual csRef<iThreadReturn> function(arg1, arg2) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2) = 0

#define THREADED_INTERFACE3(function, arg1, arg2, arg3) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3) = 0

#define THREADED_INTERFACE4(function, arg1, arg2, arg3, arg4) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4) = 0

#define THREADED_INTERFACE5(function, arg1, arg2, arg3, arg4, arg5) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5) = 0

#define THREADED_INTERFACE6(function, arg1, arg2, arg3, arg4, arg5, arg6) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6) = 0

#define THREADED_INTERFACE7(function, arg1, arg2, arg3, arg4, arg5, arg6, arg7) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6, arg7) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6, arg7) = 0

#define THREADED_INTERFACE8(function, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) = 0

#define THREADED_INTERFACE9(function, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) = 0

#define THREADED_INTERFACE10(function, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10) = 0

#define THREADED_INTERFACE11(function, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11) = 0

#define THREADED_INTERFACE12(function, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12) = 0

#define THREADED_INTERFACE13(function, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13) = 0

#define THREADED_INTERFACE14(function, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14) = 0

#define THREADED_INTERFACE15(function, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15) \
  virtual csRef<iThreadReturn> function(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15) = 0; \
  virtual csRef<iThreadReturn> function##Wait(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15) = 0

#endif // __CS_IUTIL_THREADMANAGER_H__

APT Browse - Built by Thomas Orozco.