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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366

3.01: 2012-04-21
- New features:
  - Exception handling added to Parallel.Async.
    http://www.thedelphigeek.com/2012/02/exceptions-in-async.html
  - Task property added to the IOmniWorkItem interface.
  - Added TOmniValueObj class, a class wrapper for TOmniValue record.
- Bug fixes:
  - Fixed race condition in InternalStop.
  - Fixed overloaded OnMessage declaration in the IOmniTaskConfig interface.
  - It was not possible to change timer delay once it was created.
    Big thanks to [Unspoken] for finding the bug.
  - TOmniValueContainer.Insert did not update internal 'count' field.
    Big thanks to [andi] for bug report and fix.
  - Internal event monitor messages must be processed in Terminate,
    otherwise OnTerminated is not called if the task is terminated from the task
    controller. Big thanks to [Qmodem] for finding the bug.
  - TOmniValue.CreateNamed was casting pointer to integer. 
    Tnx to [Mayjest] for finding the problem.
  - Fixed object and interface casting in TOmniValue.CreateNamed. 
    Tnx to [Mayjest] for finding the problem.
  - IOmniJoinState.Task was not correctly set in TOmniParallelJoin.Execute. 
    Tnx to [Mayjest] for finding the problem.

3.0 2011-12-30
- New features:
  - Support for 64-bit platform. Great thanks to [GJ] for doing most of
    the work!
  - Implemented background worker abstraction, Parallel.BackgroundWorker.
  - Implemented Atomic<T> class for lock-free initialization of interfaces 
    and objects.
  - Implemented Locked<T> class for locking intialization of practically 
    anything.
    http://www.thedelphigeek.com/2011/11/atomic-interface-initialization.html
    http://www.thedelphigeek.com/2011/11/per-object-locking.html
    http://www.thedelphigeek.com/2011/12/on-optimistic-and-pessimistic.html
    http://www.thedelphigeek.com/2011/12/creating-object-from-unconstrained.html
  - TOmniValue.AsInteger, AsString and AsWideString now work if the
    TOmniValue contains a Variant of the apropriate type.
  - TOmniValue can store arrays, hashes and records. Variant arrays are no 
    longer used. IsArray tests it TOmniValue contains an array and AsArray 
    returns this internal container. Default indexed property still accesses 
    individual elements in this container. See demo 50_OmniValueArray for an 
    example.
    http://www.thedelphigeek.com/2011/11/tomnivalue-handles-arrays-hashes-and.html
  - Added a class which can wrap any record - TOmniRecordWrapper<T>.
  - Added an interface which can wrap any object and destroy it when the 
    interface goes out of scope - IOmniAutoDestroyObject.
- Bug fixes:
  - Fixed bugs in TOmniInterfaceDictionary which caused scheduled tasks not 
    to be destroyed until the program was terminated. Great thanks to 
    [Zarko] for providing a reproducible test case.
  - Fixed race condition between TOmniTask.Execute and TOmniTask.Terminate.
  - Under some circumstances ProcessMessage failed to rebuild handle
    array before waiting which could cause 'invalid handle' error.
  - Fixed wrong order in teardown sequence in TOmniTask.Execute which could 
    cause access violation crash. Great thanks to [Anton Alisov] for 
    providing a reproducible test case.
  - Fixed invalid "A call to an OS function failed" error in DispatchEvent.
  - TOmniMessageQueue.Enqueue leaked if queue was full and value contained 
    reference counted value (found by [meishier]).
  - Number of producers/consumers in TOmniForkJoin<T>.StartWorkerTasks was 
    off by 1 (found by [meishier]).
- New demos:
  - 49_FramedWorkers: Multiple frames communication with each own worker task.
  - 50_OmniValueArray: Wrapping arrays, hashes and records in TOmniValue.
  - 51_PipelineStressTest: Stress test by [Anton Alisov].
  - 52_BackgroundWorker: Demo for the new Parallel.BackgroundWorker abstraction.

