-
Notifications
You must be signed in to change notification settings - Fork 3
/
listing2.html
executable file
·292 lines (243 loc) · 12.2 KB
/
listing2.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
<!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>PortMapper - /PortMapper.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#//apple_ref/doc/uid/TP30000943" target="_top">Reference Library</a> > <a href="../index.html#//apple_ref/doc/uid/TP30000925" target="_top">Sample Code</a> > <a href="../Networking/index.html#//apple_ref/doc/uid/TP30000925-TP30000429" target="_top">Networking</a> > <a href="../Networking/idxBonjour-date.html#//apple_ref/doc/uid/TP30000925-TP30000429-TP30000566">Bonjour</a> > <A HREF="javascript:location.replace('index.html');">PortMapper</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">PortMapper</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>/PortMapper.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">/main.m</option>
<option value="listing2.html">/PortMapper.h</option>
<option value="listing3.html">/PortMapper.m</option>
<option value="listing4.html">/Read Me.txt</option></select>
</p>
</form>
<p><strong><a href="PortMapper.zip">Download Sample</a></strong> (“PortMapper.zip”, 43.2K)<BR>
<strong><a href="PortMapper.dmg">Download Sample</a></strong> (“PortMapper.dmg”, 53.6K)</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: PortMapper.h
Abstract: Objective-C interface to NAT port-mapping functionality.
Version: 1.0
Disclaimer: IMPORTANT: This Apple software is supplied to you by
Apple 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 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.
Copyright © 2007 Apple Inc. All Rights Reserved.
*/
#import <Foundation/Foundation.h>
#import <CoreFoundation/CFSocket.h>
/* PortMapper attempts to make a particular network port on this computer publicly reachable
for incoming connections, by "opening a hole" through a Network Address Translator
(NAT) or firewall that may be in between the computer and the public Internet.
The port mapping may fail if:
* the NAT/router/firewall does not support either the UPnP or NAT-PMP protocols;
* the device doesn't implement the protocols correctly (this happens);
* the network administrator has disabled port-mapping;
* there is a second layer of NAT/firewall (this happens in some ISP networks.)
The PortMapper is asynchronous. It will take a nonzero amount of time to set up the
mapping, and the mapping may change in the future as the network configuration changes.
To be informed of changes, either use key-value observing to watch the "error",
"publicAddress" and "publicPort" properties, or observe the PortMapperChangedNotification.
Typical usage is to:
* Start a network service that listens for incoming connections on a port
* Open a PortMapper
* When the PortMapper reports the public address and port of the mapping, you somehow
notify other peers of that address and port, so they can connect to you.
* When the PortMapper reports changes, you (somehow) notify peers of the changes.
* When closing the network service, close the PortMapper object too.
*/
@interface PortMapper : NSObject
{
UInt16 _port, _desiredPublicPort, _publicPort;
BOOL _mapTCP, _mapUDP;
SInt32 _error;
void* /*DNSServiceRef*/ _service; // Typed void* to avoid having to #include <dnssd.h> in this header
CFSocketRef _socket;
CFRunLoopSourceRef _socketSource;
UInt32 _rawPublicAddress;
NSString *_publicAddress;
}
/** Initializes a PortMapper that will map the given local (private) port.
By default it will map TCP and not UDP, and will not suggest a desired public port,
but this can be configured by setting properties before opening the PortMapper.
*/
- (id) initWithPort: (UInt16)port;
/** Should the TCP or UDP port, or both, be mapped? By default, TCP only.
These properties have no effect if changed while the PortMapper is open. */
@property BOOL mapTCP, mapUDP;
/** You can set this to the public port number you'd like to get.
It defaults to 0, which means "no preference".
This property has no effect if changed while the PortMapper is open. */
@property UInt16 desiredPublicPort;
/** Opens the PortMapper, using the current settings of the above properties.
Returns immediately; you can find out when the mapping is created or fails
by observing the error/publicAddress/publicPort properties, or by listening
for the PortMapperChangedNotification.
It's very unlikely that this call will fail (return NO). If it does, it
probably means that the mDNSResponder process isn't working. */
- (BOOL) open;
/** Blocks till the PortMapper finishes opening. Returns YES if it opened, NO on error.
It's not usually a good idea to use this, as it will lock up your application
until a response arrives from the NAT. Listen for asynchronous notifications instead.
If called when the PortMapper is closed, it will call -open for you.
If called when it's already open, it just returns YES. */
- (BOOL) waitTillOpened;
/** Closes the PortMapper, terminating any open port mapping. */
- (void) close;
/** The following properties are valid only while the PortMapper is open.
They are all KV-observable, or you can listen for a PortMapperChangedNotification.
If error is nonzero, none of the other properties are valid (they'll all be zero/nil.) */
@property (readonly) SInt32 error; // Really DNSServiceErrorType
@property (readonly) UInt32 rawPublicAddress; // IPv4 addr in network byte order (big-endian)
@property (readonly,copy) NSString* publicAddress; // IPv4 dotted-quad string
@property (readonly) unsigned short publicPort;
/** Returns YES if a non-null port mapping is in effect:
that is, if the public address differs from the local one. */
@property (readonly) BOOL isMapped;
// UTILITY CLASS METHODS:
/** Determine the main interface's public IP address, without mapping any ports. */
+ (NSString*) findPublicAddress;
/** Returns this computer's local IPv4 address. */
+ (NSString*) localAddress;
+ (UInt32) rawLocalAddress;
/** Is +localAddress in a private address range (like 10.0.1.X)? */
+ (BOOL) localAddressIsPrivate;
@end
/** This notification is posted asynchronously when the status of a PortMapper
(its error, publicAddress or publicPort) changes. */
extern NSString* const PortMapperChangedNotification;
</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/PortMapper/listing2.html%3Fid%3DDTS40007879-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/PortMapper/listing2.html%3Fid%3DDTS40007879-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/PortMapper/listing2.html%3Fid%3DDTS40007879-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>