-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathlisting17.html
executable file
·592 lines (493 loc) · 21.2 KB
/
listing17.html
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>ThreadsImporter - /WorkerThread.c</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/QuickTime/index.html">QuickTime</a> > <a href="../../samplecode/QuickTime/idxCocoa-date.html">Cocoa</a> > <A HREF="javascript:location.replace('index.html');">ThreadsImporter</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">ThreadsImporter</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/WorkerThread.c</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/AutoRunSettings.h</option>
<option value="listing2.html">/AutoRunSettings.m</option>
<option value="listing3.html">/DataRefUtilities.c</option>
<option value="listing4.html">/DataRefUtilities.h</option>
<option value="listing5.html">/FileObject.h</option>
<option value="listing6.html">/FileObject.m</option>
<option value="listing7.html">/main.m</option>
<option value="listing8.html">/MyDocument.h</option>
<option value="listing9.html">/MyDocument.m</option>
<option value="listing10.html">/MyQuickDrawView.h</option>
<option value="listing11.html">/MyQuickDrawView.m</option>
<option value="listing12.html">/QTDataRef.c</option>
<option value="listing13.html">/QTDataRef.h</option>
<option value="listing14.html">/ThreadData.h</option>
<option value="listing15.html">/URLUtilities.c</option>
<option value="listing16.html">/URLUtilities.h</option>
<option value="listing17.html">/WorkerThread.c</option>
<option value="listing18.html">/WorkerThread.h</option></select>
</p>
</form>
<p><strong><a href="ThreadsImporter.zip">Download Sample</a></strong> (“ThreadsImporter.zip”, 218.2K)<BR>
<strong><a href="ThreadsImporter.dmg">Download Sample</a></strong> (“ThreadsImporter.dmg”, 282.3K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
File: WorkerThread.c
Description: Sample code showing how to send messages between the main thread and a worker pthread.
You could have an instance of this worker pthread interface for each window, for example.
Author: QTEngineering, era
Copyright: © Copyright 2003-2004 Apple Computer, Inc. All rights reserved.
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Computer, Inc.
("Apple") in consideration of your agreement to the following terms, and your
use, installation, modification or redistribution of this Apple software
constitutes acceptance of these terms. If you do not agree with these terms,
please do not use, install, modify or redistribute this Apple software.
In consideration of your agreement to abide by the following terms, and subject
to these terms, Apple grants you a personal, non-exclusive license, under Apple's
copyrights in this original Apple software (the "Apple Software"), to use,
reproduce, modify and redistribute the Apple Software, with or without
modifications, in source and/or binary forms; provided that if you redistribute
the Apple Software in its entirety and without modifications, you must retain
this notice and the following text and disclaimers in all such redistributions of
the Apple Software. Neither the name, trademarks, service marks or logos of
Apple Computer, Inc. may be used to endorse or promote products derived from the
Apple Software without specific prior written permission from Apple. Except as
expressly stated in this notice, no other rights or licenses, express or implied,
are granted by Apple herein, including but not limited to any patent rights that
may be infringed by your derivative works or by other works in which the Apple
Software may be incorporated.
The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
COMBINATION WITH YOUR PRODUCTS.
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT
(INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Change History (most recent first): <1> dts 11/06/03 minor fixes for initial release
*/
//////////
//
// header files
//
//////////
#include <pthread.h>
#include <semaphore.h>
#include <stddef.h> // for offsetof() macro
// Enqueue etc. are in OSUtils.h
// TestAndSet etc. and IncrementAtomic etc. are in DriverSynchronization.h
// EventLoopTimer APIs are in CarbonEventsCore.h
#include <Carbon/Carbon.h>
#include <QuickTime/QuickTime.h>
#include "WorkerThread.h"
//////////
//
// data structures
//
//////////
typedef struct WorkerThread {
SInt32 referenceCount;
WorkerActionRoutine actionRoutine;
WorkerCancelRoutine cancelRoutine;
WorkerResponseMainThreadCallback responseCallback;
void * refcon;
SInt32 numberOfActiveRequests; // number of requests that have been created but not yet released
pthread_t workerThread;
//POSIX sem_t shutdownSemaphore;
//POSIX sem_t requestSemaphore;
MPSemaphoreID shutdownSemaphore;
MPSemaphoreID requestSemaphore;
QHdr requestQueue; // messages going from main thread to worker thread
EventLoopTimerUPP responseEventLoopTimerUPP;
EventLoopTimerRef responseEventLoopTimer;
QHdr responseQueue; // messages going from worker thread to main thread
UInt8 responseQueueArmed;
Boolean shutdown; // set to ask worker thread to shut down when all request queue is empty
long osVersion; // the OS version we are running on
} WorkerThread;
typedef struct WorkerRequest {
SInt32 referenceCount;
WorkerThreadRef worker; // note: each active request maintains a reference to its worker
QElemPtr nextRequest; // used when linked into worker->requestQueue
QElemPtr nextResponse; // used when linked into worker->responseQueue
Boolean wasSent;
Boolean wasCancelled;
Boolean wasStartedOrCancelled;
Boolean actionFinished;
// add client-use fields here
FSRef fileRef;
UInt32 doc;
ThreadData *threadData;
} WorkerRequest;
//////////
//
// function prototypes
//
//////////
static void *runWorkerThread ( void *argWorkerThreadRef );
static void runWorkerResponseEventLoopTimer ( EventLoopTimerRef timer, void *refcon );
#pragma mark-
//////////
//
// worker thread routines
//
//////////
OSErr createWorkerThread (
WorkerActionRoutine actionRoutine,
WorkerCancelRoutine cancelRoutine,
WorkerResponseMainThreadCallback responseCallback,
void *refcon,
WorkerThreadRef *outWorker )
{
WorkerThreadRef worker;
if ( !actionRoutine || !responseCallback || !outWorker ) return paramErr;
worker = calloc( 1, sizeof( WorkerThread ) );
if ( ! worker ) return memFullErr;
worker->referenceCount = 1;
worker->actionRoutine = actionRoutine;
worker->cancelRoutine = cancelRoutine;
worker->responseCallback = responseCallback;
worker->refcon = refcon;
// get the OS version
Gestalt(gestaltSystemVersion, &worker->osVersion);
// create a one-shot event loop timer
worker->responseEventLoopTimerUPP = NewEventLoopTimerUPP( runWorkerResponseEventLoopTimer );
InstallEventLoopTimer( GetMainEventLoop(), kEventDurationForever, kEventDurationForever,
worker->responseEventLoopTimerUPP, worker, &worker->responseEventLoopTimer );
// sem_init() not yet implemented as of MacOS X 10.3 - so we're going to use the MP APIs instead
// the POSIX calls we could use when sem_init() is supported are clearly marked with the POSIX prefix
// Named semaphors are available but not really ideal for our needs in this sample
// Reference: http://developer.apple.com/documentation/Carbon/Reference/Multiprocessing_Services/multiproc_ref/function_group_3.html
//POSIX sem_init( &worker->requestSemaphore, 0 /* not shared */, 0 /* initial value */ );
//POSIX sem_init( &worker->shutdownSemaphore, 0 /* not shared */, 0 /* initial value */ );
MPCreateSemaphore(1, 0, &worker->requestSemaphore);
MPCreateSemaphore(1, 0, &worker->shutdownSemaphore);
pthread_create( &worker->workerThread, NULL, runWorkerThread, worker );
*outWorker = worker;
return noErr;
}
void retainWorkerThread ( WorkerThreadRef worker )
{
if ( !worker ) return;
IncrementAtomic( &worker->referenceCount );
}
void releaseWorkerThread ( WorkerThreadRef worker )
{
if ( !worker ) return;
if ( 1 == DecrementAtomic( &worker->referenceCount ) ) {
if ( 0 != worker->numberOfActiveRequests ) {
DebugStr("\preleaseWorkerThread: reference count went to zero, but there are still active requests" );
}
ExitMoviesOnThread();
pthread_detach( worker->workerThread );
// ask worker thread to clean up and exit
worker->shutdown = true;
//POSIX sem_post( &worker->requestSemaphore );
//POSIX sem_post( &worker->shutdownSemaphore ); // avoid race condition where busy thread disposes requestSemaphore before we post to it
MPSignalSemaphore(worker->requestSemaphore);
MPSignalSemaphore(worker->shutdownSemaphore); // avoid race condition where busy thread disposes requestSemaphore before we post to it
}
}
#pragma mark-
//////////
//
// worker request routines
//
//////////
OSErr createWorkerRequest (
WorkerThreadRef worker,
WorkerRequestRef *outRequest )
{
if ( !outRequest ) return paramErr;
WorkerRequestRef request = calloc( 1, sizeof( WorkerRequest ) );
if ( !request ) return memFullErr;
request->referenceCount = 1;
request->worker = worker;
IncrementAtomic( &worker->numberOfActiveRequests );
retainWorkerThread( worker );
*outRequest = request;
return noErr;
}
static void *runWorkerThread ( void *argWorkerThreadRef )
{
WorkerThreadRef worker = argWorkerThreadRef;
// protect this thread from calling non-thread-safe components
EnterMoviesOnThread(0);
while ( true ) {
// handle all queued requests, then wait on the semaphore
QElemPtr requestElem = worker->requestQueue.qHead; // NULL, or the address of a nextRequest field in a WorkerRequest
if ( requestElem ) {
WorkerRequestRef request = (WorkerRequestRef)((long)requestElem - offsetof(WorkerRequest, nextRequest));
Dequeue( requestElem, &worker->requestQueue );
if ( request->worker != worker ) {
DebugStr("\prunWorkerThread: bad request in requestQueue" );
continue;
}
if ( TestAndSet( 0, &request->wasStartedOrCancelled ) ) {
// this request was cancelled.
request->wasCancelled = true;
}
else {
// this request was not cancelled. run it.
(*worker->actionRoutine)( worker->refcon, request );
request->actionFinished = true;
}
// queue the request on the response queue.
Enqueue( (QElemPtr)&request->nextResponse, &worker->responseQueue );
if ( 0 == TestAndSet( 0, &worker->responseQueueArmed ) ) {
SetEventLoopTimerNextFireTime( worker->responseEventLoopTimer, kEventDurationNoWait );
}
}
else if( worker->shutdown ) {
// go peacefully
break;
}
else {
//POSIX sem_wait( &worker->requestSemaphore );
MPWaitOnSemaphore(worker->requestSemaphore, kDurationForever);
}
}
// wait so that we can be sure that the main thread is done signalling requestSemaphore.
//POSIX sem_wait( &worker->shutdownSemaphore );
MPWaitOnSemaphore(worker->shutdownSemaphore, kDurationForever);
// clean up.
//POSIX sem_destroy( &worker->requestSemaphore );
//POSIX sem_destroy( &worker->shutdownSemaphore );
MPDeleteSemaphore(worker->requestSemaphore);
MPDeleteSemaphore(worker->shutdownSemaphore);
RemoveEventLoopTimer( worker->responseEventLoopTimer );
DisposeEventLoopTimerUPP( worker->responseEventLoopTimerUPP );
free( worker );
return NULL;
}
static void runWorkerResponseEventLoopTimer ( EventLoopTimerRef timer, void *refcon )
{
WorkerThreadRef worker = refcon;
while ( TestAndClear( 0, &worker->responseQueueArmed ) ) {
QElemPtr responseElem = worker->responseQueue.qHead; // NULL, or the address of a nextResponse field in a WorkerRequest
while ( responseElem ) {
WorkerRequestRef request = (WorkerRequestRef)((long)responseElem - offsetof(WorkerRequest, nextResponse));
Dequeue( responseElem, &worker->responseQueue );
// run the response callback.
(*worker->responseCallback)( worker->refcon, request );
// (note that the response callback may release the request)
responseElem = worker->responseQueue.qHead;
}
}
}
#pragma mark-
// accessors
OSErr setWorkerRequestFile (
WorkerRequestRef request,
FSRef fileRef )
{
if ( !request ) return paramErr;
request->fileRef = fileRef;
return noErr;
}
OSErr getWorkerRequestFile (
WorkerRequestRef request,
FSRef *fileRef )
{
if (( !request ) || ( !fileRef ) ) return paramErr;
*fileRef = request->fileRef;
return noErr;
}
OSErr setWorkerRequestDoc (
WorkerRequestRef request,
UInt32 doc )
{
if ( !request ) return paramErr;
request->doc = doc;
return noErr;
}
OSErr getWorkerRequestDoc (
WorkerRequestRef request,
UInt32 *doc )
{
if (( !request ) || ( !doc ) ) return paramErr;
*doc = request->doc;
return noErr;
}
OSErr setWorkerRequestThreadData (
WorkerRequestRef request,
ThreadData *threadData )
{
if ( !request ) return paramErr;
request->threadData = threadData;
return noErr;
}
OSErr getWorkerRequestThreadData (
WorkerRequestRef request,
ThreadData **threadDataPtr )
{
if (( !request ) || ( !threadDataPtr ) ) return paramErr;
*threadDataPtr = request->threadData;
return noErr;
}
// add more accessors as you like
#pragma mark-
OSErr sendWorkerRequest ( WorkerRequestRef request )
{
if ( !request ) return paramErr;
if ( request->wasSent ) {
DebugStr("\psendWorkerRequest: request was already sent");
return paramErr;
}
request->wasSent = true;
Enqueue( (QElemPtr)&request->nextRequest, &request->worker->requestQueue );
//POSIX sem_post( &request->worker->requestSemaphore );
MPSignalSemaphore(request->worker->requestSemaphore);
return noErr;
}
void cancelWorkerRequest ( WorkerRequestRef request )
{
if ( !request ) return;
if ( !request->wasSent ) {
DebugStr("\pcancelWorkerRequest: request was not sent");
return;
}
if ( request->wasCancelled ) {
DebugStr("\pcancelWorkerRequest: request was already cancelled");
return;
}
if ( TestAndSet( 0, &request->wasStartedOrCancelled ) ) {
// request has already started
if ( request->actionFinished ) {
// request has already finished: nothing we can do
}
else {
// request action routine is currently running: call the cancel function, if set
request->wasCancelled = true;
if ( request->worker->cancelRoutine )
(*request->worker->cancelRoutine)( request->worker->refcon, request );
}
}
else {
// request had not yet started, and by setting wasStartedOrCancelled we've cancelled it
request->wasCancelled = true;
}
}
Boolean wasWorkerRequestCancelled ( WorkerRequestRef request )
{
if ( !request ) return false;
return request->wasCancelled;
}
void releaseWorkerRequest ( WorkerRequestRef request )
{
if ( 1 == DecrementAtomic( &request->referenceCount ) ) {
DecrementAtomic( &request->worker->numberOfActiveRequests );
releaseWorkerThread( request->worker );
free( request );
}
}
void retainWorkerRequest ( WorkerRequestRef request )
{
IncrementAtomic( &request->referenceCount );
}
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/ThreadsImporter/listing17.html%3Fid%3DDTS10003146-1.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/ThreadsImporter/listing17.html%3Fid%3DDTS10003146-1.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/ThreadsImporter/listing17.html%3Fid%3DDTS10003146-1.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>