2.2 2011-10-07
- New features:
  - Delphi XE2 support (Windows 32-bit only).
  - Parallel.Task can be used to execute multiple copies of a common code.
    [http://www.thedelphigeek.com/2011/09/life-after-21-parallel-data-production.html]
  - Breaking change! Parallel.Join reimplemented as IOmniParallelJoin interface
    to add exception and cancellation support. User code must call .Execute on the
    interface returned from the Parallel.Join to start the execution.
    [http://www.thedelphigeek.com/2011/07/life-after-21-paralleljoins-new-clothes.html]
  - Added exception handling to Parallel.Join. Tasks' fatal exceptions are wrapped
    in EJoinException and raised at the end of Parallel.Join method (or when WaitFor is
    called if Join is executed with the .NoWait modifier).
  - Added exception handling to IOmniFuture<T>. Tasks' fatal exception is raised
    in .Value. New function .FatalException and .DetachException.
    [http://www.thedelphigeek.com/2011/07/life-after-21-exceptions-in.html]
  - Two version of Parallel.Async (the ones with explicit termination handlers)
    were removed as this functionality can be achieved by using
    Parallel.TaskConfig.OnTerminated.
    [http://www.thedelphigeek.com/2011/07/life-after-21-async-redux.html]
  - Parallel.Join(const task: TOmniTaskDelegate) is no longer supported. It was
    replaced with the Parallel.Join(const task: IOmniJoinState).
  - Parallel.Join no longer supports taskConfig parameter (replaced by the
    IOmniParallelJoin.TaskConfig function).
  - Number of simultaneously executed task in Parallel.Join may be set by calling
    the new IOmniParallelJoin.NumTasks function.
  - Implemented TOmni[Base]Queue.IsEmpty. Keep in mind that the returned value may not be
    valid for any ammount of time if other threads are reading from/writing to the queue.
  - Implemented another IOmniTaskControl.OnTerminated overload acception parameterless
    anonymous function.
  - Implemented [I|T]OmniBlockingCollection.IsFinalized.
  - Parallel.Pipeline accepts 'simple stage' (for loop implemented internally).
    [http://www.thedelphigeek.com/2011/09/life-after-21-pimp-my-pipeline.html]
  - TOmniValue can natively store exception objects (AsException, IsException).
  - Implemented IOmniBlockingCollection.ReraiseExceptions. If enabled
    (default: disabled), [Try]Take will check if returned value for exception
    (TOmniValue.IsException) and if true, it will reraise this exception
    instead of returning a result.
  - Assertions are enabled in OTLOptions.inc - OtlContainers needs them.
- Bug fixes:
  - Event monitor in connection to the thread pool was totally broken. 
    (Big thanks to [anton alisov] for finding the problem.)
  - Fixed [Try]Add/CompleteAdding/[Try]Take three-thread race condition in
    TOmniBlockingCollection.
    [http://www.thedelphigeek.com/2011/08/multithreading-is-hard.html]    
- New demos:
  - 48_OtlParallelExceptions: Exception handling in high-level OTL constructs.    
  
2.1 2011-07-19
- New features:
  - Parallel.Async can be used to start simple background tasks.
    [http://www.thedelphigeek.com/2011/04/simple-background-tasks-with.html]
  - Parallel.ForkJoin - divide and conquer (fork/join) framework.
    [http://www.thedelphigeek.com/2011/05/divide-and-conquer-in-parallel.html]
  - OtlParallel tasks can be configured with Parallel.TaskConfig; you can also
    use it to communicated with the owner thread from the task.
    http://www.thedelphigeek.com/2011/04/configuring-background-otlparallel.html
  - IOmniTask[Control] can call Invoke method to asynchronously execute a block
    of code in the other thread.
    [http://www.thedelphigeek.com/2011/03/synchronize-comes-to-omnithreadlibrary.html]
  - Passes timer ID to timer proc if it accepts const TOmniValue parameter.
  - Support for non-silent exceptions removed.
  - Added property IOmniTaskControl.FatalExecption containing exception that was 
    caught at the task level.
  - Change signature for exception filters in OtlHook.FilterException.
  - IOmniTaskControl termination empties task message queue and calls appropriate
    OnMessage handlers.
- Bug fixes:
  - Fixed race condition in TOmniTask.Execute.
  - OtlParallel compiles in Delphi 2009.
  - OTL monitor message window could be used after it was destroyed.
  - Parallel.ForEach was never running on more than Process.Affinity.Count tasks.
  - OtlParallel pools are created on the fly - Otlparallel unit can be used from a DLL.
  - [dottor_jeckill] Bug fix: TOmniResourceCount.TryAllocate always returned False.
  - Enumerating over TOmniTaskControlList (for example when using
    IOmniTaskGroup.SendToAll) leaked one object.
  - Makes sure timers are called even if there's a constant stream of messages in 
    registered message queues.
  - Fixed exception handling in the thread pool.
- New demos:
  - 43_InvokeAnonymous: Demo for IOmniTaskControl.Invoke and IOmniTask.Invoke.
  - 44_Fork-Join QuickSort: QuickSort implemented with Parallel.ForkJoin.
  - 45_Fork-Join max: Selecting maximum element in an array using Parallel.ForkJoin.
  - 46_Async: Demo for Parallel.Async.
  - 47_TaskConfig: Demo for Parallel.TaskConfig.

2.0: 2010-12-10
- New high-level primitives (unit OtlParallel):
  - Improved parallel for (Parallel.ForEach).
  - Futures (Parallel.Future<T>).
  - Pipelines (Parallel.Pipeline).
- Added support for multiple simultaneous timers. SetTimer takes additional 'timerID'
  parameter. The old SetTimer assumes timerID = 0.
- IOmniTask/IOmniTaskControl:
  - ParamByName has been removed, use .Param[name: string].
  - Param returns TOmniValueContainter.
- IOmniTaskControl.OnMessage also accepts an object (message dispatcher; form, for example)
- TOmniValueContainer:
  - IndexOfName renamed to TOmniValueContainer.IndexOf.
  - New methods in TOmniValueContainer class: ByName, Count, Exists. New properties:
    Items[integer], Items[string] and Items[TOmniValue].
- TOmniValue:
  - Fixed memory leak when sending String, WideString, Variant and Extended values over
    the communication channel and when queueing them into TOmni[Base]Queue.
  - Implemented _AddRef, _Release, _ReleaseAndClear.
  - TOmniValue can be cast as Int64.
  - Implemented conversions to/from TValue (Delphi 2010 and newer).
  - Implemented constructor.
  - [scarre] Added TDateTime support.
- New classes and interfaces:
  - TOmniMessageQueueTee
  - IOmniCommDispatchingObserver
  - TOmniCounter, auto-initialized wrapper around the IOmniCounter
  - TOmniMessageID record, used internally to implement timers.
- TOmniThreadPool: ThreadDataFactory can now accept either a function or a method
  (but can be used only as a method - SetThreadDataFactory).
- TOmniEventMonitor: Message retrieving loop destroys interface immediately, not when the
  next message is received.
- TOmniTaskFunction renamed to TOmniTaskDelegate.
- Added function CreateResourceCount(initialCount): IOmniResourceCount.
- Renamed IOmniCancellationToken.IsSignaled -> IsSignalled.
- .dproj tests renamed to .2007.dproj.
- Added Delphi XE project files.
- Bugs fixed:
  - Thread pool was immediately closing unused threads if MaxExecuting was set to -1.
  - Ugly bugs in TOmniBlockingCollection removed.
- new demos:
  38_OrderedFor: Ordered parallel for loops.
  39_Future: Futures.
  40_Mandelbrot: Parallel graphics demo (very simple).
  41_Pipeline: Pipelines.
  42_MessageQueue: Stress tests for TOmniMessageQueue.

1.05a: 2010-03-08
- Bug fixed: TOmniTaskControl.OnMessage(eventHandler: TOmniTaskMessageEvent) 
  was broken.
- Bug fixed: TOmniTaskControl.OnMessage/OnTerminate uses event monitor 
  created in the context of the task controller thread (was using global 
  event monitor created in the main thread).
- Implemented TOmniEventMonitorPool, per-thread TOmniEventMonitor allocator.

1.05: 2010-02-25
- Big rename: TOmniBaseStack -> TOmniBaseBoundedStack,
  TOmniStack -> TOmniBoundedStack, TOmniBaseQueue -> TOmniBaseBoundedQueue,
  TOmniQueue -> TOmniBoundedQueue, IInterfaceDictionary -> IOmniInterfaceDictionary,
  IInterfaceDictionaryEnumerator -> IOmniInterfaceDictionaryEnumerator,
  TInterfaceDictionaryPair -> TOmniInterfaceDictionaryPair.
- Implemented dynamically allocated, O(1) enqueue and dequeue, threadsafe,
  microlocking queue. Class TOmniBaseQueue contains base implementation
  while TOmniQueue adds notification support.
- Implemented resource counter with empty state signalling TOmniResourceCount.
- New unit OtlCollection which contains blocking collection implementation
  TOmniBlockingCollection.
- IOmniTask implements Implementor property which points back to the worker instance
  (but only if worker is TOmniWorker-based).
- Implemented IOmniEnvironment interface and function Environment returning
  some information on system, process and thread.
- Implemented IOmniTaskControl.UserData[]. The application can store any values
  in this array. It can be accessed via the integer or string index.
- Implemented TOmniValue.IsInteger.
- Implemented IOmniCancellationToken, used in Parallel infrastructure and in
  IOmniTaskControl.TerminateWhen.
- IOmniTaskControl and IOmniTask implement CancellationToken: IOmniCancellationToken
  property which can be used by the task and task controller.
- IOmniTaskControl implements OnMessage(msgID, handler).
- Implemented Parallel.ForEach wrapper (Delphi 2009 and newer).
- Implemented Parallel.Join wrapper (Delphi 2009 and newer).
- Refactored and enhanced TOmniValueContainer.
- TOmniTaskFunction now takes 'const' parameter.
- Bugs fixed:
  - TOmniEventMonitor.OnTaskUndeliveredMessage was missing 'message' parameter.
  - Set package names and designtime/runtime type in D2009/D2010 packages.
- New demos:
  - 32_Queue: Stress test for new TOmniBaseQueue and TOmniQueue.
  - 33_BlockingCollection: Stress test for new TOmniBlockingCollection, also demoes
    the use of Environment to set process affinity.
  - 34_TreeScan: Parallel tree scan using TOmniBlockingCollection.
  - 35_ParallelFor: Parallel tree scan using Parallel.ForEach (Delphi 2009 and newer).
  - 36_ParallelAggregate: Parallel calculations using Parallel.ForEach.Aggregate
    (Delphi 2009 and newer).
  - 37_ParallelJoin: Parallel.Join demo.

1.04b: 2009-12-18
- [ahwux, gabr] Fixed Delphi 2010 Update 4 compatibility.
- [ahwux] Added missing task interface cleanup to OnTerminated in demo 18.

1.04a: 2009-12-13
- IMPORTANT: Fixed thread pool exception handling.
- Implemented IOmniTask.RegisterWaitObject/UnregisterWaitObject.
- Added demo 31_WaitableObjects: Demo for the new RegisterWaitObject/UnregisterWaitObject API.
- Current versions of 3rd party units included.

1.04: 2009-11-23
*** COMPATIBILITY ISSUES ***
  *** Changed semantics in comm event notifications! When you get the 'new message'
      event, read all messages from the queue in a loop!
  *** Message is passed to the TOmniEventMonitor.OnTaskMessage handler. There's no need
      to read from Comm queue in the handler.
  *** Exceptions in tasks are now visible by default. To hide them, use
      IOmniTaskControl.SilentExceptions. Test 13_Exceptions was improved to demonstrate
      this behaviour.
- Works with Delphi 2010.
- Default communication queue size reduced to 1000 messages.
- Support for 'wait and send' in IOmniCommunicationEndpoint.SendWait.
- Communication subsystem implements observer pattern.
- WideStrings can be send over the communication channel.
- New event TOmniEventMonitor.OnTaskUndeliveredMessage is called after the task is
  terminated for all messages still waiting in the message queue.
- Implemented automatic event monitor with methods IOmniTaskControl.OnMessage and
  OnTerminated. Both support 'procedure of object' and 'reference to procedure'
  parameters.
- Implemented IOmniTaskControl.Unobserved behaviour modifier.
- New unit OtlSync contains (old) TOmniCS and IOmniCriticalSection together with (new)
  TOmniMREW - very simple and extremely fast multi-reader-exclusive-writer - and atomic
  CompareAndSwap functions.
- New unit OtlHooks contains API that can be used by external libraries to hook into
  OTL thread creation/destruction process and into exception chain.
- All known bugs fixed.
- Current versions of 3rd party units included.
- New demos:
  - 25_WaitableComm: Demo for ReceiveWait and SendWait.
  - 26_MultiEventMonitor: How to run multiple event monitors in parallel.
  - 27_RecursiveTree: Parallel tree processing.
  - 28_Hooks: Demo for the new hook system.
  - 29_ImplicitEventMonitor: Demo for OnMessage and OnTerminated, named method approach.
  - 30_AnonymousEventMonitor: Demo for OnMessage and OnTerminated, anonymous method approach.

1.03: 2009-02-08
- Added support for per-thread initialized data to the thread pool.
- Communication between TOmniThreadPool and TOTPWorker is protected with a critical 
  section. That allows multiple threads to Schedule tasks into one thread pool.
- Removed OnWorkerThreadCreated_Asy/OnWorkerThreadDestroyed_Asy thread pool 
  notification mechanism which was pretty much useless.
- Added connection pool demo.

1.02: 2009-02-01
- Thread pool reimplemented using OmniThreadLibrary.
- Implemented IOmniTaskControl/IOmniTask.Enforced behaviour modifier.
- Implemented IOmniTaskControlList, a list of IOmniTaskControl interfaces.
- Added background file search demo.
- Implemented TOmniCS critical section wrapper.
- Fixed a bug in TGpStringTable.Grow and TGpStringDictionary.Grow which 
  caused random memory overwrites.
- Bug fixed: One overload of SetParameter was not returning Self.
- [Jamie] Fixed bug in TOmniTaskExecutor.Asy_SetTimerInt.
- [ajasja] Fixed bug in demos 4, 5, and 6. Exceptions was raised if demo app
  was closed without stopping the background task first.
- Updated to FastMM 4.90.
- Current versions of 3rd party units included.

1.01: 2008-11-01
- [GJ] Redesigned stack cotainer with better lock contention.
- [GJ] Totally redesigned queue container, which is no longer based on stack and 
  allows multiple reader.
- Full D2009 support; D2009 packages, project files and Tests project group.
- Invoke-by-name and invoke-by-address messaging implemented
  (http://17slon.com/blogs/gabr/2008/10/erlangenizing-omnithreadlibrary.html and
  http://17slon.com/blogs/gabr/2008/10/omnithreadlibrary-using-rtti-to-call.html
  and demos 18 and 19).
- CreateTask(reference to function (task: ITaskControl)) implemented (D2009 only).
- Blocking wait (ReceiveWait) implemented (demo 19).
- Added enumerator to the IOmniTaskGroup interface.
- Implemented IOmniTaskGroup.RegisterAllWithTask and .UnregisterAllFromTask.
- Added automatic comm unregistration for IOmniTaskGroup.RegisterAllCommWith.
- Implemented IOmniTaskGroup.SendToAll. 
- New/updated tests/demos:
  - 10_Containers 
    - 2 -> 2, 1 -> 4 and 4 -> 4 tests for stacks and queues, 
    - [1, 2, 4] -> [1, 2, 4] full tests.
    - Writes CSV file with cumulative test results.
  - 17_MsgWait: demo for the .MsgWait behaviour modifier.
  - 18_StringMsgDispatch: Invoke demo.
  - 19_StringMsgBenchmark: Invoke benchmark, ReceiveWait demo.
  - 20_QuickSort: Parallel quicksort demo.
  - 21_Anonymous_methods: Anonymous methods demo (D2009 only).
- Message ID $FFFF is now reserved for internal purposes.
- Better default queue length calculation that takes into account OtlContainers 
  overhead and FastMM4 granulation.
- Bug fixed: TOmniValue.Null was not really initialized to Null.
- Bug fixed: Setting timer interval resets timer countdown.
- Bug fixed: TOmniTaskControl.Schedule always scheduled task to the global 
  thread pool.
- Current versions of 3rd party units included.

1.0a: 2008-09-02
- TGp4AlignedInt from GpStuff.pas is supposedly D2006 compatible (says a reader) 
  so it has been enabled on that plaform. As a result, it is now possible to 
  compiled and use OTL in D2006 (said the same source).
- SpinLock.pas has been updated.
- Test 6 has been changed to show why one would want to use 
  IOmniWorker.Implementor function.
- FastMM 4.88 included in the repository to simplify debugging.
  FastMM4 was created by Pierre le Riche and is not covered by the 
  OmniThreadLibrary license. It is released under a dual licensed and you can use 
  it either under the MPL 1.1 or LGPL 2.1. More details in the included readme 
  file and on the FastMM4 home page.

1.0: 2008-08-26
- Initial release.