-
Notifications
You must be signed in to change notification settings - Fork 3
/
listing10.html
executable file
·643 lines (521 loc) · 27 KB
/
listing10.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
<!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>OTMP - /MoreOpenTransport/OTMP.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/Carbon/index.html">Carbon</a> > <a href="../../samplecode/Carbon/idxNetworking-date.html">Networking</a> > <A HREF="javascript:location.replace('index.html');">OTMP</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 -->
<div style="width:100%; position:fixed;"><div align="center" id="watermark" style="position: relative; margin-left:auto; margin-right:auto; z-index:20; width:500px;"><div class="legacybox"><h1>Not Recommended Document<span class=closebutton><a href="javascript:closeWatermark()"><img src="../../images/closebutton.png" width="14" height="14" border="0" alt="close button"></a></span></h1>
<p><strong>Important: </strong>The information in this document is <strong>Not Recommended</strong> and should not be used for new development.</p>
<div class="reflibtopic">
<p>Current information on this Reference Library topic can be found here:</p>
<ul>
<li><a href="http://developer.apple.com/referencelibrary/Carbon/idxNetworking-date.html" target="_blank">Carbon > Networking</a></li>
</ul>
</div>
</div></div></div>
<!-- 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">OTMP</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>/MoreOpenTransport/OTMP.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">/MIB_Carbon.h</option>
<option value="listing2.html">/MoreMemory/MoreMemory.c</option>
<option value="listing3.html">/MoreMemory/MoreMemory.h</option>
<option value="listing4.html">/MoreMultiprocessing/MoreBlueActions.c</option>
<option value="listing5.html">/MoreMultiprocessing/MoreBlueActions.h</option>
<option value="listing6.html">/MoreMultiprocessing/MoreMPLog.c</option>
<option value="listing7.html">/MoreMultiprocessing/MoreMPLog.h</option>
<option value="listing8.html">/MoreOpenTransport/OTClassicContext.h</option>
<option value="listing9.html">/MoreOpenTransport/OTMP.c</option>
<option value="listing10.html">/MoreOpenTransport/OTMP.h</option>
<option value="listing11.html">/MoreOpenTransport/OTMPSimpleServerHTTP/OTMPSimpleServerHTTP.c</option>
<option value="listing12.html">/MoreOpenTransport/OTMPSimpleServerHTTP/OTMPSimpleServerHTTP.h</option>
<option value="listing13.html">/MoreOpenTransport/OTMPSimpleServerHTTP/OTMPSimpleServerHTTPTest.c</option>
<option value="listing14.html">/MoreOpenTransport/OTMPSimpleServerHTTP/OTMPSimpleServerHTTPTest.r</option>
<option value="listing15.html">/MoreOpenTransport/OTMPSimpleServerHTTP/Sample HTTP Source/index.html</option>
<option value="listing16.html">/MoreOpenTransport/Read_Me_About_OTMP.html</option>
<option value="listing17.html">/MoreProcesses/MoreProcesses.cp</option>
<option value="listing18.html">/MoreProcesses/MoreProcesses.h</option>
<option value="listing19.html">/MoreSetup.h</option></select>
</p>
</form>
<p><strong><a href="OTMP.zip">Download Sample</a></strong> (“OTMP.zip”, 808.3K)<BR>
<strong><a href="OTMP.dmg">Download Sample</a></strong> (“OTMP.dmg”, 1.20M)</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: OTMP.h Contains: MP task friendly OT library. Written by: Quinn Copyright: Copyright © 2000 by 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): <7> 21/9/01 Quinn Changes for CWPro7 Mach-O build. <6> 8/2/01 Quinn [2619462] The fix for the MP bug is in CarbonLib 1.2.5. <5> 8/2/01 Quinn Add missing word to comment. <4> 8/2/01 Quinn Add OTMPGetMessage and OTMPPutMessage. <3> 5/12/00 Quinn Looks like the bug fix won't make it into CarbonLib 1.2. <2> 10/11/00 Quinn Added OTMPGetCanRunStatus. <1> 7/11/00 Quinn First checked in.*/#pragma once/////////////////////////////////////////////////////////////////// MoreIsBetter Setup#include "MoreSetup.h"// Mac OS Interfaces#if ! MORE_FRAMEWORK_INCLUDES #include <OpenTransport.h>#endif/////////////////////////////////////////////////////////////////#ifdef __cplusplusextern "C" {#endiftypedef UInt32 OTMPCanRunStatus;enum { kOTMPCanRun = 0, kOTMPSystemTooOld = 1, kOTMPBadCarbon = 2};extern pascal OTMPCanRunStatus OTMPGetCanRunStatus(void); // This routine returns a value of type OTMPCanRunStatus // that indicates whether OTMP can run and, if not, why // it can't. Note that OTMP refuses to run if a CarbonLib // older than version 1.2.5 is installed. This is because a // bug in older versions of CarbonLib [2563553] prevents // MP tasks from using DTInstall (even those linked against // InterfaceLib).// This module logs its activities to MoreMPLog. You can control which // bit in the log mask it uses (see "MoreMPLog.h" for a discussion of the // log mask) by changing this constant.enum { kOTMPWaitRecordLogID = 1, kOTMPNotificationLogID = 2, kOTMPStdActionLogID = 3, kOTMPAPILogID = 4, kOTMPRetriesLogID = 5};// OTMPProviderRef is reference to a private structure defined inside this module.typedef struct OTMPProvider OTMPProvider;typedef OTMPProvider *OTMPProviderRef;// Like OT itself, OTMP supports a limited degree of polymorphism. Specifically, // OTMPEndpointRef is a subclass of OTMPProviderRef. This structure is hard to // represent in C, so we just equate the two types.typedef OTMPProviderRef OTMPEndpointRef;extern pascal OSStatus InitOpenTransportMPInContext( OTInitializationFlags flags, OTClientContextPtr * clientContext); // You must call this routine at system task time.extern pascal void CloseOpenTransportMPInContext(OTClientContextPtr clientContext); // You must call this routine at system task time.extern pascal OSStatus OTMPPrepareThisTask(void); // You must call this from each MP task that is to call // this library. You must not call it for the main thread // (or any other cooperative thread).extern pascal void OTMPUnprepareThisTask(void); // You must call this from each MP task that you have // prepared using OTMPPrepareThisTask before the task quits. // This routine does not require that the preparation have // been successful (or even to have occured at all), so you // can safely call it at the end of any MP task that might // have called OTMPPrepareThisTask.extern pascal OTMPEndpointRefOTMPOpenEndpointQInContext (const char * cfig, OTOpenFlags oflag, TEndpointInfo * info, OSStatus * errPtr, OTClientContextPtr clientContext); // This "quick" version of OTOpenEndpoint uses a configuration // string rather than a OTConfigurationRef. I haven't // yet implemented the real routine because I'm still trying // to decide how to handle OTCreateConfiguration. The obvious // approach would require two round trips from MP to blue, which // is unnecessarily slow. The main advantage of using // a configuration is that you can create endpoints quickly by // creating a single configuration and cloning it each time you // create an endpoint. This speeds up endpoint creation a little. // However, if your application is creating lots of endpoints you // will get a much better speed increase by maintaining a cache of // created endpoints. // // Regardless, this routine is just fine for 99% of clients. extern pascal OSStatusOTMPCloseProvider (OTMPProviderRef ref);extern pascal SInt32OTMPIoctl (OTMPProviderRef ref, UInt32 cmd, void * data);extern pascal OSStatusOTMPCancelSynchronousCalls (OTMPProviderRef ref, OSStatus errParam);extern pascal OSStatusOTMPGetEndpointInfo (OTMPEndpointRef ref, TEndpointInfo * info);extern pascal OTResultOTMPGetEndpointState (OTMPEndpointRef ref);extern pascal OTResultOTMPLook (OTMPEndpointRef ref);extern pascal OTResultOTMPCountDataBytes (OTMPEndpointRef ref, OTByteCount * countPtr);extern pascal OSStatusOTMPGetProtAddress (OTMPEndpointRef ref, TBind * boundAddr, /* can be NULL */ TBind * peerAddr) /* can be NULL */;extern pascal OSStatusOTMPResolveAddress (OTMPEndpointRef ref, TBind * reqAddr, TBind * retAddr, OTTimeout timeOut);extern pascal OSStatusOTMPBind (OTMPEndpointRef ref, TBind * reqAddr, /* can be NULL */ TBind * retAddr) /* can be NULL */;extern pascal OSStatusOTMPUnbind (OTMPEndpointRef ref);extern pascal OSStatusOTMPConnect (OTMPEndpointRef ref, TCall * sndCall, TCall * rcvCall) /* can be NULL */;extern pascal OSStatusOTMPListen (OTMPEndpointRef ref, TCall * call);extern pascal OSStatusOTMPAccept (OTMPEndpointRef listener, OTMPEndpointRef worker, TCall * call); // The implementation of this routine has a race condition which // might be exposed if the worker endpoint is active (ie there are // outstanding synchronous operations on the endpoint). Rather than // fix the problem (which would require a major rework of the // library's global concurrency model), I've decided to outlaw this // behaviour. You must call this routine only with worker endpoints // that are quiescent (ie have no outstanding synchronous operations). // // See the comments in the implementation for details. extern pascal OSStatusOTMPSndDisconnect (OTMPEndpointRef ref, TCall * call) /* can be NULL */;extern pascal OSStatusOTMPRcvDisconnect (OTMPEndpointRef ref, TDiscon * discon) /* can be NULL */;extern pascal OSStatusOTMPSndOrderlyDisconnect (OTMPEndpointRef ref);extern pascal OSStatusOTMPRcvOrderlyDisconnect (OTMPEndpointRef ref);extern pascal OSStatusOTMPOptionManagement (OTMPEndpointRef ref, TOptMgmt * req, TOptMgmt * ret);extern pascal OTResultOTMPRcv (OTMPEndpointRef ref, void * buf, OTByteCount nbytes, OTFlags * flags);extern pascal OTResultOTMPSnd (OTMPEndpointRef ref, void * buf, OTByteCount nbytes, OTFlags flags);extern pascal OSStatusOTMPSndUData (OTMPEndpointRef ref, TUnitData * udata);extern pascal OSStatusOTMPRcvUData (OTMPEndpointRef ref, TUnitData * udata, OTFlags * flags);extern pascal OSStatusOTMPRcvUDErr (OTMPEndpointRef ref, TUDErr * uderr);#if CALL_NOT_IN_CARBON // IMPORTANT: // These routines are a preliminary implementation and have // not yet been tested properly. Specifically, I have not // tested the flow control execution paths. extern pascal OTResult OTMPGetMessage (OTMPProviderRef ref, strbuf * ctlbuf, strbuf * databuf, OTFlags * flagsPtr); extern pascal OSStatus OTMPPutMessage (OTMPProviderRef ref, const strbuf * ctlbuf, const strbuf * databuf, OTFlags flags);#endif/////////////////////////////////////////////////////////////////// Cooperative Threading// During the bring up and debugging effort it's often useful to run // everything from the main thread (or from Thread Manager threads). // To limit OTMP's external dependencies, I allow you to install a // callback that OTMP calls while is waiting for async operations// to complete. You can use this callback to call WaitNextEvent, or // yield time in whatever way is appropriate for your application.// This is very similar to the kOTSyncIdleEvent idea, except that // there is only one callback for the entire library.//// IMPORTANT: You only need to install this callback if you call // OTMP from your application's main thread or a Thread Manager thread. // If you always call OTMP from preemptively scheduled MP tasks this // callback is unnecessary.typedef pascal OSStatus (*OTMPMainThreadYielder)(void); // OTMP calls this routine when it is waiting "sync waiting", // ie waiting for an asynchronous event to complete. The routine // should yield time in whatever way that's appropriate for your // application. // // If the routine returns an error, OTMP will break out of its // sync wait loop. You should only do this under the most dire // circumstances!!! It will leave the entire library in a very // base state. It's useful for breaking out of endless loops while // debugging, and not much else. For production code you should // cancel the synchronous call using OTMPCancelSynchronousCalls.extern pascal void InstallOTMPMainThreadYielder(OTMPMainThreadYielder yielder); // Installs, or removes if yielder is nil, the yielder callback./////////////////////////////////////////////////////////////////// Debugging Stuff#if MORE_DEBUG // The following routines were useful for bringing up OTMP // and may also be useful when debugging your applications. extern void OTMPPrintSndRetryFreqDist(void); // Prints, to stdout, a frequency distribution of the // number of memory retries by OTMPSnd. See the // implementation for more details. extern pascal void RunOTMPAsSystemTasks(Boolean asSystemTasks); // If asSystemTasks is true, the module will run entirely at // system task time. This was very useful when debugging // OTMP but is of limited usefulness you OTMP clients. Call this // routine after initialising the library but before calling // any other library routines. This routine also forces all // Blue tasks to run at system task time (see "MoreBlueActions.h"). // Must be called at system task time. #endif/////////////////////////////////////////////////////////////////// OTMPX// -----// These routines look at the current system version and do the right // thing on both traditional Mac OS (call OTMP) and Mac OS X // (call Mac OS X's built in OT compatibility directly).extern pascal OSStatus InitOpenTransportMPXInContext( OTInitializationFlags flags, OTClientContextPtr * clientContext);extern pascal void CloseOpenTransportMPXInContext(OTClientContextPtr clientContext);extern pascal OSStatus OTMPXPrepareThisTask(void);extern pascal void OTMPXUnprepareThisTask(void);extern pascal OTMPEndpointRefOTMPXOpenEndpointQInContext (const char * cfig, OTOpenFlags oflag, TEndpointInfo * info, OSStatus * errPtr, OTClientContextPtr clientContext); extern pascal OSStatusOTMPXCloseProvider (OTMPProviderRef ref);extern pascal SInt32OTMPXIoctl (OTMPProviderRef ref, UInt32 cmd, void * data);extern pascal OSStatusOTMPXCancelSynchronousCalls (OTMPProviderRef ref, OSStatus errParam);extern pascal OSStatusOTMPXGetEndpointInfo (OTMPEndpointRef ref, TEndpointInfo * info);extern pascal OTResultOTMPXGetEndpointState (OTMPEndpointRef ref);extern pascal OTResultOTMPXLook (OTMPEndpointRef ref);extern pascal OTResultOTMPXCountDataBytes (OTMPEndpointRef ref, OTByteCount * countPtr);extern pascal OSStatusOTMPXGetProtAddress (OTMPEndpointRef ref, TBind * boundAddr, /* can be NULL */ TBind * peerAddr) /* can be NULL */;extern pascal OSStatusOTMPXResolveAddress (OTMPEndpointRef ref, TBind * reqAddr, TBind * retAddr, OTTimeout timeOut);extern pascal OSStatusOTMPXBind (OTMPEndpointRef ref, TBind * reqAddr, /* can be NULL */ TBind * retAddr) /* can be NULL */;extern pascal OSStatusOTMPXUnbind (OTMPEndpointRef ref);extern pascal OSStatusOTMPXConnect (OTMPEndpointRef ref, TCall * sndCall, TCall * rcvCall) /* can be NULL */;extern pascal OSStatusOTMPXListen (OTMPEndpointRef ref, TCall * call);extern pascal OSStatusOTMPXAccept (OTMPEndpointRef listener, OTMPEndpointRef worker, TCall * call);extern pascal OSStatusOTMPXSndDisconnect (OTMPEndpointRef ref, TCall * call) /* can be NULL */;extern pascal OSStatusOTMPXRcvDisconnect (OTMPEndpointRef ref, TDiscon * discon) /* can be NULL */;extern pascal OSStatusOTMPXSndOrderlyDisconnect (OTMPEndpointRef ref);extern pascal OSStatusOTMPXRcvOrderlyDisconnect (OTMPEndpointRef ref);extern pascal OSStatusOTMPXOptionManagement (OTMPEndpointRef ref, TOptMgmt * req, TOptMgmt * ret);extern pascal OTResultOTMPXRcv (OTMPEndpointRef ref, void * buf, OTByteCount nbytes, OTFlags * flags);extern pascal OTResultOTMPXSnd (OTMPEndpointRef ref, void * buf, OTByteCount nbytes, OTFlags flags);extern pascal OSStatusOTMPXSndUData (OTMPEndpointRef ref, TUnitData * udata);extern pascal OSStatusOTMPXRcvUData (OTMPEndpointRef ref, TUnitData * udata, OTFlags * flags);extern pascal OSStatusOTMPXRcvUDErr (OTMPEndpointRef ref, TUDErr * uderr);#ifdef __cplusplus}#endif</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/OTMP/listing10.html%3Fid%3DDTS10000251-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/OTMP/listing10.html%3Fid%3DDTS10000251-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/OTMP/listing10.html%3Fid%3DDTS10000251-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>