-
Notifications
You must be signed in to change notification settings - Fork 3
/
listing17.html
executable file
·315 lines (263 loc) · 12.9 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
<!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>ThreadsExporter - /WorkerThread.h</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/Cocoa/index.html">Cocoa</a> > <a href="../../samplecode/Cocoa/idxQuickTime-date.html">QuickTime</a> > <A HREF="javascript:location.replace('index.html');">ThreadsExporter</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">ThreadsExporter</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.h</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">/ExporterObject.h</option>
<option value="listing6.html">/ExporterObject.m</option>
<option value="listing7.html">/FileObject.h</option>
<option value="listing8.html">/FileObject.m</option>
<option value="listing9.html">/main.m</option>
<option value="listing10.html">/MyDocument.h</option>
<option value="listing11.html">/MyDocument.m</option>
<option value="listing12.html">/ThreadData.h</option>
<option value="listing13.html">/ThreadsExporter_Prefix.h</option>
<option value="listing14.html">/URLUtilities.c</option>
<option value="listing15.html">/URLUtilities.h</option>
<option value="listing16.html">/WorkerThread.c</option>
<option value="listing17.html">/WorkerThread.h</option></select>
</p>
</form>
<p><strong><a href="ThreadsExporter.zip">Download Sample</a></strong> (“ThreadsExporter.zip”, 139.0K)<BR>
<strong><a href="ThreadsExporter.dmg">Download Sample</a></strong> (“ThreadsExporter.dmg”, 185.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.h
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
Copyright: © Copyright 2003 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):
*/
#ifndef WORKER_THREAD_H
#define WORKER_THREAD_H
#include <CoreServices/CoreServices.h>
#include "ThreadData.h"
// This is the interface to a worker thread.
struct WorkerThread;
typedef struct WorkerThread *WorkerThreadRef;
// This encapsulates individual work requests that will be performed by a worker thread.
struct WorkerRequest;
typedef struct WorkerRequest *WorkerRequestRef;
// This is the routine called on the worker thread
typedef void (*WorkerActionRoutine)( void *refcon, WorkerRequestRef request );
// This is a routine that can be called to cancel the current action
// while WorkerActionRoutine is running. (It's not called for requests that are
// cancelled before the action starts.)
/// If there's no way to do that, pass NULL to createWorkerThread instead.
typedef void (*WorkerCancelRoutine)( void *refcon, WorkerRequestRef request );
// This is called on the main thread after a request is completed or cancelled
typedef void (*WorkerResponseMainThreadCallback)( void *refcon, WorkerRequestRef request );
// Call this on the main thread to create a worker thread to run your requests.
OSErr createWorkerThread(
WorkerActionRoutine actionRoutine,
WorkerCancelRoutine cancelRoutine,
WorkerResponseMainThreadCallback responseCallback,
void *refcon,
WorkerThreadRef *outWorker );
// In case you need it.
void retainWorkerThread(
WorkerThreadRef worker );
// Call this on the main thread to release the worker thread.
// This does not block; when when the reference count drops to zero and the worker thread
// has finished all work, it will clean up by itself.
void releaseWorkerThread(
WorkerThreadRef worker );
// Call this from the main thread to create a request object; then set attributes
// of the request object and send it. When the request is done, your responseCallback
// will be called on the main thread. If you want to cancel the request early,
// call cancelWorkerRequest from the main thread. If not cancelled before it finishes,
// the request will be handled by a call to your actionRoutine on the worker thread.
OSErr createWorkerRequest(
WorkerThreadRef worker,
WorkerRequestRef *outRequest );
// These are setters and getters for objects or values that are passed between the
// main thread and worker thread. The messaging code doesn't care about these, and you
// can add whatever extra fields and accessors you want.
// These accessors are not protected; you must prevent your code from manipulating
// a request's objects from the main thread between sending the request and receiving
// the response.
OSErr setWorkerRequestFile(
WorkerRequestRef request,
FSRef fileRef );
OSErr getWorkerRequestFile(
WorkerRequestRef request,
FSRef *fileRef );
OSErr setWorkerRequestDoc(
WorkerRequestRef request,
UInt32 doc );
OSErr getWorkerRequestDoc (
WorkerRequestRef request,
UInt32 *doc );
OSErr setWorkerRequestThreadData (
WorkerRequestRef request,
ThreadData *threadData );
OSErr getWorkerRequestThreadData (
WorkerRequestRef request,
ThreadData **threadDataPtr );
// ++ add more accessors as you like ++
// Call this to schedule the request to be sent to the worker thread.
// The worker thread will process them in first-in, first-out order.
// If you don't want to send the request after all, just release it
// before sending.
OSErr sendWorkerRequest(
WorkerRequestRef request );
// Call this from the main thread to cancel an already-scheduled request.
// If the request has not yet started, the action routine will not be called;
// if the action routine has started running, the cancel routine (if provided)
// will be called. If the action routine has completed, this will have no effect.
void cancelWorkerRequest(
WorkerRequestRef request );
// Call this from your response callback to find out whether the request was cancelled.
Boolean wasWorkerRequestCancelled(
WorkerRequestRef request );
// I'm not sure if clients will ever need to call this, but here it is.
void retainWorkerRequest(
WorkerRequestRef request );
// Call this from your response callback to release the worker request.
// If you don't release requests, you will leak not only the request entries but the worker thread too.
void releaseWorkerRequest(
WorkerRequestRef request );
#endif // WORKER_THREAD_H
</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/ThreadsExporter/listing17.html%3Fid%3DDTS10003171-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/ThreadsExporter/listing17.html%3Fid%3DDTS10003171-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/ThreadsExporter/listing17.html%3Fid%3DDTS10003171-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>