PageRenderTime 45ms CodeModel.GetById 10ms RepoModel.GetById 1ms app.codeStats 0ms

/Pods/Documentation/CocoaAsyncSocket/html/Protocols/GCDAsyncSocketDelegate.html

https://gitlab.com/mba811/tokaidoapp
HTML | 949 lines | 511 code | 438 blank | 0 comment | 0 complexity | d5ce22474c1c4dab86817ba0319a242a MD5 | raw file
Possible License(s): BSD-3-Clause 
    

  1. <!DOCTYPE HTML>
    2. 

  2. <html>
    3. 

  3. 	<head>
    4. 

  4. 		<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
    5. 

  5. 		<title>GCDAsyncSocketDelegate Protocol Reference</title>
    6. 

  6. 		<meta id="xcode-display" name="xcode-display" content="render"/>
    7. 

  7. 		<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
    8. 

  8. 		<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
    9. 

  9. 		<meta name="generator" content="appledoc 2.1 (build 858)" />
    10. 

  10. 	</head>
    11. 

  11. 	<body>
    12. 

  12. 		<header id="top_header">
    13. 

  13. 			<div id="library" class="hideInXcode">
    14. 

  14. 				<h1><a id="libraryTitle" href="../index.html">CocoaAsyncSocket 0.0.1 </a></h1>
    15. 

  15. 				<a id="developerHome" href="../index.html">Dustin Voss and Robbie Hanson</a>
    16. 

  16. 			</div>
    17. 

  17. 			
    18. 

  18. 			<div id="title" role="banner">
    19. 

  19. 				<h1 class="hideInXcode">GCDAsyncSocketDelegate Protocol Reference</h1>
    20. 

  20. 			</div>
    21. 

  21. 			<ul id="headerButtons" role="toolbar">
    22. 

  22. 				<li id="toc_button">
    23. 

  23. 					<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
    24. 

  24. 				</li>
    25. 

  25. 				<li id="jumpto_button" role="navigation">
    26. 

  26. 					<select id="jumpTo">
    27. 

  27. 	<option value="top">Jump To&#133;</option>
    28. 

  28. 	
    29. 

  29. 	
    30. 

  30. 	
    31. 

  31. 	
    32. 

  32. 	<option value="tasks">Tasks</option>
    33. 

  33. 	
    34. 

  34. 	
    35. 

  35. 	
    36. 

  36. 	
    37. 

  37. 	
    38. 

  38. 	
    39. 

  39. 	
    40. 

  40. 	
    41. 

  41. 	
    42. 

  42. 	<option value="instance_methods">Instance Methods</option>
    43. 

  43. 	
    44. 

  44. 	<option value="//api/name/newSocketQueueForConnectionFromAddress:onSocket:">&nbsp;&nbsp;&nbsp;&nbsp;- newSocketQueueForConnectionFromAddress:onSocket:</option>
    45. 

  45. 	
    46. 

  46. 	<option value="//api/name/socket:didAcceptNewSocket:">&nbsp;&nbsp;&nbsp;&nbsp;- socket:didAcceptNewSocket:</option>
    47. 

  47. 	
    48. 

  48. 	<option value="//api/name/socket:didConnectToHost:port:">&nbsp;&nbsp;&nbsp;&nbsp;- socket:didConnectToHost:port:</option>
    49. 

  49. 	
    50. 

  50. 	<option value="//api/name/socket:didReadData:withTag:">&nbsp;&nbsp;&nbsp;&nbsp;- socket:didReadData:withTag:</option>
    51. 

  51. 	
    52. 

  52. 	<option value="//api/name/socket:didReadPartialDataOfLength:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- socket:didReadPartialDataOfLength:tag:</option>
    53. 

  53. 	
    54. 

  54. 	<option value="//api/name/socket:didWriteDataWithTag:">&nbsp;&nbsp;&nbsp;&nbsp;- socket:didWriteDataWithTag:</option>
    55. 

  55. 	
    56. 

  56. 	<option value="//api/name/socket:didWritePartialDataOfLength:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- socket:didWritePartialDataOfLength:tag:</option>
    57. 

  57. 	
    58. 

  58. 	<option value="//api/name/socket:shouldTimeoutReadWithTag:elapsed:bytesDone:">&nbsp;&nbsp;&nbsp;&nbsp;- socket:shouldTimeoutReadWithTag:elapsed:bytesDone:</option>
    59. 

  59. 	
    60. 

  60. 	<option value="//api/name/socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:">&nbsp;&nbsp;&nbsp;&nbsp;- socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:</option>
    61. 

  61. 	
    62. 

  62. 	<option value="//api/name/socketDidCloseReadStream:">&nbsp;&nbsp;&nbsp;&nbsp;- socketDidCloseReadStream:</option>
    63. 

  63. 	
    64. 

  64. 	<option value="//api/name/socketDidDisconnect:withError:">&nbsp;&nbsp;&nbsp;&nbsp;- socketDidDisconnect:withError:</option>
    65. 

  65. 	
    66. 

  66. 	<option value="//api/name/socketDidSecure:">&nbsp;&nbsp;&nbsp;&nbsp;- socketDidSecure:</option>
    67. 

  67. 	
    68. 

  68. 	
    69. 

  69. 	
    70. 

  70. </select>
    71. 

  71. 				</li>
    72. 

  72. 			</ul>
    73. 

  73. 		</header>
    74. 

  74. 		<nav id="tocContainer" class="isShowingTOC">
    75. 

  75. 			<ul id="toc" role="tree">
    76. 

  76. 				
    77. 

  77. 

  78. 

  79. 

  80. <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
    81. 

  81. 	
    82. 

  82. </ul></li>
    83. 

  83. 

  84. 

  85. 

  86. 

  87. 

  88. 

  89. 

  90. 

  91. 

  92. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
    93. 

  93. 	
    94. 

  94. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/newSocketQueueForConnectionFromAddress:onSocket:">newSocketQueueForConnectionFromAddress:onSocket:</a></span></li>
    95. 

  95. 	
    96. 

  96. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket:didAcceptNewSocket:">socket:didAcceptNewSocket:</a></span></li>
    97. 

  97. 	
    98. 

  98. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket:didConnectToHost:port:">socket:didConnectToHost:port:</a></span></li>
    99. 

  99. 	
    100. 

  100. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket:didReadData:withTag:">socket:didReadData:withTag:</a></span></li>
    101. 

  101. 	
    102. 

  102. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket:didReadPartialDataOfLength:tag:">socket:didReadPartialDataOfLength:tag:</a></span></li>
    103. 

  103. 	
    104. 

  104. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket:didWriteDataWithTag:">socket:didWriteDataWithTag:</a></span></li>
    105. 

  105. 	
    106. 

  106. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket:didWritePartialDataOfLength:tag:">socket:didWritePartialDataOfLength:tag:</a></span></li>
    107. 

  107. 	
    108. 

  108. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket:shouldTimeoutReadWithTag:elapsed:bytesDone:">socket:shouldTimeoutReadWithTag:elapsed:bytesDone:</a></span></li>
    109. 

  109. 	
    110. 

  110. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:">socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:</a></span></li>
    111. 

  111. 	
    112. 

  112. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socketDidCloseReadStream:">socketDidCloseReadStream:</a></span></li>
    113. 

  113. 	
    114. 

  114. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socketDidDisconnect:withError:">socketDidDisconnect:withError:</a></span></li>
    115. 

  115. 	
    116. 

  116. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socketDidSecure:">socketDidSecure:</a></span></li>
    117. 

  117. 	
    118. 

  118. </ul></li>
    119. 

  119. 

  120. 

  121. 			</ul>
    122. 

  122. 		</nav>
    123. 

  123. 		<article>
    124. 

  124. 			<div id="contents" class="isShowingTOC" role="main">
    125. 

  125. 				<a title="GCDAsyncSocketDelegate Protocol Reference" name="top"></a>
    126. 

  126. 				<div class="main-navigation navigation-top">
    127. 

  127. 					<ul>
    128. 

  128. 	<li><a href="../index.html">Index</a></li>
    129. 

  129. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    130. 

  130. </ul>
    131. 

  131. 				</div>
    132. 

  132. 				<div id="header">
    133. 

  133. 					<div class="section-header">
    134. 

  134. 						<h1 class="title title-header">GCDAsyncSocketDelegate Protocol Reference</h1>
    135. 

  135. 					</div>		
    136. 

  136. 				</div>
    137. 

  137. 				<div id="container">	
    138. 

  138. 					
    139. 

  139. 					<div class="section section-specification"><table cellspacing="0"><tbody>
    140. 

  140. 						<tr>
    141. 

  141. 	<td class="specification-title">Declared in</td>
    142. 

  142. 	<td class="specification-value">GCDAsyncSocket.h</td>
    143. 

  143. </tr>
    144. 

  144. 						</tbody></table></div>
    145. 

  145. 					
    146. 

  146. 					
    147. 

  147. 					
    148. 

  148. 					
    149. 

  149. 					
    150. 

  150. 					
    151. 

  151. 					<div class="section section-tasks">
    152. 

  152. 						<a title="Tasks" name="tasks"></a>
    153. 

  153. 						<h2 class="subtitle subtitle-tasks">Tasks</h2>
    154. 

  154. 						
    155. 

  155. 						
    156. 

  156. 						
    157. 

  157. 						
    158. 

  158. 

  159. 						<ul class="task-list">
    160. 

  160. 							<li>
    161. 

  161. 	<span class="tooltip">
    162. 

  162. 		<code><a href="#//api/name/newSocketQueueForConnectionFromAddress:onSocket:">&ndash;&nbsp;newSocketQueueForConnectionFromAddress:onSocket:</a></code>
    163. 

  163. 		<span class="tooltip"><p>This method is called immediately prior to <a href="#//api/name/socket:didAcceptNewSocket:">socket:didAcceptNewSocket:</a>.<br/>
    164. 

  164. It optionally allows a listening socket to specify the socketQueue for a new accepted socket.<br/>
    165. 

  165. If this method is not implemented, or returns NULL, the new accepted socket will create its own default queue.</p></span>
    166. 

  166. 	</span>
    167. 

  167. 	
    168. 

  168. 	
    169. 

  169. </li><li>
    170. 

  170. 	<span class="tooltip">
    171. 

  171. 		<code><a href="#//api/name/socket:didAcceptNewSocket:">&ndash;&nbsp;socket:didAcceptNewSocket:</a></code>
    172. 

  172. 		<span class="tooltip"><p>Called when a socket accepts a connection.<br/>
    173. 

  173. Another socket is automatically spawned to handle it.</p></span>
    174. 

  174. 	</span>
    175. 

  175. 	
    176. 

  176. 	
    177. 

  177. </li><li>
    178. 

  178. 	<span class="tooltip">
    179. 

  179. 		<code><a href="#//api/name/socket:didConnectToHost:port:">&ndash;&nbsp;socket:didConnectToHost:port:</a></code>
    180. 

  180. 		<span class="tooltip"><p>Called when a socket connects and is ready for reading and writing.<br/>
    181. 

  181. The host parameter will be an IP address, not a DNS name.</p></span>
    182. 

  182. 	</span>
    183. 

  183. 	
    184. 

  184. 	
    185. 

  185. </li><li>
    186. 

  186. 	<span class="tooltip">
    187. 

  187. 		<code><a href="#//api/name/socket:didReadData:withTag:">&ndash;&nbsp;socket:didReadData:withTag:</a></code>
    188. 

  188. 		<span class="tooltip"><p>Called when a socket has completed reading the requested data into memory.<br/>
    189. 

  189. Not called if there is an error.</p></span>
    190. 

  190. 	</span>
    191. 

  191. 	
    192. 

  192. 	
    193. 

  193. </li><li>
    194. 

  194. 	<span class="tooltip">
    195. 

  195. 		<code><a href="#//api/name/socket:didReadPartialDataOfLength:tag:">&ndash;&nbsp;socket:didReadPartialDataOfLength:tag:</a></code>
    196. 

  196. 		<span class="tooltip"><p>Called when a socket has read in data, but has not yet completed the read.<br/>
    197. 

  197. This would occur if using readToData: or readToLength: methods.<br/>
    198. 

  198. It may be used to for things such as updating progress bars.</p></span>
    199. 

  199. 	</span>
    200. 

  200. 	
    201. 

  201. 	
    202. 

  202. </li><li>
    203. 

  203. 	<span class="tooltip">
    204. 

  204. 		<code><a href="#//api/name/socket:didWriteDataWithTag:">&ndash;&nbsp;socket:didWriteDataWithTag:</a></code>
    205. 

  205. 		<span class="tooltip"><p>Called when a socket has completed writing the requested data. Not called if there is an error.</p></span>
    206. 

  206. 	</span>
    207. 

  207. 	
    208. 

  208. 	
    209. 

  209. </li><li>
    210. 

  210. 	<span class="tooltip">
    211. 

  211. 		<code><a href="#//api/name/socket:didWritePartialDataOfLength:tag:">&ndash;&nbsp;socket:didWritePartialDataOfLength:tag:</a></code>
    212. 

  212. 		<span class="tooltip"><p>Called when a socket has written some data, but has not yet completed the entire write.<br/>
    213. 

  213. It may be used to for things such as updating progress bars.</p></span>
    214. 

  214. 	</span>
    215. 

  215. 	
    216. 

  216. 	
    217. 

  217. </li><li>
    218. 

  218. 	<span class="tooltip">
    219. 

  219. 		<code><a href="#//api/name/socket:shouldTimeoutReadWithTag:elapsed:bytesDone:">&ndash;&nbsp;socket:shouldTimeoutReadWithTag:elapsed:bytesDone:</a></code>
    220. 

  220. 		<span class="tooltip"><p>Called if a read operation has reached its timeout without completing.<br/>
    221. 

  221. This method allows you to optionally extend the timeout.<br/>
    222. 

  222. If you return a positive time interval (> 0) the read&rsquo;s timeout will be extended by the given amount.<br/>
    223. 

  223. If you don&rsquo;t implement this method, or return a non-positive time interval (&lt;= 0) the read will timeout as usual.</p></span>
    224. 

  224. 	</span>
    225. 

  225. 	
    226. 

  226. 	
    227. 

  227. </li><li>
    228. 

  228. 	<span class="tooltip">
    229. 

  229. 		<code><a href="#//api/name/socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:">&ndash;&nbsp;socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:</a></code>
    230. 

  230. 		<span class="tooltip"><p>Called if a write operation has reached its timeout without completing.<br/>
    231. 

  231. This method allows you to optionally extend the timeout.<br/>
    232. 

  232. If you return a positive time interval (> 0) the write&rsquo;s timeout will be extended by the given amount.<br/>
    233. 

  233. If you don&rsquo;t implement this method, or return a non-positive time interval (&lt;= 0) the write will timeout as usual.</p></span>
    234. 

  234. 	</span>
    235. 

  235. 	
    236. 

  236. 	
    237. 

  237. </li><li>
    238. 

  238. 	<span class="tooltip">
    239. 

  239. 		<code><a href="#//api/name/socketDidCloseReadStream:">&ndash;&nbsp;socketDidCloseReadStream:</a></code>
    240. 

  240. 		<span class="tooltip"><p>Conditionally called if the read stream closes, but the write stream may still be writeable.</p></span>
    241. 

  241. 	</span>
    242. 

  242. 	
    243. 

  243. 	
    244. 

  244. </li><li>
    245. 

  245. 	<span class="tooltip">
    246. 

  246. 		<code><a href="#//api/name/socketDidDisconnect:withError:">&ndash;&nbsp;socketDidDisconnect:withError:</a></code>
    247. 

  247. 		<span class="tooltip"><p>Called when a socket disconnects with or without error.</p></span>
    248. 

  248. 	</span>
    249. 

  249. 	
    250. 

  250. 	
    251. 

  251. </li><li>
    252. 

  252. 	<span class="tooltip">
    253. 

  253. 		<code><a href="#//api/name/socketDidSecure:">&ndash;&nbsp;socketDidSecure:</a></code>
    254. 

  254. 		<span class="tooltip"><p>Called after the socket has successfully completed SSL/TLS negotiation.<br/>
    255. 

  255. This method is not called unless you use the provided startTLS method.</p></span>
    256. 

  256. 	</span>
    257. 

  257. 	
    258. 

  258. 	
    259. 

  259. </li>
    260. 

  260. 						</ul>
    261. 

  261. 						
    262. 

  262. 					</div>
    263. 

  263. 					
    264. 

  264. 					
    265. 

  265. 					
    266. 

  266. 					
    267. 

  267. 					
    268. 

  268. 					
    269. 

  269. 					
    270. 

  270. 					
    271. 

  271. 					
    272. 

  272. 					<div class="section section-methods">
    273. 

  273. 						<a title="Instance Methods" name="instance_methods"></a>
    274. 

  274. 						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
    275. 

  275. 						
    276. 

  276. 						<div class="section-method">
    277. 

  277. 	<a name="//api/name/newSocketQueueForConnectionFromAddress:onSocket:" title="newSocketQueueForConnectionFromAddress:onSocket:"></a>
    278. 

  278. 	<h3 class="subsubtitle method-title">newSocketQueueForConnectionFromAddress:onSocket:</h3>
    279. 

  279. 	
    280. 

  280. 	
    281. 

  281. 	
    282. 

  282. 	<div class="method-subsection brief-description">
    283. 

  283. 		<p>This method is called immediately prior to <a href="#//api/name/socket:didAcceptNewSocket:">socket:didAcceptNewSocket:</a>.<br/>
    284. 

  284. It optionally allows a listening socket to specify the socketQueue for a new accepted socket.<br/>
    285. 

  285. If this method is not implemented, or returns NULL, the new accepted socket will create its own default queue.</p>
    286. 

  286. 	</div>		
    287. 

  287. 	
    288. 

  288.     
    289. 

  289. 

  290. 	<div class="method-subsection method-declaration"><code>- (dispatch_queue_t)newSocketQueueForConnectionFromAddress:(NSData *)<em>address</em> onSocket:(GCDAsyncSocket *)<em>sock</em></code></div>
    291. 

  291. 

  292.     
    293. 

  293. 	
    294. 

  294. 	
    295. 

  295. 	
    296. 

  296. 	
    297. 

  297. 	
    298. 

  298. 	
    299. 

  299. 	
    300. 

  300. 	<div class="method-subsection discussion-section">
    301. 

  301. 		<h4 class="method-subtitle">Discussion</h4>
    302. 

  302. 		<p>This method is called immediately prior to <a href="#//api/name/socket:didAcceptNewSocket:">socket:didAcceptNewSocket:</a>.<br/>
    303. 

  303. It optionally allows a listening socket to specify the socketQueue for a new accepted socket.<br/>
    304. 

  304. If this method is not implemented, or returns NULL, the new accepted socket will create its own default queue.</p>
    305. 

  305. 

  306. <p>Since you cannot autorelease a dispatch_queue,<br/>
    307. 

  307. this method uses the &ldquo;new&rdquo; prefix in its name to specify that the returned queue has been retained.</p>
    308. 

  308. 

  309. <p>Thus you could do something like this in the implementation:<br/>
    310. 

  310. return dispatch_queue_create(&ldquo;MyQueue&rdquo;, NULL);</p>
    311. 

  311. 

  312. <p>If you are placing multiple sockets on the same queue,<br/>
    313. 

  313. then care should be taken to increment the retain count each time this method is invoked.</p>
    314. 

  314. 

  315. <p>For example, your implementation might look something like this:<br/>
    316. 

  316. dispatch_retain(myExistingQueue);<br/>
    317. 

  317. return myExistingQueue;</p>
    318. 

  318. 	</div>
    319. 

  319. 	
    320. 

  320. 	
    321. 

  321. 	
    322. 

  322. 	
    323. 

  323. 	
    324. 

  324. 	
    325. 

  325. 	
    326. 

  326. 	<div class="method-subsection declared-in-section">
    327. 

  327. 		<h4 class="method-subtitle">Declared In</h4>
    328. 

  328. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    329. 

  329. 	</div>				
    330. 

  330. 	
    331. 

  331. 	
    332. 

  332. </div>
    333. 

  333. 						
    334. 

  334. 						<div class="section-method">
    335. 

  335. 	<a name="//api/name/socket:didAcceptNewSocket:" title="socket:didAcceptNewSocket:"></a>
    336. 

  336. 	<h3 class="subsubtitle method-title">socket:didAcceptNewSocket:</h3>
    337. 

  337. 	
    338. 

  338. 	
    339. 

  339. 	
    340. 

  340. 	<div class="method-subsection brief-description">
    341. 

  341. 		<p>Called when a socket accepts a connection.<br/>
    342. 

  342. Another socket is automatically spawned to handle it.</p>
    343. 

  343. 	</div>		
    344. 

  344. 	
    345. 

  345.     
    346. 

  346. 

  347. 	<div class="method-subsection method-declaration"><code>- (void)socket:(GCDAsyncSocket *)<em>sock</em> didAcceptNewSocket:(GCDAsyncSocket *)<em>newSocket</em></code></div>
    348. 

  348. 

  349.     
    350. 

  350. 	
    351. 

  351. 	
    352. 

  352. 	
    353. 

  353. 	
    354. 

  354. 	
    355. 

  355. 	
    356. 

  356. 	
    357. 

  357. 	<div class="method-subsection discussion-section">
    358. 

  358. 		<h4 class="method-subtitle">Discussion</h4>
    359. 

  359. 		<p>Called when a socket accepts a connection.<br/>
    360. 

  360. Another socket is automatically spawned to handle it.</p>
    361. 

  361. 

  362. <p>You must retain the newSocket if you wish to handle the connection.<br/>
    363. 

  363. Otherwise the newSocket instance will be released and the spawned connection will be closed.</p>
    364. 

  364. 

  365. <p>By default the new socket will have the same delegate and delegateQueue.<br/>
    366. 

  366. You may, of course, change this at any time.</p>
    367. 

  367. 	</div>
    368. 

  368. 	
    369. 

  369. 	
    370. 

  370. 	
    371. 

  371. 	
    372. 

  372. 	
    373. 

  373. 	
    374. 

  374. 	
    375. 

  375. 	<div class="method-subsection declared-in-section">
    376. 

  376. 		<h4 class="method-subtitle">Declared In</h4>
    377. 

  377. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    378. 

  378. 	</div>				
    379. 

  379. 	
    380. 

  380. 	
    381. 

  381. </div>
    382. 

  382. 						
    383. 

  383. 						<div class="section-method">
    384. 

  384. 	<a name="//api/name/socket:didConnectToHost:port:" title="socket:didConnectToHost:port:"></a>
    385. 

  385. 	<h3 class="subsubtitle method-title">socket:didConnectToHost:port:</h3>
    386. 

  386. 	
    387. 

  387. 	
    388. 

  388. 	
    389. 

  389. 	<div class="method-subsection brief-description">
    390. 

  390. 		<p>Called when a socket connects and is ready for reading and writing.<br/>
    391. 

  391. The host parameter will be an IP address, not a DNS name.</p>
    392. 

  392. 	</div>		
    393. 

  393. 	
    394. 

  394.     
    395. 

  395. 

  396. 	<div class="method-subsection method-declaration"><code>- (void)socket:(GCDAsyncSocket *)<em>sock</em> didConnectToHost:(NSString *)<em>host</em> port:(uint16_t)<em>port</em></code></div>
    397. 

  397. 

  398.     
    399. 

  399. 	
    400. 

  400. 	
    401. 

  401. 	
    402. 

  402. 	
    403. 

  403. 	
    404. 

  404. 	
    405. 

  405. 	
    406. 

  406. 	<div class="method-subsection discussion-section">
    407. 

  407. 		<h4 class="method-subtitle">Discussion</h4>
    408. 

  408. 		<p>Called when a socket connects and is ready for reading and writing.<br/>
    409. 

  409. The host parameter will be an IP address, not a DNS name.</p>
    410. 

  410. 	</div>
    411. 

  411. 	
    412. 

  412. 	
    413. 

  413. 	
    414. 

  414. 	
    415. 

  415. 	
    416. 

  416. 	
    417. 

  417. 	
    418. 

  418. 	<div class="method-subsection declared-in-section">
    419. 

  419. 		<h4 class="method-subtitle">Declared In</h4>
    420. 

  420. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    421. 

  421. 	</div>				
    422. 

  422. 	
    423. 

  423. 	
    424. 

  424. </div>
    425. 

  425. 						
    426. 

  426. 						<div class="section-method">
    427. 

  427. 	<a name="//api/name/socket:didReadData:withTag:" title="socket:didReadData:withTag:"></a>
    428. 

  428. 	<h3 class="subsubtitle method-title">socket:didReadData:withTag:</h3>
    429. 

  429. 	
    430. 

  430. 	
    431. 

  431. 	
    432. 

  432. 	<div class="method-subsection brief-description">
    433. 

  433. 		<p>Called when a socket has completed reading the requested data into memory.<br/>
    434. 

  434. Not called if there is an error.</p>
    435. 

  435. 	</div>		
    436. 

  436. 	
    437. 

  437.     
    438. 

  438. 

  439. 	<div class="method-subsection method-declaration"><code>- (void)socket:(GCDAsyncSocket *)<em>sock</em> didReadData:(NSData *)<em>data</em> withTag:(long)<em>tag</em></code></div>
    440. 

  440. 

  441.     
    442. 

  442. 	
    443. 

  443. 	
    444. 

  444. 	
    445. 

  445. 	
    446. 

  446. 	
    447. 

  447. 	
    448. 

  448. 	
    449. 

  449. 	<div class="method-subsection discussion-section">
    450. 

  450. 		<h4 class="method-subtitle">Discussion</h4>
    451. 

  451. 		<p>Called when a socket has completed reading the requested data into memory.<br/>
    452. 

  452. Not called if there is an error.</p>
    453. 

  453. 	</div>
    454. 

  454. 	
    455. 

  455. 	
    456. 

  456. 	
    457. 

  457. 	
    458. 

  458. 	
    459. 

  459. 	
    460. 

  460. 	
    461. 

  461. 	<div class="method-subsection declared-in-section">
    462. 

  462. 		<h4 class="method-subtitle">Declared In</h4>
    463. 

  463. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    464. 

  464. 	</div>				
    465. 

  465. 	
    466. 

  466. 	
    467. 

  467. </div>
    468. 

  468. 						
    469. 

  469. 						<div class="section-method">
    470. 

  470. 	<a name="//api/name/socket:didReadPartialDataOfLength:tag:" title="socket:didReadPartialDataOfLength:tag:"></a>
    471. 

  471. 	<h3 class="subsubtitle method-title">socket:didReadPartialDataOfLength:tag:</h3>
    472. 

  472. 	
    473. 

  473. 	
    474. 

  474. 	
    475. 

  475. 	<div class="method-subsection brief-description">
    476. 

  476. 		<p>Called when a socket has read in data, but has not yet completed the read.<br/>
    477. 

  477. This would occur if using readToData: or readToLength: methods.<br/>
    478. 

  478. It may be used to for things such as updating progress bars.</p>
    479. 

  479. 	</div>		
    480. 

  480. 	
    481. 

  481.     
    482. 

  482. 

  483. 	<div class="method-subsection method-declaration"><code>- (void)socket:(GCDAsyncSocket *)<em>sock</em> didReadPartialDataOfLength:(NSUInteger)<em>partialLength</em> tag:(long)<em>tag</em></code></div>
    484. 

  484. 

  485.     
    486. 

  486. 	
    487. 

  487. 	
    488. 

  488. 	
    489. 

  489. 	
    490. 

  490. 	
    491. 

  491. 	
    492. 

  492. 	
    493. 

  493. 	<div class="method-subsection discussion-section">
    494. 

  494. 		<h4 class="method-subtitle">Discussion</h4>
    495. 

  495. 		<p>Called when a socket has read in data, but has not yet completed the read.<br/>
    496. 

  496. This would occur if using readToData: or readToLength: methods.<br/>
    497. 

  497. It may be used to for things such as updating progress bars.</p>
    498. 

  498. 	</div>
    499. 

  499. 	
    500. 

  500. 	
    501. 

  501. 	
    502. 

  502. 	
    503. 

  503. 	
    504. 

  504. 	
    505. 

  505. 	
    506. 

  506. 	<div class="method-subsection declared-in-section">
    507. 

  507. 		<h4 class="method-subtitle">Declared In</h4>
    508. 

  508. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    509. 

  509. 	</div>				
    510. 

  510. 	
    511. 

  511. 	
    512. 

  512. </div>
    513. 

  513. 						
    514. 

  514. 						<div class="section-method">
    515. 

  515. 	<a name="//api/name/socket:didWriteDataWithTag:" title="socket:didWriteDataWithTag:"></a>
    516. 

  516. 	<h3 class="subsubtitle method-title">socket:didWriteDataWithTag:</h3>
    517. 

  517. 	
    518. 

  518. 	
    519. 

  519. 	
    520. 

  520. 	<div class="method-subsection brief-description">
    521. 

  521. 		<p>Called when a socket has completed writing the requested data. Not called if there is an error.</p>
    522. 

  522. 	</div>		
    523. 

  523. 	
    524. 

  524.     
    525. 

  525. 

  526. 	<div class="method-subsection method-declaration"><code>- (void)socket:(GCDAsyncSocket *)<em>sock</em> didWriteDataWithTag:(long)<em>tag</em></code></div>
    527. 

  527. 

  528.     
    529. 

  529. 	
    530. 

  530. 	
    531. 

  531. 	
    532. 

  532. 	
    533. 

  533. 	
    534. 

  534. 	
    535. 

  535. 	
    536. 

  536. 	<div class="method-subsection discussion-section">
    537. 

  537. 		<h4 class="method-subtitle">Discussion</h4>
    538. 

  538. 		<p>Called when a socket has completed writing the requested data. Not called if there is an error.</p>
    539. 

  539. 	</div>
    540. 

  540. 	
    541. 

  541. 	
    542. 

  542. 	
    543. 

  543. 	
    544. 

  544. 	
    545. 

  545. 	
    546. 

  546. 	
    547. 

  547. 	<div class="method-subsection declared-in-section">
    548. 

  548. 		<h4 class="method-subtitle">Declared In</h4>
    549. 

  549. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    550. 

  550. 	</div>				
    551. 

  551. 	
    552. 

  552. 	
    553. 

  553. </div>
    554. 

  554. 						
    555. 

  555. 						<div class="section-method">
    556. 

  556. 	<a name="//api/name/socket:didWritePartialDataOfLength:tag:" title="socket:didWritePartialDataOfLength:tag:"></a>
    557. 

  557. 	<h3 class="subsubtitle method-title">socket:didWritePartialDataOfLength:tag:</h3>
    558. 

  558. 	
    559. 

  559. 	
    560. 

  560. 	
    561. 

  561. 	<div class="method-subsection brief-description">
    562. 

  562. 		<p>Called when a socket has written some data, but has not yet completed the entire write.<br/>
    563. 

  563. It may be used to for things such as updating progress bars.</p>
    564. 

  564. 	</div>		
    565. 

  565. 	
    566. 

  566.     
    567. 

  567. 

  568. 	<div class="method-subsection method-declaration"><code>- (void)socket:(GCDAsyncSocket *)<em>sock</em> didWritePartialDataOfLength:(NSUInteger)<em>partialLength</em> tag:(long)<em>tag</em></code></div>
    569. 

  569. 

  570.     
    571. 

  571. 	
    572. 

  572. 	
    573. 

  573. 	
    574. 

  574. 	
    575. 

  575. 	
    576. 

  576. 	
    577. 

  577. 	
    578. 

  578. 	<div class="method-subsection discussion-section">
    579. 

  579. 		<h4 class="method-subtitle">Discussion</h4>
    580. 

  580. 		<p>Called when a socket has written some data, but has not yet completed the entire write.<br/>
    581. 

  581. It may be used to for things such as updating progress bars.</p>
    582. 

  582. 	</div>
    583. 

  583. 	
    584. 

  584. 	
    585. 

  585. 	
    586. 

  586. 	
    587. 

  587. 	
    588. 

  588. 	
    589. 

  589. 	
    590. 

  590. 	<div class="method-subsection declared-in-section">
    591. 

  591. 		<h4 class="method-subtitle">Declared In</h4>
    592. 

  592. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    593. 

  593. 	</div>				
    594. 

  594. 	
    595. 

  595. 	
    596. 

  596. </div>
    597. 

  597. 						
    598. 

  598. 						<div class="section-method">
    599. 

  599. 	<a name="//api/name/socket:shouldTimeoutReadWithTag:elapsed:bytesDone:" title="socket:shouldTimeoutReadWithTag:elapsed:bytesDone:"></a>
    600. 

  600. 	<h3 class="subsubtitle method-title">socket:shouldTimeoutReadWithTag:elapsed:bytesDone:</h3>
    601. 

  601. 	
    602. 

  602. 	
    603. 

  603. 	
    604. 

  604. 	<div class="method-subsection brief-description">
    605. 

  605. 		<p>Called if a read operation has reached its timeout without completing.<br/>
    606. 

  606. This method allows you to optionally extend the timeout.<br/>
    607. 

  607. If you return a positive time interval (> 0) the read&rsquo;s timeout will be extended by the given amount.<br/>
    608. 

  608. If you don&rsquo;t implement this method, or return a non-positive time interval (&lt;= 0) the read will timeout as usual.</p>
    609. 

  609. 	</div>		
    610. 

  610. 	
    611. 

  611.     
    612. 

  612. 

  613. 	<div class="method-subsection method-declaration"><code>- (NSTimeInterval)socket:(GCDAsyncSocket *)<em>sock</em> shouldTimeoutReadWithTag:(long)<em>tag</em> elapsed:(NSTimeInterval)<em>elapsed</em> bytesDone:(NSUInteger)<em>length</em></code></div>
    614. 

  614. 

  615.     
    616. 

  616. 	
    617. 

  617. 	
    618. 

  618. 	
    619. 

  619. 	
    620. 

  620. 	
    621. 

  621. 	
    622. 

  622. 	
    623. 

  623. 	<div class="method-subsection discussion-section">
    624. 

  624. 		<h4 class="method-subtitle">Discussion</h4>
    625. 

  625. 		<p>Called if a read operation has reached its timeout without completing.<br/>
    626. 

  626. This method allows you to optionally extend the timeout.<br/>
    627. 

  627. If you return a positive time interval (> 0) the read&rsquo;s timeout will be extended by the given amount.<br/>
    628. 

  628. If you don&rsquo;t implement this method, or return a non-positive time interval (&lt;= 0) the read will timeout as usual.</p>
    629. 

  629. 

  630. <p>The elapsed parameter is the sum of the original timeout, plus any additions previously added via this method.<br/>
    631. 

  631. The length parameter is the number of bytes that have been read so far for the read operation.</p>
    632. 

  632. 

  633. <p>Note that this method may be called multiple times for a single read if you return positive numbers.</p>
    634. 

  634. 	</div>
    635. 

  635. 	
    636. 

  636. 	
    637. 

  637. 	
    638. 

  638. 	
    639. 

  639. 	
    640. 

  640. 	
    641. 

  641. 	
    642. 

  642. 	<div class="method-subsection declared-in-section">
    643. 

  643. 		<h4 class="method-subtitle">Declared In</h4>
    644. 

  644. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    645. 

  645. 	</div>				
    646. 

  646. 	
    647. 

  647. 	
    648. 

  648. </div>
    649. 

  649. 						
    650. 

  650. 						<div class="section-method">
    651. 

  651. 	<a name="//api/name/socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:" title="socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:"></a>
    652. 

  652. 	<h3 class="subsubtitle method-title">socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:</h3>
    653. 

  653. 	
    654. 

  654. 	
    655. 

  655. 	
    656. 

  656. 	<div class="method-subsection brief-description">
    657. 

  657. 		<p>Called if a write operation has reached its timeout without completing.<br/>
    658. 

  658. This method allows you to optionally extend the timeout.<br/>
    659. 

  659. If you return a positive time interval (> 0) the write&rsquo;s timeout will be extended by the given amount.<br/>
    660. 

  660. If you don&rsquo;t implement this method, or return a non-positive time interval (&lt;= 0) the write will timeout as usual.</p>
    661. 

  661. 	</div>		
    662. 

  662. 	
    663. 

  663.     
    664. 

  664. 

  665. 	<div class="method-subsection method-declaration"><code>- (NSTimeInterval)socket:(GCDAsyncSocket *)<em>sock</em> shouldTimeoutWriteWithTag:(long)<em>tag</em> elapsed:(NSTimeInterval)<em>elapsed</em> bytesDone:(NSUInteger)<em>length</em></code></div>
    666. 

  666. 

  667.     
    668. 

  668. 	
    669. 

  669. 	
    670. 

  670. 	
    671. 

  671. 	
    672. 

  672. 	
    673. 

  673. 	
    674. 

  674. 	
    675. 

  675. 	<div class="method-subsection discussion-section">
    676. 

  676. 		<h4 class="method-subtitle">Discussion</h4>
    677. 

  677. 		<p>Called if a write operation has reached its timeout without completing.<br/>
    678. 

  678. This method allows you to optionally extend the timeout.<br/>
    679. 

  679. If you return a positive time interval (> 0) the write&rsquo;s timeout will be extended by the given amount.<br/>
    680. 

  680. If you don&rsquo;t implement this method, or return a non-positive time interval (&lt;= 0) the write will timeout as usual.</p>
    681. 

  681. 

  682. <p>The elapsed parameter is the sum of the original timeout, plus any additions previously added via this method.<br/>
    683. 

  683. The length parameter is the number of bytes that have been written so far for the write operation.</p>
    684. 

  684. 

  685. <p>Note that this method may be called multiple times for a single write if you return positive numbers.</p>
    686. 

  686. 	</div>
    687. 

  687. 	
    688. 

  688. 	
    689. 

  689. 	
    690. 

  690. 	
    691. 

  691. 	
    692. 

  692. 	
    693. 

  693. 	
    694. 

  694. 	<div class="method-subsection declared-in-section">
    695. 

  695. 		<h4 class="method-subtitle">Declared In</h4>
    696. 

  696. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    697. 

  697. 	</div>				
    698. 

  698. 	
    699. 

  699. 	
    700. 

  700. </div>
    701. 

  701. 						
    702. 

  702. 						<div class="section-method">
    703. 

  703. 	<a name="//api/name/socketDidCloseReadStream:" title="socketDidCloseReadStream:"></a>
    704. 

  704. 	<h3 class="subsubtitle method-title">socketDidCloseReadStream:</h3>
    705. 

  705. 	
    706. 

  706. 	
    707. 

  707. 	
    708. 

  708. 	<div class="method-subsection brief-description">
    709. 

  709. 		<p>Conditionally called if the read stream closes, but the write stream may still be writeable.</p>
    710. 

  710. 	</div>		
    711. 

  711. 	
    712. 

  712.     
    713. 

  713. 

  714. 	<div class="method-subsection method-declaration"><code>- (void)socketDidCloseReadStream:(GCDAsyncSocket *)<em>sock</em></code></div>
    715. 

  715. 

  716.     
    717. 

  717. 	
    718. 

  718. 	
    719. 

  719. 	
    720. 

  720. 	
    721. 

  721. 	
    722. 

  722. 	
    723. 

  723. 	
    724. 

  724. 	<div class="method-subsection discussion-section">
    725. 

  725. 		<h4 class="method-subtitle">Discussion</h4>
    726. 

  726. 		<p>Conditionally called if the read stream closes, but the write stream may still be writeable.</p>
    727. 

  727. 

  728. <p>This delegate method is only called if autoDisconnectOnClosedReadStream has been set to NO.<br/>
    729. 

  729. See the discussion on the autoDisconnectOnClosedReadStream method for more information.</p>
    730. 

  730. 	</div>
    731. 

  731. 	
    732. 

  732. 	
    733. 

  733. 	
    734. 

  734. 	
    735. 

  735. 	
    736. 

  736. 	
    737. 

  737. 	
    738. 

  738. 	<div class="method-subsection declared-in-section">
    739. 

  739. 		<h4 class="method-subtitle">Declared In</h4>
    740. 

  740. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    741. 

  741. 	</div>				
    742. 

  742. 	
    743. 

  743. 	
    744. 

  744. </div>
    745. 

  745. 						
    746. 

  746. 						<div class="section-method">
    747. 

  747. 	<a name="//api/name/socketDidDisconnect:withError:" title="socketDidDisconnect:withError:"></a>
    748. 

  748. 	<h3 class="subsubtitle method-title">socketDidDisconnect:withError:</h3>
    749. 

  749. 	
    750. 

  750. 	
    751. 

  751. 	
    752. 

  752. 	<div class="method-subsection brief-description">
    753. 

  753. 		<p>Called when a socket disconnects with or without error.</p>
    754. 

  754. 	</div>		
    755. 

  755. 	
    756. 

  756.     
    757. 

  757. 

  758. 	<div class="method-subsection method-declaration"><code>- (void)socketDidDisconnect:(GCDAsyncSocket *)<em>sock</em> withError:(NSError *)<em>err</em></code></div>
    759. 

  759. 

  760.     
    761. 

  761. 	
    762. 

  762. 	
    763. 

  763. 	
    764. 

  764. 	
    765. 

  765. 	
    766. 

  766. 	
    767. 

  767. 	
    768. 

  768. 	<div class="method-subsection discussion-section">
    769. 

  769. 		<h4 class="method-subtitle">Discussion</h4>
    770. 

  770. 		<p>Called when a socket disconnects with or without error.</p>
    771. 

  771. 

  772. <p>If you call the disconnect method, and the socket wasn&rsquo;t already disconnected,<br/>
    773. 

  773. this delegate method will be called before the disconnect method returns.</p>
    774. 

  774. 	</div>
    775. 

  775. 	
    776. 

  776. 	
    777. 

  777. 	
    778. 

  778. 	
    779. 

  779. 	
    780. 

  780. 	
    781. 

  781. 	
    782. 

  782. 	<div class="method-subsection declared-in-section">
    783. 

  783. 		<h4 class="method-subtitle">Declared In</h4>
    784. 

  784. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    785. 

  785. 	</div>				
    786. 

  786. 	
    787. 

  787. 	
    788. 

  788. </div>
    789. 

  789. 						
    790. 

  790. 						<div class="section-method">
    791. 

  791. 	<a name="//api/name/socketDidSecure:" title="socketDidSecure:"></a>
    792. 

  792. 	<h3 class="subsubtitle method-title">socketDidSecure:</h3>
    793. 

  793. 	
    794. 

  794. 	
    795. 

  795. 	
    796. 

  796. 	<div class="method-subsection brief-description">
    797. 

  797. 		<p>Called after the socket has successfully completed SSL/TLS negotiation.<br/>
    798. 

  798. This method is not called unless you use the provided startTLS method.</p>
    799. 

  799. 	</div>		
    800. 

  800. 	
    801. 

  801.     
    802. 

  802. 

  803. 	<div class="method-subsection method-declaration"><code>- (void)socketDidSecure:(GCDAsyncSocket *)<em>sock</em></code></div>
    804. 

  804. 

  805.     
    806. 

  806. 	
    807. 

  807. 	
    808. 

  808. 	
    809. 

  809. 	
    810. 

  810. 	
    811. 

  811. 	
    812. 

  812. 	
    813. 

  813. 	<div class="method-subsection discussion-section">
    814. 

  814. 		<h4 class="method-subtitle">Discussion</h4>
    815. 

  815. 		<p>Called after the socket has successfully completed SSL/TLS negotiation.<br/>
    816. 

  816. This method is not called unless you use the provided startTLS method.</p>
    817. 

  817. 

  818. <p>If a SSL/TLS negotiation fails (invalid certificate, etc) then the socket will immediately close,<br/>
    819. 

  819. and the <a href="#//api/name/socketDidDisconnect:withError:">socketDidDisconnect:withError:</a> delegate method will be called with the specific SSL error code.</p>
    820. 

  820. 	</div>
    821. 

  821. 	
    822. 

  822. 	
    823. 

  823. 	
    824. 

  824. 	
    825. 

  825. 	
    826. 

  826. 	
    827. 

  827. 	
    828. 

  828. 	<div class="method-subsection declared-in-section">
    829. 

  829. 		<h4 class="method-subtitle">Declared In</h4>
    830. 

  830. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    831. 

  831. 	</div>				
    832. 

  832. 	
    833. 

  833. 	
    834. 

  834. </div>
    835. 

  835. 						
    836. 

  836. 					</div>
    837. 

  837. 					
    838. 

  838. 					
    839. 

  839. 				</div>
    840. 

  840. 				<div class="main-navigation navigation-bottom">
    841. 

  841. 					<ul>
    842. 

  842. 	<li><a href="../index.html">Index</a></li>
    843. 

  843. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    844. 

  844. </ul>
    845. 

  845. 				</div>
    846. 

  846. 				<div id="footer">
    847. 

  847. 					<hr />
    848. 

  848. 					<div class="footer-copyright">
    849. 

  849. 						<p><span class="copyright">&copy; 2013 Dustin Voss and Robbie Hanson. All rights reserved. (Last updated: 2013-04-24)</span><br />
    850. 

  850. 						
    851. 

  851. 						<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
    852. 

  852. 						
    853. 

  853. 					</div>
    854. 

  854. 				</div>
    855. 

  855. 			</div>
    856. 

  856. 		</article>
    857. 

  857. 		<script type="text/javascript">
    858. 

  858. 			function jumpToChange()
    859. 

  859. 			{
    860. 

  860. 				window.location.hash = this.options[this.selectedIndex].value;
    861. 

  861. 			}
    862. 

  862. 			
    863. 

  863. 			function toggleTOC()
    864. 

  864. 			{
    865. 

  865. 				var contents = document.getElementById('contents');
    866. 

  866. 				var tocContainer = document.getElementById('tocContainer');
    867. 

  867. 				
    868. 

  868. 				if (this.getAttribute('class') == 'open')
    869. 

  869. 				{
    870. 

  870. 					this.setAttribute('class', '');
    871. 

  871. 					contents.setAttribute('class', '');
    872. 

  872. 					tocContainer.setAttribute('class', '');
    873. 

  873. 					
    874. 

  874. 					window.name = "hideTOC";
    875. 

  875. 				}
    876. 

  876. 				else
    877. 

  877. 				{
    878. 

  878. 					this.setAttribute('class', 'open');
    879. 

  879. 					contents.setAttribute('class', 'isShowingTOC');
    880. 

  880. 					tocContainer.setAttribute('class', 'isShowingTOC');
    881. 

  881. 					
    882. 

  882. 					window.name = "";
    883. 

  883. 				}
    884. 

  884. 				return false;
    885. 

  885. 			}
    886. 

  886. 			
    887. 

  887. 			function toggleTOCEntryChildren(e)
    888. 

  888. 			{
    889. 

  889. 				e.stopPropagation();
    890. 

  890. 				var currentClass = this.getAttribute('class');
    891. 

  891. 				if (currentClass == 'children') {
    892. 

  892. 					this.setAttribute('class', 'children open');
    893. 

  893. 				}
    894. 

  894. 				else if (currentClass == 'children open') {
    895. 

  895. 					this.setAttribute('class', 'children');
    896. 

  896. 				}
    897. 

  897. 				return false;
    898. 

  898. 			}
    899. 

  899. 			
    900. 

  900. 			function tocEntryClick(e)
    901. 

  901. 			{
    902. 

  902. 				e.stopPropagation();
    903. 

  903. 				return true;
    904. 

  904. 			}
    905. 

  905. 			
    906. 

  906. 			function init()
    907. 

  907. 			{
    908. 

  908. 				var selectElement = document.getElementById('jumpTo');
    909. 

  909. 				selectElement.addEventListener('change', jumpToChange, false);
    910. 

  910. 				
    911. 

  911. 				var tocButton = document.getElementById('table_of_contents');
    912. 

  912. 				tocButton.addEventListener('click', toggleTOC, false);
    913. 

  913. 				
    914. 

  914. 				var taskTreeItem = document.getElementById('task_treeitem');
    915. 

  915. 				if (taskTreeItem.getElementsByTagName('li').length > 0)
    916. 

  916. 				{
    917. 

  917. 					taskTreeItem.setAttribute('class', 'children');
    918. 

  918. 					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
    919. 

  919. 				}
    920. 

  920. 				
    921. 

  921. 				var tocList = document.getElementById('toc');
    922. 

  922. 				
    923. 

  923. 				var tocEntries = tocList.getElementsByTagName('li');
    924. 

  924. 				for (var i = 0; i < tocEntries.length; i++) {
    925. 

  925. 					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
    926. 

  926. 				}
    927. 

  927. 				
    928. 

  928. 				var tocLinks = tocList.getElementsByTagName('a');
    929. 

  929. 				for (var i = 0; i < tocLinks.length; i++) {
    930. 

  930. 					tocLinks[i].addEventListener('click', tocEntryClick, false);
    931. 

  931. 				}
    932. 

  932. 				
    933. 

  933. 				if (window.name == "hideTOC") {
    934. 

  934. 					toggleTOC.call(tocButton);
    935. 

  935. 				}
    936. 

  936. 			}
    937. 

  937. 			
    938. 

  938. 			window.onload = init;
    939. 

  939. 			
    940. 

  940. 			// If showing in Xcode, hide the TOC and Header
    941. 

  941. 			if (navigator.userAgent.match(/xcode/i)) {
    942. 

  942. 				document.getElementById("contents").className = "hideInXcode"
    943. 

  943. 				document.getElementById("tocContainer").className = "hideInXcode"
    944. 

  944. 				document.getElementById("top_header").className = "hideInXcode"
    945. 

  945. 			}
    946. 

  946. 			
    947. 

  947. 		</script>
    948. 

  948. 	</body>
    949. 

  949. </html>
    950.