PageRenderTime 67ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/Pods/Documentation/CocoaAsyncSocket/docset/Contents/Resources/Documents/Classes/GCDAsyncSocket.html

https://gitlab.com/mba811/tokaidoapp
HTML | 3662 lines | 1919 code | 1743 blank | 0 comment | 0 complexity | 06b7c318a53495aab9a3ebf3c0b6bc20 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>GCDAsyncSocket Class 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">GCDAsyncSocket Class 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. 	<option value="class_methods">Class Methods</option>
    41. 

  41. 	
    42. 

  42. 	<option value="//api/name/CRData">&nbsp;&nbsp;&nbsp;&nbsp;+ CRData</option>
    43. 

  43. 	
    44. 

  44. 	<option value="//api/name/CRLFData">&nbsp;&nbsp;&nbsp;&nbsp;+ CRLFData</option>
    45. 

  45. 	
    46. 

  46. 	<option value="//api/name/LFData">&nbsp;&nbsp;&nbsp;&nbsp;+ LFData</option>
    47. 

  47. 	
    48. 

  48. 	<option value="//api/name/ZeroData">&nbsp;&nbsp;&nbsp;&nbsp;+ ZeroData</option>
    49. 

  49. 	
    50. 

  50. 	<option value="//api/name/getHost:port:fromAddress:">&nbsp;&nbsp;&nbsp;&nbsp;+ getHost:port:fromAddress:</option>
    51. 

  51. 	
    52. 

  52. 	<option value="//api/name/hostFromAddress:">&nbsp;&nbsp;&nbsp;&nbsp;+ hostFromAddress:</option>
    53. 

  53. 	
    54. 

  54. 	<option value="//api/name/portFromAddress:">&nbsp;&nbsp;&nbsp;&nbsp;+ portFromAddress:</option>
    55. 

  55. 	
    56. 

  56. 	
    57. 

  57. 	
    58. 

  58. 	
    59. 

  59. 	<option value="instance_methods">Instance Methods</option>
    60. 

  60. 	
    61. 

  61. 	<option value="//api/name/acceptOnInterface:port:error:">&nbsp;&nbsp;&nbsp;&nbsp;- acceptOnInterface:port:error:</option>
    62. 

  62. 	
    63. 

  63. 	<option value="//api/name/acceptOnPort:error:">&nbsp;&nbsp;&nbsp;&nbsp;- acceptOnPort:error:</option>
    64. 

  64. 	
    65. 

  65. 	<option value="//api/name/autoDisconnectOnClosedReadStream">&nbsp;&nbsp;&nbsp;&nbsp;- autoDisconnectOnClosedReadStream</option>
    66. 

  66. 	
    67. 

  67. 	<option value="//api/name/connectToAddress:error:">&nbsp;&nbsp;&nbsp;&nbsp;- connectToAddress:error:</option>
    68. 

  68. 	
    69. 

  69. 	<option value="//api/name/connectToAddress:viaInterface:withTimeout:error:">&nbsp;&nbsp;&nbsp;&nbsp;- connectToAddress:viaInterface:withTimeout:error:</option>
    70. 

  70. 	
    71. 

  71. 	<option value="//api/name/connectToAddress:withTimeout:error:">&nbsp;&nbsp;&nbsp;&nbsp;- connectToAddress:withTimeout:error:</option>
    72. 

  72. 	
    73. 

  73. 	<option value="//api/name/connectToHost:onPort:error:">&nbsp;&nbsp;&nbsp;&nbsp;- connectToHost:onPort:error:</option>
    74. 

  74. 	
    75. 

  75. 	<option value="//api/name/connectToHost:onPort:viaInterface:withTimeout:error:">&nbsp;&nbsp;&nbsp;&nbsp;- connectToHost:onPort:viaInterface:withTimeout:error:</option>
    76. 

  76. 	
    77. 

  77. 	<option value="//api/name/connectToHost:onPort:withTimeout:error:">&nbsp;&nbsp;&nbsp;&nbsp;- connectToHost:onPort:withTimeout:error:</option>
    78. 

  78. 	
    79. 

  79. 	<option value="//api/name/connectedAddress">&nbsp;&nbsp;&nbsp;&nbsp;- connectedAddress</option>
    80. 

  80. 	
    81. 

  81. 	<option value="//api/name/connectedHost">&nbsp;&nbsp;&nbsp;&nbsp;- connectedHost</option>
    82. 

  82. 	
    83. 

  83. 	<option value="//api/name/connectedPort">&nbsp;&nbsp;&nbsp;&nbsp;- connectedPort</option>
    84. 

  84. 	
    85. 

  85. 	<option value="//api/name/delegate">&nbsp;&nbsp;&nbsp;&nbsp;- delegate</option>
    86. 

  86. 	
    87. 

  87. 	<option value="//api/name/delegateQueue">&nbsp;&nbsp;&nbsp;&nbsp;- delegateQueue</option>
    88. 

  88. 	
    89. 

  89. 	<option value="//api/name/disconnect">&nbsp;&nbsp;&nbsp;&nbsp;- disconnect</option>
    90. 

  90. 	
    91. 

  91. 	<option value="//api/name/disconnectAfterReading">&nbsp;&nbsp;&nbsp;&nbsp;- disconnectAfterReading</option>
    92. 

  92. 	
    93. 

  93. 	<option value="//api/name/disconnectAfterReadingAndWriting">&nbsp;&nbsp;&nbsp;&nbsp;- disconnectAfterReadingAndWriting</option>
    94. 

  94. 	
    95. 

  95. 	<option value="//api/name/disconnectAfterWriting">&nbsp;&nbsp;&nbsp;&nbsp;- disconnectAfterWriting</option>
    96. 

  96. 	
    97. 

  97. 	<option value="//api/name/enableBackgroundingOnSocket">&nbsp;&nbsp;&nbsp;&nbsp;- enableBackgroundingOnSocket</option>
    98. 

  98. 	
    99. 

  99. 	<option value="//api/name/getDelegate:delegateQueue:">&nbsp;&nbsp;&nbsp;&nbsp;- getDelegate:delegateQueue:</option>
    100. 

  100. 	
    101. 

  101. 	<option value="//api/name/init">&nbsp;&nbsp;&nbsp;&nbsp;- init</option>
    102. 

  102. 	
    103. 

  103. 	<option value="//api/name/initWithDelegate:delegateQueue:">&nbsp;&nbsp;&nbsp;&nbsp;- initWithDelegate:delegateQueue:</option>
    104. 

  104. 	
    105. 

  105. 	<option value="//api/name/initWithDelegate:delegateQueue:socketQueue:">&nbsp;&nbsp;&nbsp;&nbsp;- initWithDelegate:delegateQueue:socketQueue:</option>
    106. 

  106. 	
    107. 

  107. 	<option value="//api/name/initWithSocketQueue:">&nbsp;&nbsp;&nbsp;&nbsp;- initWithSocketQueue:</option>
    108. 

  108. 	
    109. 

  109. 	<option value="//api/name/isConnected">&nbsp;&nbsp;&nbsp;&nbsp;- isConnected</option>
    110. 

  110. 	
    111. 

  111. 	<option value="//api/name/isDisconnected">&nbsp;&nbsp;&nbsp;&nbsp;- isDisconnected</option>
    112. 

  112. 	
    113. 

  113. 	<option value="//api/name/isIPv4">&nbsp;&nbsp;&nbsp;&nbsp;- isIPv4</option>
    114. 

  114. 	
    115. 

  115. 	<option value="//api/name/isIPv4Enabled">&nbsp;&nbsp;&nbsp;&nbsp;- isIPv4Enabled</option>
    116. 

  116. 	
    117. 

  117. 	<option value="//api/name/isIPv4PreferredOverIPv6">&nbsp;&nbsp;&nbsp;&nbsp;- isIPv4PreferredOverIPv6</option>
    118. 

  118. 	
    119. 

  119. 	<option value="//api/name/isIPv6">&nbsp;&nbsp;&nbsp;&nbsp;- isIPv6</option>
    120. 

  120. 	
    121. 

  121. 	<option value="//api/name/isIPv6Enabled">&nbsp;&nbsp;&nbsp;&nbsp;- isIPv6Enabled</option>
    122. 

  122. 	
    123. 

  123. 	<option value="//api/name/isSecure">&nbsp;&nbsp;&nbsp;&nbsp;- isSecure</option>
    124. 

  124. 	
    125. 

  125. 	<option value="//api/name/localAddress">&nbsp;&nbsp;&nbsp;&nbsp;- localAddress</option>
    126. 

  126. 	
    127. 

  127. 	<option value="//api/name/localHost">&nbsp;&nbsp;&nbsp;&nbsp;- localHost</option>
    128. 

  128. 	
    129. 

  129. 	<option value="//api/name/localPort">&nbsp;&nbsp;&nbsp;&nbsp;- localPort</option>
    130. 

  130. 	
    131. 

  131. 	<option value="//api/name/performBlock:">&nbsp;&nbsp;&nbsp;&nbsp;- performBlock:</option>
    132. 

  132. 	
    133. 

  133. 	<option value="//api/name/progressOfReadReturningTag:bytesDone:total:">&nbsp;&nbsp;&nbsp;&nbsp;- progressOfReadReturningTag:bytesDone:total:</option>
    134. 

  134. 	
    135. 

  135. 	<option value="//api/name/progressOfWriteReturningTag:bytesDone:total:">&nbsp;&nbsp;&nbsp;&nbsp;- progressOfWriteReturningTag:bytesDone:total:</option>
    136. 

  136. 	
    137. 

  137. 	<option value="//api/name/readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:</option>
    138. 

  138. 	
    139. 

  139. 	<option value="//api/name/readDataToData:withTimeout:buffer:bufferOffset:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- readDataToData:withTimeout:buffer:bufferOffset:tag:</option>
    140. 

  140. 	
    141. 

  141. 	<option value="//api/name/readDataToData:withTimeout:maxLength:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- readDataToData:withTimeout:maxLength:tag:</option>
    142. 

  142. 	
    143. 

  143. 	<option value="//api/name/readDataToData:withTimeout:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- readDataToData:withTimeout:tag:</option>
    144. 

  144. 	
    145. 

  145. 	<option value="//api/name/readDataToLength:withTimeout:buffer:bufferOffset:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- readDataToLength:withTimeout:buffer:bufferOffset:tag:</option>
    146. 

  146. 	
    147. 

  147. 	<option value="//api/name/readDataToLength:withTimeout:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- readDataToLength:withTimeout:tag:</option>
    148. 

  148. 	
    149. 

  149. 	<option value="//api/name/readDataWithTimeout:buffer:bufferOffset:maxLength:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- readDataWithTimeout:buffer:bufferOffset:maxLength:tag:</option>
    150. 

  150. 	
    151. 

  151. 	<option value="//api/name/readDataWithTimeout:buffer:bufferOffset:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- readDataWithTimeout:buffer:bufferOffset:tag:</option>
    152. 

  152. 	
    153. 

  153. 	<option value="//api/name/readDataWithTimeout:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- readDataWithTimeout:tag:</option>
    154. 

  154. 	
    155. 

  155. 	<option value="//api/name/readStream">&nbsp;&nbsp;&nbsp;&nbsp;- readStream</option>
    156. 

  156. 	
    157. 

  157. 	<option value="//api/name/setAutoDisconnectOnClosedReadStream:">&nbsp;&nbsp;&nbsp;&nbsp;- setAutoDisconnectOnClosedReadStream:</option>
    158. 

  158. 	
    159. 

  159. 	<option value="//api/name/setDelegate:">&nbsp;&nbsp;&nbsp;&nbsp;- setDelegate:</option>
    160. 

  160. 	
    161. 

  161. 	<option value="//api/name/setDelegate:delegateQueue:">&nbsp;&nbsp;&nbsp;&nbsp;- setDelegate:delegateQueue:</option>
    162. 

  162. 	
    163. 

  163. 	<option value="//api/name/setDelegateQueue:">&nbsp;&nbsp;&nbsp;&nbsp;- setDelegateQueue:</option>
    164. 

  164. 	
    165. 

  165. 	<option value="//api/name/setIPv4Enabled:">&nbsp;&nbsp;&nbsp;&nbsp;- setIPv4Enabled:</option>
    166. 

  166. 	
    167. 

  167. 	<option value="//api/name/setIPv6Enabled:">&nbsp;&nbsp;&nbsp;&nbsp;- setIPv6Enabled:</option>
    168. 

  168. 	
    169. 

  169. 	<option value="//api/name/setPreferIPv4OverIPv6:">&nbsp;&nbsp;&nbsp;&nbsp;- setPreferIPv4OverIPv6:</option>
    170. 

  170. 	
    171. 

  171. 	<option value="//api/name/setUserData:">&nbsp;&nbsp;&nbsp;&nbsp;- setUserData:</option>
    172. 

  172. 	
    173. 

  173. 	<option value="//api/name/socket4FD">&nbsp;&nbsp;&nbsp;&nbsp;- socket4FD</option>
    174. 

  174. 	
    175. 

  175. 	<option value="//api/name/socket6FD">&nbsp;&nbsp;&nbsp;&nbsp;- socket6FD</option>
    176. 

  176. 	
    177. 

  177. 	<option value="//api/name/socketFD">&nbsp;&nbsp;&nbsp;&nbsp;- socketFD</option>
    178. 

  178. 	
    179. 

  179. 	<option value="//api/name/sslContext">&nbsp;&nbsp;&nbsp;&nbsp;- sslContext</option>
    180. 

  180. 	
    181. 

  181. 	<option value="//api/name/startTLS:">&nbsp;&nbsp;&nbsp;&nbsp;- startTLS:</option>
    182. 

  182. 	
    183. 

  183. 	<option value="//api/name/synchronouslySetDelegate:">&nbsp;&nbsp;&nbsp;&nbsp;- synchronouslySetDelegate:</option>
    184. 

  184. 	
    185. 

  185. 	<option value="//api/name/synchronouslySetDelegate:delegateQueue:">&nbsp;&nbsp;&nbsp;&nbsp;- synchronouslySetDelegate:delegateQueue:</option>
    186. 

  186. 	
    187. 

  187. 	<option value="//api/name/synchronouslySetDelegateQueue:">&nbsp;&nbsp;&nbsp;&nbsp;- synchronouslySetDelegateQueue:</option>
    188. 

  188. 	
    189. 

  189. 	<option value="//api/name/userData">&nbsp;&nbsp;&nbsp;&nbsp;- userData</option>
    190. 

  190. 	
    191. 

  191. 	<option value="//api/name/writeData:withTimeout:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- writeData:withTimeout:tag:</option>
    192. 

  192. 	
    193. 

  193. 	<option value="//api/name/writeStream">&nbsp;&nbsp;&nbsp;&nbsp;- writeStream</option>
    194. 

  194. 	
    195. 

  195. 	
    196. 

  196. 	
    197. 

  197. </select>
    198. 

  198. 				</li>
    199. 

  199. 			</ul>
    200. 

  200. 		</header>
    201. 

  201. 		<nav id="tocContainer" class="isShowingTOC">
    202. 

  202. 			<ul id="toc" role="tree">
    203. 

  203. 				
    204. 

  204. 

  205. 

  206. 

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

  208. 	
    209. 

  209. </ul></li>
    210. 

  210. 

  211. 

  212. 

  213. 

  214. 

  215. 

  216. 

  217. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul>
    218. 

  218. 	
    219. 

  219. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/CRData">CRData</a></span></li>
    220. 

  220. 	
    221. 

  221. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/CRLFData">CRLFData</a></span></li>
    222. 

  222. 	
    223. 

  223. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/LFData">LFData</a></span></li>
    224. 

  224. 	
    225. 

  225. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/ZeroData">ZeroData</a></span></li>
    226. 

  226. 	
    227. 

  227. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getHost:port:fromAddress:">getHost:port:fromAddress:</a></span></li>
    228. 

  228. 	
    229. 

  229. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hostFromAddress:">hostFromAddress:</a></span></li>
    230. 

  230. 	
    231. 

  231. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/portFromAddress:">portFromAddress:</a></span></li>
    232. 

  232. 	
    233. 

  233. </ul></li>
    234. 

  234. 

  235. 

  236. 

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

  238. 	
    239. 

  239. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/acceptOnInterface:port:error:">acceptOnInterface:port:error:</a></span></li>
    240. 

  240. 	
    241. 

  241. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/acceptOnPort:error:">acceptOnPort:error:</a></span></li>
    242. 

  242. 	
    243. 

  243. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/autoDisconnectOnClosedReadStream">autoDisconnectOnClosedReadStream</a></span></li>
    244. 

  244. 	
    245. 

  245. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectToAddress:error:">connectToAddress:error:</a></span></li>
    246. 

  246. 	
    247. 

  247. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectToAddress:viaInterface:withTimeout:error:">connectToAddress:viaInterface:withTimeout:error:</a></span></li>
    248. 

  248. 	
    249. 

  249. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectToAddress:withTimeout:error:">connectToAddress:withTimeout:error:</a></span></li>
    250. 

  250. 	
    251. 

  251. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectToHost:onPort:error:">connectToHost:onPort:error:</a></span></li>
    252. 

  252. 	
    253. 

  253. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectToHost:onPort:viaInterface:withTimeout:error:">connectToHost:onPort:viaInterface:withTimeout:error:</a></span></li>
    254. 

  254. 	
    255. 

  255. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectToHost:onPort:withTimeout:error:">connectToHost:onPort:withTimeout:error:</a></span></li>
    256. 

  256. 	
    257. 

  257. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectedAddress">connectedAddress</a></span></li>
    258. 

  258. 	
    259. 

  259. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectedHost">connectedHost</a></span></li>
    260. 

  260. 	
    261. 

  261. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectedPort">connectedPort</a></span></li>
    262. 

  262. 	
    263. 

  263. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/delegate">delegate</a></span></li>
    264. 

  264. 	
    265. 

  265. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/delegateQueue">delegateQueue</a></span></li>
    266. 

  266. 	
    267. 

  267. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/disconnect">disconnect</a></span></li>
    268. 

  268. 	
    269. 

  269. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/disconnectAfterReading">disconnectAfterReading</a></span></li>
    270. 

  270. 	
    271. 

  271. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/disconnectAfterReadingAndWriting">disconnectAfterReadingAndWriting</a></span></li>
    272. 

  272. 	
    273. 

  273. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/disconnectAfterWriting">disconnectAfterWriting</a></span></li>
    274. 

  274. 	
    275. 

  275. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/enableBackgroundingOnSocket">enableBackgroundingOnSocket</a></span></li>
    276. 

  276. 	
    277. 

  277. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getDelegate:delegateQueue:">getDelegate:delegateQueue:</a></span></li>
    278. 

  278. 	
    279. 

  279. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/init">init</a></span></li>
    280. 

  280. 	
    281. 

  281. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithDelegate:delegateQueue:">initWithDelegate:delegateQueue:</a></span></li>
    282. 

  282. 	
    283. 

  283. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithDelegate:delegateQueue:socketQueue:">initWithDelegate:delegateQueue:socketQueue:</a></span></li>
    284. 

  284. 	
    285. 

  285. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithSocketQueue:">initWithSocketQueue:</a></span></li>
    286. 

  286. 	
    287. 

  287. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isConnected">isConnected</a></span></li>
    288. 

  288. 	
    289. 

  289. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isDisconnected">isDisconnected</a></span></li>
    290. 

  290. 	
    291. 

  291. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isIPv4">isIPv4</a></span></li>
    292. 

  292. 	
    293. 

  293. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isIPv4Enabled">isIPv4Enabled</a></span></li>
    294. 

  294. 	
    295. 

  295. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isIPv4PreferredOverIPv6">isIPv4PreferredOverIPv6</a></span></li>
    296. 

  296. 	
    297. 

  297. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isIPv6">isIPv6</a></span></li>
    298. 

  298. 	
    299. 

  299. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isIPv6Enabled">isIPv6Enabled</a></span></li>
    300. 

  300. 	
    301. 

  301. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isSecure">isSecure</a></span></li>
    302. 

  302. 	
    303. 

  303. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/localAddress">localAddress</a></span></li>
    304. 

  304. 	
    305. 

  305. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/localHost">localHost</a></span></li>
    306. 

  306. 	
    307. 

  307. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/localPort">localPort</a></span></li>
    308. 

  308. 	
    309. 

  309. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/performBlock:">performBlock:</a></span></li>
    310. 

  310. 	
    311. 

  311. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/progressOfReadReturningTag:bytesDone:total:">progressOfReadReturningTag:bytesDone:total:</a></span></li>
    312. 

  312. 	
    313. 

  313. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/progressOfWriteReturningTag:bytesDone:total:">progressOfWriteReturningTag:bytesDone:total:</a></span></li>
    314. 

  314. 	
    315. 

  315. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:">readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:</a></span></li>
    316. 

  316. 	
    317. 

  317. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readDataToData:withTimeout:buffer:bufferOffset:tag:">readDataToData:withTimeout:buffer:bufferOffset:tag:</a></span></li>
    318. 

  318. 	
    319. 

  319. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readDataToData:withTimeout:maxLength:tag:">readDataToData:withTimeout:maxLength:tag:</a></span></li>
    320. 

  320. 	
    321. 

  321. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readDataToData:withTimeout:tag:">readDataToData:withTimeout:tag:</a></span></li>
    322. 

  322. 	
    323. 

  323. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readDataToLength:withTimeout:buffer:bufferOffset:tag:">readDataToLength:withTimeout:buffer:bufferOffset:tag:</a></span></li>
    324. 

  324. 	
    325. 

  325. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readDataToLength:withTimeout:tag:">readDataToLength:withTimeout:tag:</a></span></li>
    326. 

  326. 	
    327. 

  327. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readDataWithTimeout:buffer:bufferOffset:maxLength:tag:">readDataWithTimeout:buffer:bufferOffset:maxLength:tag:</a></span></li>
    328. 

  328. 	
    329. 

  329. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readDataWithTimeout:buffer:bufferOffset:tag:">readDataWithTimeout:buffer:bufferOffset:tag:</a></span></li>
    330. 

  330. 	
    331. 

  331. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readDataWithTimeout:tag:">readDataWithTimeout:tag:</a></span></li>
    332. 

  332. 	
    333. 

  333. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readStream">readStream</a></span></li>
    334. 

  334. 	
    335. 

  335. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setAutoDisconnectOnClosedReadStream:">setAutoDisconnectOnClosedReadStream:</a></span></li>
    336. 

  336. 	
    337. 

  337. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setDelegate:">setDelegate:</a></span></li>
    338. 

  338. 	
    339. 

  339. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setDelegate:delegateQueue:">setDelegate:delegateQueue:</a></span></li>
    340. 

  340. 	
    341. 

  341. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setDelegateQueue:">setDelegateQueue:</a></span></li>
    342. 

  342. 	
    343. 

  343. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setIPv4Enabled:">setIPv4Enabled:</a></span></li>
    344. 

  344. 	
    345. 

  345. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setIPv6Enabled:">setIPv6Enabled:</a></span></li>
    346. 

  346. 	
    347. 

  347. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setPreferIPv4OverIPv6:">setPreferIPv4OverIPv6:</a></span></li>
    348. 

  348. 	
    349. 

  349. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setUserData:">setUserData:</a></span></li>
    350. 

  350. 	
    351. 

  351. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket4FD">socket4FD</a></span></li>
    352. 

  352. 	
    353. 

  353. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socket6FD">socket6FD</a></span></li>
    354. 

  354. 	
    355. 

  355. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/socketFD">socketFD</a></span></li>
    356. 

  356. 	
    357. 

  357. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sslContext">sslContext</a></span></li>
    358. 

  358. 	
    359. 

  359. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/startTLS:">startTLS:</a></span></li>
    360. 

  360. 	
    361. 

  361. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/synchronouslySetDelegate:">synchronouslySetDelegate:</a></span></li>
    362. 

  362. 	
    363. 

  363. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/synchronouslySetDelegate:delegateQueue:">synchronouslySetDelegate:delegateQueue:</a></span></li>
    364. 

  364. 	
    365. 

  365. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/synchronouslySetDelegateQueue:">synchronouslySetDelegateQueue:</a></span></li>
    366. 

  366. 	
    367. 

  367. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userData">userData</a></span></li>
    368. 

  368. 	
    369. 

  369. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/writeData:withTimeout:tag:">writeData:withTimeout:tag:</a></span></li>
    370. 

  370. 	
    371. 

  371. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/writeStream">writeStream</a></span></li>
    372. 

  372. 	
    373. 

  373. </ul></li>
    374. 

  374. 

  375. 

  376. 			</ul>
    377. 

  377. 		</nav>
    378. 

  378. 		<article>
    379. 

  379. 			<div id="contents" class="isShowingTOC" role="main">
    380. 

  380. 				<a title="GCDAsyncSocket Class Reference" name="top"></a>
    381. 

  381. 				<div class="main-navigation navigation-top">
    382. 

  382. 					<ul>
    383. 

  383. 	<li><a href="../index.html">Index</a></li>
    384. 

  384. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    385. 

  385. </ul>
    386. 

  386. 				</div>
    387. 

  387. 				<div id="header">
    388. 

  388. 					<div class="section-header">
    389. 

  389. 						<h1 class="title title-header">GCDAsyncSocket Class Reference</h1>
    390. 

  390. 					</div>		
    391. 

  391. 				</div>
    392. 

  392. 				<div id="container">	
    393. 

  393. 					
    394. 

  394. 					<div class="section section-specification"><table cellspacing="0"><tbody>
    395. 

  395. 						<tr>
    396. 

  396. 	<td class="specification-title">Inherits from</td>
    397. 

  397. 	<td class="specification-value">NSObject</td>
    398. 

  398. </tr><tr>
    399. 

  399. 	<td class="specification-title">Declared in</td>
    400. 

  400. 	<td class="specification-value">GCDAsyncSocket.h</td>
    401. 

  401. </tr>
    402. 

  402. 						</tbody></table></div>
    403. 

  403. 					
    404. 

  404. 					
    405. 

  405. 					
    406. 

  406. 					
    407. 

  407. 					
    408. 

  408. 					
    409. 

  409. 					<div class="section section-tasks">
    410. 

  410. 						<a title="Tasks" name="tasks"></a>
    411. 

  411. 						<h2 class="subtitle subtitle-tasks">Tasks</h2>
    412. 

  412. 						
    413. 

  413. 						
    414. 

  414. 						
    415. 

  415. 						
    416. 

  416. 

  417. 						<ul class="task-list">
    418. 

  418. 							<li>
    419. 

  419. 	<span class="tooltip">
    420. 

  420. 		<code><a href="#//api/name/init">&ndash;&nbsp;init</a></code>
    421. 

  421. 		<span class="tooltip"><p>GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> uses the standard <a href="#//api/name/delegate">delegate</a> paradigm,<br/>
    422. 

  422. but executes all <a href="#//api/name/delegate">delegate</a> callbacks on a given <a href="#//api/name/delegate">delegate</a> dispatch queue.<br/>
    423. 

  423. This allows for maximum concurrency, while at the same time providing easy thread safety.</p></span>
    424. 

  424. 	</span>
    425. 

  425. 	
    426. 

  426. 	
    427. 

  427. </li><li>
    428. 

  428. 	<span class="tooltip">
    429. 

  429. 		<code><a href="#//api/name/initWithSocketQueue:">&ndash;&nbsp;initWithSocketQueue:</a></code>
    430. 

  430. 		
    431. 

  431. 	</span>
    432. 

  432. 	
    433. 

  433. 	
    434. 

  434. </li><li>
    435. 

  435. 	<span class="tooltip">
    436. 

  436. 		<code><a href="#//api/name/initWithDelegate:delegateQueue:">&ndash;&nbsp;initWithDelegate:delegateQueue:</a></code>
    437. 

  437. 		
    438. 

  438. 	</span>
    439. 

  439. 	
    440. 

  440. 	
    441. 

  441. </li><li>
    442. 

  442. 	<span class="tooltip">
    443. 

  443. 		<code><a href="#//api/name/initWithDelegate:delegateQueue:socketQueue:">&ndash;&nbsp;initWithDelegate:delegateQueue:socketQueue:</a></code>
    444. 

  444. 		
    445. 

  445. 	</span>
    446. 

  446. 	
    447. 

  447. 	
    448. 

  448. </li><li>
    449. 

  449. 	<span class="tooltip">
    450. 

  450. 		<code><a href="#//api/name/delegate">&ndash;&nbsp;delegate</a></code>
    451. 

  451. 		
    452. 

  452. 	</span>
    453. 

  453. 	
    454. 

  454. 	
    455. 

  455. </li><li>
    456. 

  456. 	<span class="tooltip">
    457. 

  457. 		<code><a href="#//api/name/setDelegate:">&ndash;&nbsp;setDelegate:</a></code>
    458. 

  458. 		
    459. 

  459. 	</span>
    460. 

  460. 	
    461. 

  461. 	
    462. 

  462. </li><li>
    463. 

  463. 	<span class="tooltip">
    464. 

  464. 		<code><a href="#//api/name/synchronouslySetDelegate:">&ndash;&nbsp;synchronouslySetDelegate:</a></code>
    465. 

  465. 		
    466. 

  466. 	</span>
    467. 

  467. 	
    468. 

  468. 	
    469. 

  469. </li><li>
    470. 

  470. 	<span class="tooltip">
    471. 

  471. 		<code><a href="#//api/name/delegateQueue">&ndash;&nbsp;delegateQueue</a></code>
    472. 

  472. 		
    473. 

  473. 	</span>
    474. 

  474. 	
    475. 

  475. 	
    476. 

  476. </li><li>
    477. 

  477. 	<span class="tooltip">
    478. 

  478. 		<code><a href="#//api/name/setDelegateQueue:">&ndash;&nbsp;setDelegateQueue:</a></code>
    479. 

  479. 		
    480. 

  480. 	</span>
    481. 

  481. 	
    482. 

  482. 	
    483. 

  483. </li><li>
    484. 

  484. 	<span class="tooltip">
    485. 

  485. 		<code><a href="#//api/name/synchronouslySetDelegateQueue:">&ndash;&nbsp;synchronouslySetDelegateQueue:</a></code>
    486. 

  486. 		
    487. 

  487. 	</span>
    488. 

  488. 	
    489. 

  489. 	
    490. 

  490. </li><li>
    491. 

  491. 	<span class="tooltip">
    492. 

  492. 		<code><a href="#//api/name/getDelegate:delegateQueue:">&ndash;&nbsp;getDelegate:delegateQueue:</a></code>
    493. 

  493. 		
    494. 

  494. 	</span>
    495. 

  495. 	
    496. 

  496. 	
    497. 

  497. </li><li>
    498. 

  498. 	<span class="tooltip">
    499. 

  499. 		<code><a href="#//api/name/setDelegate:delegateQueue:">&ndash;&nbsp;setDelegate:delegateQueue:</a></code>
    500. 

  500. 		
    501. 

  501. 	</span>
    502. 

  502. 	
    503. 

  503. 	
    504. 

  504. </li><li>
    505. 

  505. 	<span class="tooltip">
    506. 

  506. 		<code><a href="#//api/name/synchronouslySetDelegate:delegateQueue:">&ndash;&nbsp;synchronouslySetDelegate:delegateQueue:</a></code>
    507. 

  507. 		
    508. 

  508. 	</span>
    509. 

  509. 	
    510. 

  510. 	
    511. 

  511. </li><li>
    512. 

  512. 	<span class="tooltip">
    513. 

  513. 		<code><a href="#//api/name/autoDisconnectOnClosedReadStream">&ndash;&nbsp;autoDisconnectOnClosedReadStream</a></code>
    514. 

  514. 		<span class="tooltip"><p>Traditionally sockets are not closed until the conversation is over.<br/>
    515. 

  515. However, it is technically possible for the remote enpoint to close its write stream.<br/>
    516. 

  516. Our socket would then be notified that there is no more data to be read,<br/>
    517. 

  517. but our socket would still be writeable and the remote endpoint could continue to receive our data.</p></span>
    518. 

  518. 	</span>
    519. 

  519. 	
    520. 

  520. 	
    521. 

  521. </li><li>
    522. 

  522. 	<span class="tooltip">
    523. 

  523. 		<code><a href="#//api/name/setAutoDisconnectOnClosedReadStream:">&ndash;&nbsp;setAutoDisconnectOnClosedReadStream:</a></code>
    524. 

  524. 		
    525. 

  525. 	</span>
    526. 

  526. 	
    527. 

  527. 	
    528. 

  528. </li><li>
    529. 

  529. 	<span class="tooltip">
    530. 

  530. 		<code><a href="#//api/name/isIPv4Enabled">&ndash;&nbsp;isIPv4Enabled</a></code>
    531. 

  531. 		<span class="tooltip"><p>By default, both IPv4 and IPv6 are enabled.</p></span>
    532. 

  532. 	</span>
    533. 

  533. 	
    534. 

  534. 	
    535. 

  535. </li><li>
    536. 

  536. 	<span class="tooltip">
    537. 

  537. 		<code><a href="#//api/name/setIPv4Enabled:">&ndash;&nbsp;setIPv4Enabled:</a></code>
    538. 

  538. 		
    539. 

  539. 	</span>
    540. 

  540. 	
    541. 

  541. 	
    542. 

  542. </li><li>
    543. 

  543. 	<span class="tooltip">
    544. 

  544. 		<code><a href="#//api/name/isIPv6Enabled">&ndash;&nbsp;isIPv6Enabled</a></code>
    545. 

  545. 		
    546. 

  546. 	</span>
    547. 

  547. 	
    548. 

  548. 	
    549. 

  549. </li><li>
    550. 

  550. 	<span class="tooltip">
    551. 

  551. 		<code><a href="#//api/name/setIPv6Enabled:">&ndash;&nbsp;setIPv6Enabled:</a></code>
    552. 

  552. 		
    553. 

  553. 	</span>
    554. 

  554. 	
    555. 

  555. 	
    556. 

  556. </li><li>
    557. 

  557. 	<span class="tooltip">
    558. 

  558. 		<code><a href="#//api/name/isIPv4PreferredOverIPv6">&ndash;&nbsp;isIPv4PreferredOverIPv6</a></code>
    559. 

  559. 		
    560. 

  560. 	</span>
    561. 

  561. 	
    562. 

  562. 	
    563. 

  563. </li><li>
    564. 

  564. 	<span class="tooltip">
    565. 

  565. 		<code><a href="#//api/name/setPreferIPv4OverIPv6:">&ndash;&nbsp;setPreferIPv4OverIPv6:</a></code>
    566. 

  566. 		
    567. 

  567. 	</span>
    568. 

  568. 	
    569. 

  569. 	
    570. 

  570. </li><li>
    571. 

  571. 	<span class="tooltip">
    572. 

  572. 		<code><a href="#//api/name/userData">&ndash;&nbsp;userData</a></code>
    573. 

  573. 		<span class="tooltip"><p>User data allows you to associate arbitrary information with the socket.<br/>
    574. 

  574. This data is not used internally by socket in any way.</p></span>
    575. 

  575. 	</span>
    576. 

  576. 	
    577. 

  577. 	
    578. 

  578. </li><li>
    579. 

  579. 	<span class="tooltip">
    580. 

  580. 		<code><a href="#//api/name/setUserData:">&ndash;&nbsp;setUserData:</a></code>
    581. 

  581. 		
    582. 

  582. 	</span>
    583. 

  583. 	
    584. 

  584. 	
    585. 

  585. </li><li>
    586. 

  586. 	<span class="tooltip">
    587. 

  587. 		<code><a href="#//api/name/acceptOnPort:error:">&ndash;&nbsp;acceptOnPort:error:</a></code>
    588. 

  588. 		<span class="tooltip"><p>Tells the socket to begin listening and accepting connections on the given port.<br/>
    589. 

  589. When a connection is accepted, a new instance of GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> will be spawned to handle it,<br/>
    590. 

  590. and the socket:didAcceptNewSocket: <a href="#//api/name/delegate">delegate</a> method will be invoked.</p></span>
    591. 

  591. 	</span>
    592. 

  592. 	
    593. 

  593. 	
    594. 

  594. </li><li>
    595. 

  595. 	<span class="tooltip">
    596. 

  596. 		<code><a href="#//api/name/acceptOnInterface:port:error:">&ndash;&nbsp;acceptOnInterface:port:error:</a></code>
    597. 

  597. 		<span class="tooltip"><p>This method is the same as <a href="#//api/name/acceptOnPort:error:">acceptOnPort:error:</a> with the<br/>
    598. 

  598. additional option of specifying which interface to listen on.</p></span>
    599. 

  599. 	</span>
    600. 

  600. 	
    601. 

  601. 	
    602. 

  602. </li><li>
    603. 

  603. 	<span class="tooltip">
    604. 

  604. 		<code><a href="#//api/name/connectToHost:onPort:error:">&ndash;&nbsp;connectToHost:onPort:error:</a></code>
    605. 

  605. 		<span class="tooltip"><p>Connects to the given host and port.</p></span>
    606. 

  606. 	</span>
    607. 

  607. 	
    608. 

  608. 	
    609. 

  609. </li><li>
    610. 

  610. 	<span class="tooltip">
    611. 

  611. 		<code><a href="#//api/name/connectToHost:onPort:withTimeout:error:">&ndash;&nbsp;connectToHost:onPort:withTimeout:error:</a></code>
    612. 

  612. 		<span class="tooltip"><p>Connects to the given host and port with an optional timeout.</p></span>
    613. 

  613. 	</span>
    614. 

  614. 	
    615. 

  615. 	
    616. 

  616. </li><li>
    617. 

  617. 	<span class="tooltip">
    618. 

  618. 		<code><a href="#//api/name/connectToHost:onPort:viaInterface:withTimeout:error:">&ndash;&nbsp;connectToHost:onPort:viaInterface:withTimeout:error:</a></code>
    619. 

  619. 		<span class="tooltip"><p>Connects to the given host &amp; port, via the optional interface, with an optional timeout.</p></span>
    620. 

  620. 	</span>
    621. 

  621. 	
    622. 

  622. 	
    623. 

  623. </li><li>
    624. 

  624. 	<span class="tooltip">
    625. 

  625. 		<code><a href="#//api/name/connectToAddress:error:">&ndash;&nbsp;connectToAddress:error:</a></code>
    626. 

  626. 		<span class="tooltip"><p>Connects to the given address, specified as a sockaddr structure wrapped in a NSData object.<br/>
    627. 

  627. For example, a NSData object returned from NSNetService&rsquo;s addresses method.</p></span>
    628. 

  628. 	</span>
    629. 

  629. 	
    630. 

  630. 	
    631. 

  631. </li><li>
    632. 

  632. 	<span class="tooltip">
    633. 

  633. 		<code><a href="#//api/name/connectToAddress:withTimeout:error:">&ndash;&nbsp;connectToAddress:withTimeout:error:</a></code>
    634. 

  634. 		<span class="tooltip"><p>This method is the same as <a href="#//api/name/connectToAddress:error:">connectToAddress:error:</a> with an additional timeout option.<br/>
    635. 

  635. To not time out use a negative time interval, or simply use the <a href="#//api/name/connectToAddress:error:">connectToAddress:error:</a> method.</p></span>
    636. 

  636. 	</span>
    637. 

  637. 	
    638. 

  638. 	
    639. 

  639. </li><li>
    640. 

  640. 	<span class="tooltip">
    641. 

  641. 		<code><a href="#//api/name/connectToAddress:viaInterface:withTimeout:error:">&ndash;&nbsp;connectToAddress:viaInterface:withTimeout:error:</a></code>
    642. 

  642. 		<span class="tooltip"><p>Connects to the given address, using the specified interface and timeout.</p></span>
    643. 

  643. 	</span>
    644. 

  644. 	
    645. 

  645. 	
    646. 

  646. </li><li>
    647. 

  647. 	<span class="tooltip">
    648. 

  648. 		<code><a href="#//api/name/disconnect">&ndash;&nbsp;disconnect</a></code>
    649. 

  649. 		<span class="tooltip"><p>Disconnects immediately (synchronously). Any pending reads or writes are dropped.</p></span>
    650. 

  650. 	</span>
    651. 

  651. 	
    652. 

  652. 	
    653. 

  653. </li><li>
    654. 

  654. 	<span class="tooltip">
    655. 

  655. 		<code><a href="#//api/name/disconnectAfterReading">&ndash;&nbsp;disconnectAfterReading</a></code>
    656. 

  656. 		<span class="tooltip"><p>Disconnects after all pending reads have completed.<br/>
    657. 

  657. After calling this, the read and write methods will do nothing.<br/>
    658. 

  658. The socket will <a href="#//api/name/disconnect">disconnect</a> even if there are still pending writes.</p></span>
    659. 

  659. 	</span>
    660. 

  660. 	
    661. 

  661. 	
    662. 

  662. </li><li>
    663. 

  663. 	<span class="tooltip">
    664. 

  664. 		<code><a href="#//api/name/disconnectAfterWriting">&ndash;&nbsp;disconnectAfterWriting</a></code>
    665. 

  665. 		<span class="tooltip"><p>Disconnects after all pending writes have completed.<br/>
    666. 

  666. After calling this, the read and write methods will do nothing.<br/>
    667. 

  667. The socket will <a href="#//api/name/disconnect">disconnect</a> even if there are still pending reads.</p></span>
    668. 

  668. 	</span>
    669. 

  669. 	
    670. 

  670. 	
    671. 

  671. </li><li>
    672. 

  672. 	<span class="tooltip">
    673. 

  673. 		<code><a href="#//api/name/disconnectAfterReadingAndWriting">&ndash;&nbsp;disconnectAfterReadingAndWriting</a></code>
    674. 

  674. 		<span class="tooltip"><p>Disconnects after all pending reads and writes have completed.<br/>
    675. 

  675. After calling this, the read and write methods will do nothing.</p></span>
    676. 

  676. 	</span>
    677. 

  677. 	
    678. 

  678. 	
    679. 

  679. </li><li>
    680. 

  680. 	<span class="tooltip">
    681. 

  681. 		<code><a href="#//api/name/isDisconnected">&ndash;&nbsp;isDisconnected</a></code>
    682. 

  682. 		<span class="tooltip"><p>Returns whether the socket is disconnected or connected.</p></span>
    683. 

  683. 	</span>
    684. 

  684. 	
    685. 

  685. 	
    686. 

  686. </li><li>
    687. 

  687. 	<span class="tooltip">
    688. 

  688. 		<code><a href="#//api/name/isConnected">&ndash;&nbsp;isConnected</a></code>
    689. 

  689. 		
    690. 

  690. 	</span>
    691. 

  691. 	
    692. 

  692. 	
    693. 

  693. </li><li>
    694. 

  694. 	<span class="tooltip">
    695. 

  695. 		<code><a href="#//api/name/connectedHost">&ndash;&nbsp;connectedHost</a></code>
    696. 

  696. 		<span class="tooltip"><p>Returns the local or remote host and port to which this socket is connected, or nil and 0 if not connected.<br/>
    697. 

  697. The host will be an IP address.</p></span>
    698. 

  698. 	</span>
    699. 

  699. 	
    700. 

  700. 	
    701. 

  701. </li><li>
    702. 

  702. 	<span class="tooltip">
    703. 

  703. 		<code><a href="#//api/name/connectedPort">&ndash;&nbsp;connectedPort</a></code>
    704. 

  704. 		
    705. 

  705. 	</span>
    706. 

  706. 	
    707. 

  707. 	
    708. 

  708. </li><li>
    709. 

  709. 	<span class="tooltip">
    710. 

  710. 		<code><a href="#//api/name/localHost">&ndash;&nbsp;localHost</a></code>
    711. 

  711. 		
    712. 

  712. 	</span>
    713. 

  713. 	
    714. 

  714. 	
    715. 

  715. </li><li>
    716. 

  716. 	<span class="tooltip">
    717. 

  717. 		<code><a href="#//api/name/localPort">&ndash;&nbsp;localPort</a></code>
    718. 

  718. 		
    719. 

  719. 	</span>
    720. 

  720. 	
    721. 

  721. 	
    722. 

  722. </li><li>
    723. 

  723. 	<span class="tooltip">
    724. 

  724. 		<code><a href="#//api/name/connectedAddress">&ndash;&nbsp;connectedAddress</a></code>
    725. 

  725. 		<span class="tooltip"><p>Returns the local or remote address to which this socket is connected,<br/>
    726. 

  726. specified as a sockaddr structure wrapped in a NSData object.</p></span>
    727. 

  727. 	</span>
    728. 

  728. 	
    729. 

  729. 	
    730. 

  730. </li><li>
    731. 

  731. 	<span class="tooltip">
    732. 

  732. 		<code><a href="#//api/name/localAddress">&ndash;&nbsp;localAddress</a></code>
    733. 

  733. 		
    734. 

  734. 	</span>
    735. 

  735. 	
    736. 

  736. 	
    737. 

  737. </li><li>
    738. 

  738. 	<span class="tooltip">
    739. 

  739. 		<code><a href="#//api/name/isIPv4">&ndash;&nbsp;isIPv4</a></code>
    740. 

  740. 		<span class="tooltip"><p>Returns whether the socket is IPv4 or IPv6.<br/>
    741. 

  741. An accepting socket may be both.</p></span>
    742. 

  742. 	</span>
    743. 

  743. 	
    744. 

  744. 	
    745. 

  745. </li><li>
    746. 

  746. 	<span class="tooltip">
    747. 

  747. 		<code><a href="#//api/name/isIPv6">&ndash;&nbsp;isIPv6</a></code>
    748. 

  748. 		
    749. 

  749. 	</span>
    750. 

  750. 	
    751. 

  751. 	
    752. 

  752. </li><li>
    753. 

  753. 	<span class="tooltip">
    754. 

  754. 		<code><a href="#//api/name/isSecure">&ndash;&nbsp;isSecure</a></code>
    755. 

  755. 		<span class="tooltip"><p>Returns whether or not the socket has been secured via SSL/TLS.</p></span>
    756. 

  756. 	</span>
    757. 

  757. 	
    758. 

  758. 	
    759. 

  759. </li><li>
    760. 

  760. 	<span class="tooltip">
    761. 

  761. 		<code><a href="#//api/name/readDataWithTimeout:tag:">&ndash;&nbsp;readDataWithTimeout:tag:</a></code>
    762. 

  762. 		<span class="tooltip"><p>Reads the first available bytes that become available on the socket.</p></span>
    763. 

  763. 	</span>
    764. 

  764. 	
    765. 

  765. 	
    766. 

  766. </li><li>
    767. 

  767. 	<span class="tooltip">
    768. 

  768. 		<code><a href="#//api/name/readDataWithTimeout:buffer:bufferOffset:tag:">&ndash;&nbsp;readDataWithTimeout:buffer:bufferOffset:tag:</a></code>
    769. 

  769. 		<span class="tooltip"><p>Reads the first available bytes that become available on the socket.<br/>
    770. 

  770. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    771. 

  771. The given buffer will automatically be increased in size if needed.</p></span>
    772. 

  772. 	</span>
    773. 

  773. 	
    774. 

  774. 	
    775. 

  775. </li><li>
    776. 

  776. 	<span class="tooltip">
    777. 

  777. 		<code><a href="#//api/name/readDataWithTimeout:buffer:bufferOffset:maxLength:tag:">&ndash;&nbsp;readDataWithTimeout:buffer:bufferOffset:maxLength:tag:</a></code>
    778. 

  778. 		<span class="tooltip"><p>Reads the first available bytes that become available on the socket.<br/>
    779. 

  779. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    780. 

  780. The given buffer will automatically be increased in size if needed.<br/>
    781. 

  781. A maximum of length bytes will be read.</p></span>
    782. 

  782. 	</span>
    783. 

  783. 	
    784. 

  784. 	
    785. 

  785. </li><li>
    786. 

  786. 	<span class="tooltip">
    787. 

  787. 		<code><a href="#//api/name/readDataToLength:withTimeout:tag:">&ndash;&nbsp;readDataToLength:withTimeout:tag:</a></code>
    788. 

  788. 		<span class="tooltip"><p>Reads the given number of bytes.</p></span>
    789. 

  789. 	</span>
    790. 

  790. 	
    791. 

  791. 	
    792. 

  792. </li><li>
    793. 

  793. 	<span class="tooltip">
    794. 

  794. 		<code><a href="#//api/name/readDataToLength:withTimeout:buffer:bufferOffset:tag:">&ndash;&nbsp;readDataToLength:withTimeout:buffer:bufferOffset:tag:</a></code>
    795. 

  795. 		<span class="tooltip"><p>Reads the given number of bytes.<br/>
    796. 

  796. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    797. 

  797. The given buffer will automatically be increased in size if needed.</p></span>
    798. 

  798. 	</span>
    799. 

  799. 	
    800. 

  800. 	
    801. 

  801. </li><li>
    802. 

  802. 	<span class="tooltip">
    803. 

  803. 		<code><a href="#//api/name/readDataToData:withTimeout:tag:">&ndash;&nbsp;readDataToData:withTimeout:tag:</a></code>
    804. 

  804. 		<span class="tooltip"><p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p></span>
    805. 

  805. 	</span>
    806. 

  806. 	
    807. 

  807. 	
    808. 

  808. </li><li>
    809. 

  809. 	<span class="tooltip">
    810. 

  810. 		<code><a href="#//api/name/readDataToData:withTimeout:buffer:bufferOffset:tag:">&ndash;&nbsp;readDataToData:withTimeout:buffer:bufferOffset:tag:</a></code>
    811. 

  811. 		<span class="tooltip"><p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    812. 

  812. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    813. 

  813. The given buffer will automatically be increased in size if needed.</p></span>
    814. 

  814. 	</span>
    815. 

  815. 	
    816. 

  816. 	
    817. 

  817. </li><li>
    818. 

  818. 	<span class="tooltip">
    819. 

  819. 		<code><a href="#//api/name/readDataToData:withTimeout:maxLength:tag:">&ndash;&nbsp;readDataToData:withTimeout:maxLength:tag:</a></code>
    820. 

  820. 		<span class="tooltip"><p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p></span>
    821. 

  821. 	</span>
    822. 

  822. 	
    823. 

  823. 	
    824. 

  824. </li><li>
    825. 

  825. 	<span class="tooltip">
    826. 

  826. 		<code><a href="#//api/name/readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:">&ndash;&nbsp;readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:</a></code>
    827. 

  827. 		<span class="tooltip"><p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    828. 

  828. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    829. 

  829. The given buffer will automatically be increased in size if needed.</p></span>
    830. 

  830. 	</span>
    831. 

  831. 	
    832. 

  832. 	
    833. 

  833. </li><li>
    834. 

  834. 	<span class="tooltip">
    835. 

  835. 		<code><a href="#//api/name/progressOfReadReturningTag:bytesDone:total:">&ndash;&nbsp;progressOfReadReturningTag:bytesDone:total:</a></code>
    836. 

  836. 		<span class="tooltip"><p>Returns progress of the current read, from 0.0 to 1.0, or NaN if no current read (use isnan() to check).<br/>
    837. 

  837. The parameters &ldquo;tag&rdquo;, &ldquo;done&rdquo; and &ldquo;total&rdquo; will be filled in if they aren&rsquo;t NULL.</p></span>
    838. 

  838. 	</span>
    839. 

  839. 	
    840. 

  840. 	
    841. 

  841. </li><li>
    842. 

  842. 	<span class="tooltip">
    843. 

  843. 		<code><a href="#//api/name/writeData:withTimeout:tag:">&ndash;&nbsp;writeData:withTimeout:tag:</a></code>
    844. 

  844. 		<span class="tooltip"><p>Writes data to the socket, and calls the <a href="#//api/name/delegate">delegate</a> when finished.</p></span>
    845. 

  845. 	</span>
    846. 

  846. 	
    847. 

  847. 	
    848. 

  848. </li><li>
    849. 

  849. 	<span class="tooltip">
    850. 

  850. 		<code><a href="#//api/name/progressOfWriteReturningTag:bytesDone:total:">&ndash;&nbsp;progressOfWriteReturningTag:bytesDone:total:</a></code>
    851. 

  851. 		<span class="tooltip"><p>Returns progress of the current write, from 0.0 to 1.0, or NaN if no current write (use isnan() to check).<br/>
    852. 

  852. The parameters &ldquo;tag&rdquo;, &ldquo;done&rdquo; and &ldquo;total&rdquo; will be filled in if they aren&rsquo;t NULL.</p></span>
    853. 

  853. 	</span>
    854. 

  854. 	
    855. 

  855. 	
    856. 

  856. </li><li>
    857. 

  857. 	<span class="tooltip">
    858. 

  858. 		<code><a href="#//api/name/startTLS:">&ndash;&nbsp;startTLS:</a></code>
    859. 

  859. 		<span class="tooltip"><p>Secures the connection using SSL/TLS.</p></span>
    860. 

  860. 	</span>
    861. 

  861. 	
    862. 

  862. 	
    863. 

  863. </li><li>
    864. 

  864. 	<span class="tooltip">
    865. 

  865. 		<code><a href="#//api/name/performBlock:">&ndash;&nbsp;performBlock:</a></code>
    866. 

  866. 		<span class="tooltip"><p>It&rsquo;s not thread-safe to access certain variables from outside the socket&rsquo;s internal queue.</p></span>
    867. 

  867. 	</span>
    868. 

  868. 	
    869. 

  869. 	
    870. 

  870. </li><li>
    871. 

  871. 	<span class="tooltip">
    872. 

  872. 		<code><a href="#//api/name/socketFD">&ndash;&nbsp;socketFD</a></code>
    873. 

  873. 		<span class="tooltip"><p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    874. 

  874. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p></span>
    875. 

  875. 	</span>
    876. 

  876. 	
    877. 

  877. 	
    878. 

  878. </li><li>
    879. 

  879. 	<span class="tooltip">
    880. 

  880. 		<code><a href="#//api/name/socket4FD">&ndash;&nbsp;socket4FD</a></code>
    881. 

  881. 		
    882. 

  882. 	</span>
    883. 

  883. 	
    884. 

  884. 	
    885. 

  885. </li><li>
    886. 

  886. 	<span class="tooltip">
    887. 

  887. 		<code><a href="#//api/name/socket6FD">&ndash;&nbsp;socket6FD</a></code>
    888. 

  888. 		
    889. 

  889. 	</span>
    890. 

  890. 	
    891. 

  891. 	
    892. 

  892. </li><li>
    893. 

  893. 	<span class="tooltip">
    894. 

  894. 		<code><a href="#//api/name/readStream">&ndash;&nbsp;readStream</a></code>
    895. 

  895. 		<span class="tooltip"><p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    896. 

  896. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p></span>
    897. 

  897. 	</span>
    898. 

  898. 	
    899. 

  899. 	
    900. 

  900. </li><li>
    901. 

  901. 	<span class="tooltip">
    902. 

  902. 		<code><a href="#//api/name/writeStream">&ndash;&nbsp;writeStream</a></code>
    903. 

  903. 		
    904. 

  904. 	</span>
    905. 

  905. 	
    906. 

  906. 	
    907. 

  907. </li><li>
    908. 

  908. 	<span class="tooltip">
    909. 

  909. 		<code><a href="#//api/name/enableBackgroundingOnSocket">&ndash;&nbsp;enableBackgroundingOnSocket</a></code>
    910. 

  910. 		<span class="tooltip"><p>This method is only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    911. 

  911. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p></span>
    912. 

  912. 	</span>
    913. 

  913. 	
    914. 

  914. 	
    915. 

  915. </li><li>
    916. 

  916. 	<span class="tooltip">
    917. 

  917. 		<code><a href="#//api/name/sslContext">&ndash;&nbsp;sslContext</a></code>
    918. 

  918. 		<span class="tooltip"><p>This method is only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    919. 

  919. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p></span>
    920. 

  920. 	</span>
    921. 

  921. 	
    922. 

  922. 	
    923. 

  923. </li><li>
    924. 

  924. 	<span class="tooltip">
    925. 

  925. 		<code><a href="#//api/name/hostFromAddress:">+&nbsp;hostFromAddress:</a></code>
    926. 

  926. 		<span class="tooltip"><p>Extracting host and port information from raw address data.</p></span>
    927. 

  927. 	</span>
    928. 

  928. 	
    929. 

  929. 	
    930. 

  930. </li><li>
    931. 

  931. 	<span class="tooltip">
    932. 

  932. 		<code><a href="#//api/name/portFromAddress:">+&nbsp;portFromAddress:</a></code>
    933. 

  933. 		
    934. 

  934. 	</span>
    935. 

  935. 	
    936. 

  936. 	
    937. 

  937. </li><li>
    938. 

  938. 	<span class="tooltip">
    939. 

  939. 		<code><a href="#//api/name/getHost:port:fromAddress:">+&nbsp;getHost:port:fromAddress:</a></code>
    940. 

  940. 		
    941. 

  941. 	</span>
    942. 

  942. 	
    943. 

  943. 	
    944. 

  944. </li><li>
    945. 

  945. 	<span class="tooltip">
    946. 

  946. 		<code><a href="#//api/name/CRLFData">+&nbsp;CRLFData</a></code>
    947. 

  947. 		<span class="tooltip"><p>A few common line separators, for use with the readDataToData:&hellip; methods.</p></span>
    948. 

  948. 	</span>
    949. 

  949. 	
    950. 

  950. 	
    951. 

  951. </li><li>
    952. 

  952. 	<span class="tooltip">
    953. 

  953. 		<code><a href="#//api/name/CRData">+&nbsp;CRData</a></code>
    954. 

  954. 		
    955. 

  955. 	</span>
    956. 

  956. 	
    957. 

  957. 	
    958. 

  958. </li><li>
    959. 

  959. 	<span class="tooltip">
    960. 

  960. 		<code><a href="#//api/name/LFData">+&nbsp;LFData</a></code>
    961. 

  961. 		
    962. 

  962. 	</span>
    963. 

  963. 	
    964. 

  964. 	
    965. 

  965. </li><li>
    966. 

  966. 	<span class="tooltip">
    967. 

  967. 		<code><a href="#//api/name/ZeroData">+&nbsp;ZeroData</a></code>
    968. 

  968. 		
    969. 

  969. 	</span>
    970. 

  970. 	
    971. 

  971. 	
    972. 

  972. </li>
    973. 

  973. 						</ul>
    974. 

  974. 						
    975. 

  975. 					</div>
    976. 

  976. 					
    977. 

  977. 					
    978. 

  978. 					
    979. 

  979. 					
    980. 

  980. 					
    981. 

  981. 					
    982. 

  982. 					
    983. 

  983. 					<div class="section section-methods">
    984. 

  984. 						<a title="Class Methods" name="class_methods"></a>
    985. 

  985. 						<h2 class="subtitle subtitle-methods">Class Methods</h2>
    986. 

  986. 						
    987. 

  987. 						<div class="section-method">
    988. 

  988. 	<a name="//api/name/CRData" title="CRData"></a>
    989. 

  989. 	<h3 class="subsubtitle method-title">CRData</h3>
    990. 

  990. 	
    991. 

  991. 	
    992. 

  992. 

  993. 	<div class="method-subsection method-declaration"><code>+ (NSData *)CRData</code></div>
    994. 

  994. 

  995.     
    996. 

  996. </div>
    997. 

  997. 						
    998. 

  998. 						<div class="section-method">
    999. 

  999. 	<a name="//api/name/CRLFData" title="CRLFData"></a>
    1000. 

  1000. 	<h3 class="subsubtitle method-title">CRLFData</h3>
    1001. 

  1001. 	
    1002. 

  1002. 	
    1003. 

  1003. 	
    1004. 

  1004. 	<div class="method-subsection brief-description">
    1005. 

  1005. 		<p>A few common line separators, for use with the readDataToData:&hellip; methods.</p>
    1006. 

  1006. 	</div>		
    1007. 

  1007. 	
    1008. 

  1008.     
    1009. 

  1009. 

  1010. 	<div class="method-subsection method-declaration"><code>+ (NSData *)CRLFData</code></div>
    1011. 

  1011. 

  1012.     
    1013. 

  1013. 	
    1014. 

  1014. 	
    1015. 

  1015. 	
    1016. 

  1016. 	
    1017. 

  1017. 	
    1018. 

  1018. 	
    1019. 

  1019. 	
    1020. 

  1020. 	<div class="method-subsection discussion-section">
    1021. 

  1021. 		<h4 class="method-subtitle">Discussion</h4>
    1022. 

  1022. 		<p>A few common line separators, for use with the readDataToData:&hellip; methods.</p>
    1023. 

  1023. 	</div>
    1024. 

  1024. 	
    1025. 

  1025. 	
    1026. 

  1026. 	
    1027. 

  1027. 	
    1028. 

  1028. 	
    1029. 

  1029. 	
    1030. 

  1030. 	
    1031. 

  1031. 	<div class="method-subsection declared-in-section">
    1032. 

  1032. 		<h4 class="method-subtitle">Declared In</h4>
    1033. 

  1033. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1034. 

  1034. 	</div>				
    1035. 

  1035. 	
    1036. 

  1036. 	
    1037. 

  1037. </div>
    1038. 

  1038. 						
    1039. 

  1039. 						<div class="section-method">
    1040. 

  1040. 	<a name="//api/name/LFData" title="LFData"></a>
    1041. 

  1041. 	<h3 class="subsubtitle method-title">LFData</h3>
    1042. 

  1042. 	
    1043. 

  1043. 	
    1044. 

  1044. 

  1045. 	<div class="method-subsection method-declaration"><code>+ (NSData *)LFData</code></div>
    1046. 

  1046. 

  1047.     
    1048. 

  1048. </div>
    1049. 

  1049. 						
    1050. 

  1050. 						<div class="section-method">
    1051. 

  1051. 	<a name="//api/name/ZeroData" title="ZeroData"></a>
    1052. 

  1052. 	<h3 class="subsubtitle method-title">ZeroData</h3>
    1053. 

  1053. 	
    1054. 

  1054. 	
    1055. 

  1055. 

  1056. 	<div class="method-subsection method-declaration"><code>+ (NSData *)ZeroData</code></div>
    1057. 

  1057. 

  1058.     
    1059. 

  1059. </div>
    1060. 

  1060. 						
    1061. 

  1061. 						<div class="section-method">
    1062. 

  1062. 	<a name="//api/name/getHost:port:fromAddress:" title="getHost:port:fromAddress:"></a>
    1063. 

  1063. 	<h3 class="subsubtitle method-title">getHost:port:fromAddress:</h3>
    1064. 

  1064. 	
    1065. 

  1065. 	
    1066. 

  1066. 

  1067. 	<div class="method-subsection method-declaration"><code>+ (BOOL)getHost:(NSString **)<em>hostPtr</em> port:(uint16_t *)<em>portPtr</em> fromAddress:(NSData *)<em>address</em></code></div>
    1068. 

  1068. 

  1069.     
    1070. 

  1070. </div>
    1071. 

  1071. 						
    1072. 

  1072. 						<div class="section-method">
    1073. 

  1073. 	<a name="//api/name/hostFromAddress:" title="hostFromAddress:"></a>
    1074. 

  1074. 	<h3 class="subsubtitle method-title">hostFromAddress:</h3>
    1075. 

  1075. 	
    1076. 

  1076. 	
    1077. 

  1077. 	
    1078. 

  1078. 	<div class="method-subsection brief-description">
    1079. 

  1079. 		<p>Extracting host and port information from raw address data.</p>
    1080. 

  1080. 	</div>		
    1081. 

  1081. 	
    1082. 

  1082.     
    1083. 

  1083. 

  1084. 	<div class="method-subsection method-declaration"><code>+ (NSString *)hostFromAddress:(NSData *)<em>address</em></code></div>
    1085. 

  1085. 

  1086.     
    1087. 

  1087. 	
    1088. 

  1088. 	
    1089. 

  1089. 	
    1090. 

  1090. 	
    1091. 

  1091. 	
    1092. 

  1092. 	
    1093. 

  1093. 	
    1094. 

  1094. 	<div class="method-subsection discussion-section">
    1095. 

  1095. 		<h4 class="method-subtitle">Discussion</h4>
    1096. 

  1096. 		<p>Extracting host and port information from raw address data.</p>
    1097. 

  1097. 	</div>
    1098. 

  1098. 	
    1099. 

  1099. 	
    1100. 

  1100. 	
    1101. 

  1101. 	
    1102. 

  1102. 	
    1103. 

  1103. 	
    1104. 

  1104. 	
    1105. 

  1105. 	<div class="method-subsection declared-in-section">
    1106. 

  1106. 		<h4 class="method-subtitle">Declared In</h4>
    1107. 

  1107. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1108. 

  1108. 	</div>				
    1109. 

  1109. 	
    1110. 

  1110. 	
    1111. 

  1111. </div>
    1112. 

  1112. 						
    1113. 

  1113. 						<div class="section-method">
    1114. 

  1114. 	<a name="//api/name/portFromAddress:" title="portFromAddress:"></a>
    1115. 

  1115. 	<h3 class="subsubtitle method-title">portFromAddress:</h3>
    1116. 

  1116. 	
    1117. 

  1117. 	
    1118. 

  1118. 

  1119. 	<div class="method-subsection method-declaration"><code>+ (uint16_t)portFromAddress:(NSData *)<em>address</em></code></div>
    1120. 

  1120. 

  1121.     
    1122. 

  1122. </div>
    1123. 

  1123. 						
    1124. 

  1124. 					</div>
    1125. 

  1125. 					
    1126. 

  1126. 					
    1127. 

  1127. 					
    1128. 

  1128. 					<div class="section section-methods">
    1129. 

  1129. 						<a title="Instance Methods" name="instance_methods"></a>
    1130. 

  1130. 						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
    1131. 

  1131. 						
    1132. 

  1132. 						<div class="section-method">
    1133. 

  1133. 	<a name="//api/name/acceptOnInterface:port:error:" title="acceptOnInterface:port:error:"></a>
    1134. 

  1134. 	<h3 class="subsubtitle method-title">acceptOnInterface:port:error:</h3>
    1135. 

  1135. 	
    1136. 

  1136. 	
    1137. 

  1137. 	
    1138. 

  1138. 	<div class="method-subsection brief-description">
    1139. 

  1139. 		<p>This method is the same as <a href="#//api/name/acceptOnPort:error:">acceptOnPort:error:</a> with the<br/>
    1140. 

  1140. additional option of specifying which interface to listen on.</p>
    1141. 

  1141. 	</div>		
    1142. 

  1142. 	
    1143. 

  1143.     
    1144. 

  1144. 

  1145. 	<div class="method-subsection method-declaration"><code>- (BOOL)acceptOnInterface:(NSString *)<em>interface</em> port:(uint16_t)<em>port</em> error:(NSError **)<em>errPtr</em></code></div>
    1146. 

  1146. 

  1147.     
    1148. 

  1148. 	
    1149. 

  1149. 	
    1150. 

  1150. 	
    1151. 

  1151. 	
    1152. 

  1152. 	
    1153. 

  1153. 	
    1154. 

  1154. 	
    1155. 

  1155. 	<div class="method-subsection discussion-section">
    1156. 

  1156. 		<h4 class="method-subtitle">Discussion</h4>
    1157. 

  1157. 		<p>This method is the same as <a href="#//api/name/acceptOnPort:error:">acceptOnPort:error:</a> with the<br/>
    1158. 

  1158. additional option of specifying which interface to listen on.</p>
    1159. 

  1159. 

  1160. <p>For example, you could specify that the socket should only accept connections over ethernet,<br/>
    1161. 

  1161. and not other interfaces such as wifi.</p>
    1162. 

  1162. 

  1163. <p>The interface may be specified by name (e.g. &ldquo;en1&rdquo; or &ldquo;lo0&rdquo;) or by IP address (e.g. &ldquo;192.168.4.34&rdquo;).<br/>
    1164. 

  1164. You may also use the special strings &ldquo;localhost&rdquo; or &ldquo;loopback&rdquo; to specify that<br/>
    1165. 

  1165. the socket only accept connections from the local machine.</p>
    1166. 

  1166. 

  1167. <p>You can see the list of interfaces via the command line utility &ldquo;ifconfig&rdquo;,<br/>
    1168. 

  1168. or programmatically via the getifaddrs() function.</p>
    1169. 

  1169. 

  1170. <p>To accept connections on any interface pass nil, or simply use the <a href="#//api/name/acceptOnPort:error:">acceptOnPort:error:</a> method.</p>
    1171. 

  1171. 	</div>
    1172. 

  1172. 	
    1173. 

  1173. 	
    1174. 

  1174. 	
    1175. 

  1175. 	
    1176. 

  1176. 	
    1177. 

  1177. 	
    1178. 

  1178. 	
    1179. 

  1179. 	<div class="method-subsection declared-in-section">
    1180. 

  1180. 		<h4 class="method-subtitle">Declared In</h4>
    1181. 

  1181. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1182. 

  1182. 	</div>				
    1183. 

  1183. 	
    1184. 

  1184. 	
    1185. 

  1185. </div>
    1186. 

  1186. 						
    1187. 

  1187. 						<div class="section-method">
    1188. 

  1188. 	<a name="//api/name/acceptOnPort:error:" title="acceptOnPort:error:"></a>
    1189. 

  1189. 	<h3 class="subsubtitle method-title">acceptOnPort:error:</h3>
    1190. 

  1190. 	
    1191. 

  1191. 	
    1192. 

  1192. 	
    1193. 

  1193. 	<div class="method-subsection brief-description">
    1194. 

  1194. 		<p>Tells the socket to begin listening and accepting connections on the given port.<br/>
    1195. 

  1195. When a connection is accepted, a new instance of GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> will be spawned to handle it,<br/>
    1196. 

  1196. and the socket:didAcceptNewSocket: <a href="#//api/name/delegate">delegate</a> method will be invoked.</p>
    1197. 

  1197. 	</div>		
    1198. 

  1198. 	
    1199. 

  1199.     
    1200. 

  1200. 

  1201. 	<div class="method-subsection method-declaration"><code>- (BOOL)acceptOnPort:(uint16_t)<em>port</em> error:(NSError **)<em>errPtr</em></code></div>
    1202. 

  1202. 

  1203.     
    1204. 

  1204. 	
    1205. 

  1205. 	
    1206. 

  1206. 	
    1207. 

  1207. 	
    1208. 

  1208. 	
    1209. 

  1209. 	
    1210. 

  1210. 	
    1211. 

  1211. 	<div class="method-subsection discussion-section">
    1212. 

  1212. 		<h4 class="method-subtitle">Discussion</h4>
    1213. 

  1213. 		<p>Tells the socket to begin listening and accepting connections on the given port.<br/>
    1214. 

  1214. When a connection is accepted, a new instance of GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> will be spawned to handle it,<br/>
    1215. 

  1215. and the socket:didAcceptNewSocket: <a href="#//api/name/delegate">delegate</a> method will be invoked.</p>
    1216. 

  1216. 

  1217. <p>The socket will listen on all available interfaces (e.g. wifi, ethernet, etc)</p>
    1218. 

  1218. 	</div>
    1219. 

  1219. 	
    1220. 

  1220. 	
    1221. 

  1221. 	
    1222. 

  1222. 	
    1223. 

  1223. 	
    1224. 

  1224. 	
    1225. 

  1225. 	
    1226. 

  1226. 	<div class="method-subsection declared-in-section">
    1227. 

  1227. 		<h4 class="method-subtitle">Declared In</h4>
    1228. 

  1228. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1229. 

  1229. 	</div>				
    1230. 

  1230. 	
    1231. 

  1231. 	
    1232. 

  1232. </div>
    1233. 

  1233. 						
    1234. 

  1234. 						<div class="section-method">
    1235. 

  1235. 	<a name="//api/name/autoDisconnectOnClosedReadStream" title="autoDisconnectOnClosedReadStream"></a>
    1236. 

  1236. 	<h3 class="subsubtitle method-title">autoDisconnectOnClosedReadStream</h3>
    1237. 

  1237. 	
    1238. 

  1238. 	
    1239. 

  1239. 	
    1240. 

  1240. 	<div class="method-subsection brief-description">
    1241. 

  1241. 		<p>Traditionally sockets are not closed until the conversation is over.<br/>
    1242. 

  1242. However, it is technically possible for the remote enpoint to close its write stream.<br/>
    1243. 

  1243. Our socket would then be notified that there is no more data to be read,<br/>
    1244. 

  1244. but our socket would still be writeable and the remote endpoint could continue to receive our data.</p>
    1245. 

  1245. 	</div>		
    1246. 

  1246. 	
    1247. 

  1247.     
    1248. 

  1248. 

  1249. 	<div class="method-subsection method-declaration"><code>- (BOOL)autoDisconnectOnClosedReadStream</code></div>
    1250. 

  1250. 

  1251.     
    1252. 

  1252. 	
    1253. 

  1253. 	
    1254. 

  1254. 	
    1255. 

  1255. 	
    1256. 

  1256. 	
    1257. 

  1257. 	
    1258. 

  1258. 	
    1259. 

  1259. 	<div class="method-subsection discussion-section">
    1260. 

  1260. 		<h4 class="method-subtitle">Discussion</h4>
    1261. 

  1261. 		<p>Traditionally sockets are not closed until the conversation is over.<br/>
    1262. 

  1262. However, it is technically possible for the remote enpoint to close its write stream.<br/>
    1263. 

  1263. Our socket would then be notified that there is no more data to be read,<br/>
    1264. 

  1264. but our socket would still be writeable and the remote endpoint could continue to receive our data.</p>
    1265. 

  1265. 

  1266. <p>The argument for this confusing functionality stems from the idea that a client could shut down its<br/>
    1267. 

  1267. write stream after sending a request to the server, thus notifying the server there are to be no further requests.<br/>
    1268. 

  1268. In practice, however, this technique did little to help server developers.</p>
    1269. 

  1269. 

  1270. <p>To make matters worse, from a TCP perspective there is no way to tell the difference from a read stream close<br/>
    1271. 

  1271. and a full socket close. They both result in the TCP stack receiving a FIN packet. The only way to tell<br/>
    1272. 

  1272. is by continuing to write to the socket. If it was only a read stream close, then writes will continue to work.<br/>
    1273. 

  1273. Otherwise an error will be occur shortly (when the remote end sends us a RST packet).</p>
    1274. 

  1274. 

  1275. <p>In addition to the technical challenges and confusion, many high level socket/stream API&rsquo;s provide<br/>
    1276. 

  1276. no support for dealing with the problem. If the read stream is closed, the API immediately declares the<br/>
    1277. 

  1277. socket to be closed, and shuts down the write stream as well. In fact, this is what Apple&rsquo;s CFStream API does.<br/>
    1278. 

  1278. It might sound like poor design at first, but in fact it simplifies development.</p>
    1279. 

  1279. 

  1280. <p>The vast majority of the time if the read stream is closed it&rsquo;s because the remote endpoint closed its socket.<br/>
    1281. 

  1281. Thus it actually makes sense to close the socket at this point.<br/>
    1282. 

  1282. And in fact this is what most networking developers want and expect to happen.<br/>
    1283. 

  1283. However, if you are writing a server that interacts with a plethora of clients,<br/>
    1284. 

  1284. you might encounter a client that uses the discouraged technique of shutting down its write stream.<br/>
    1285. 

  1285. If this is the case, you can set this property to NO,<br/>
    1286. 

  1286. and make use of the socketDidCloseReadStream <a href="#//api/name/delegate">delegate</a> method.</p>
    1287. 

  1287. 

  1288. <p>The default value is YES.</p>
    1289. 

  1289. 	</div>
    1290. 

  1290. 	
    1291. 

  1291. 	
    1292. 

  1292. 	
    1293. 

  1293. 	
    1294. 

  1294. 	
    1295. 

  1295. 	
    1296. 

  1296. 	
    1297. 

  1297. 	<div class="method-subsection declared-in-section">
    1298. 

  1298. 		<h4 class="method-subtitle">Declared In</h4>
    1299. 

  1299. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1300. 

  1300. 	</div>				
    1301. 

  1301. 	
    1302. 

  1302. 	
    1303. 

  1303. </div>
    1304. 

  1304. 						
    1305. 

  1305. 						<div class="section-method">
    1306. 

  1306. 	<a name="//api/name/connectToAddress:error:" title="connectToAddress:error:"></a>
    1307. 

  1307. 	<h3 class="subsubtitle method-title">connectToAddress:error:</h3>
    1308. 

  1308. 	
    1309. 

  1309. 	
    1310. 

  1310. 	
    1311. 

  1311. 	<div class="method-subsection brief-description">
    1312. 

  1312. 		<p>Connects to the given address, specified as a sockaddr structure wrapped in a NSData object.<br/>
    1313. 

  1313. For example, a NSData object returned from NSNetService&rsquo;s addresses method.</p>
    1314. 

  1314. 	</div>		
    1315. 

  1315. 	
    1316. 

  1316.     
    1317. 

  1317. 

  1318. 	<div class="method-subsection method-declaration"><code>- (BOOL)connectToAddress:(NSData *)<em>remoteAddr</em> error:(NSError **)<em>errPtr</em></code></div>
    1319. 

  1319. 

  1320.     
    1321. 

  1321. 	
    1322. 

  1322. 	
    1323. 

  1323. 	
    1324. 

  1324. 	
    1325. 

  1325. 	
    1326. 

  1326. 	
    1327. 

  1327. 	
    1328. 

  1328. 	<div class="method-subsection discussion-section">
    1329. 

  1329. 		<h4 class="method-subtitle">Discussion</h4>
    1330. 

  1330. 		<p>Connects to the given address, specified as a sockaddr structure wrapped in a NSData object.<br/>
    1331. 

  1331. For example, a NSData object returned from NSNetService&rsquo;s addresses method.</p>
    1332. 

  1332. 

  1333. <p>If you have an existing struct sockaddr you can convert it to a NSData object like so:<br/>
    1334. 

  1334. struct sockaddr sa  -> NSData <em>dsa = [NSData dataWithBytes:&amp;remoteAddr length:remoteAddr.sa_len];<br/>
    1335. 

  1335. struct sockaddr </em>sa -> NSData *dsa = [NSData dataWithBytes:remoteAddr length:remoteAddr->sa_len];</p>
    1336. 

  1336. 

  1337. <p>This method invokes connectToAdd</p>
    1338. 

  1338. 	</div>
    1339. 

  1339. 	
    1340. 

  1340. 	
    1341. 

  1341. 	
    1342. 

  1342. 	
    1343. 

  1343. 	
    1344. 

  1344. 	
    1345. 

  1345. 	
    1346. 

  1346. 	<div class="method-subsection declared-in-section">
    1347. 

  1347. 		<h4 class="method-subtitle">Declared In</h4>
    1348. 

  1348. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1349. 

  1349. 	</div>				
    1350. 

  1350. 	
    1351. 

  1351. 	
    1352. 

  1352. </div>
    1353. 

  1353. 						
    1354. 

  1354. 						<div class="section-method">
    1355. 

  1355. 	<a name="//api/name/connectToAddress:viaInterface:withTimeout:error:" title="connectToAddress:viaInterface:withTimeout:error:"></a>
    1356. 

  1356. 	<h3 class="subsubtitle method-title">connectToAddress:viaInterface:withTimeout:error:</h3>
    1357. 

  1357. 	
    1358. 

  1358. 	
    1359. 

  1359. 	
    1360. 

  1360. 	<div class="method-subsection brief-description">
    1361. 

  1361. 		<p>Connects to the given address, using the specified interface and timeout.</p>
    1362. 

  1362. 	</div>		
    1363. 

  1363. 	
    1364. 

  1364.     
    1365. 

  1365. 

  1366. 	<div class="method-subsection method-declaration"><code>- (BOOL)connectToAddress:(NSData *)<em>remoteAddr</em> viaInterface:(NSString *)<em>interface</em> withTimeout:(NSTimeInterval)<em>timeout</em> error:(NSError **)<em>errPtr</em></code></div>
    1367. 

  1367. 

  1368.     
    1369. 

  1369. 	
    1370. 

  1370. 	
    1371. 

  1371. 	
    1372. 

  1372. 	
    1373. 

  1373. 	
    1374. 

  1374. 	
    1375. 

  1375. 	
    1376. 

  1376. 	<div class="method-subsection discussion-section">
    1377. 

  1377. 		<h4 class="method-subtitle">Discussion</h4>
    1378. 

  1378. 		<p>Connects to the given address, using the specified interface and timeout.</p>
    1379. 

  1379. 

  1380. <p>The address is specified as a sockaddr structure wrapped in a NSData object.<br/>
    1381. 

  1381. For example, a NSData object returned from NSNetService&rsquo;s addresses method.</p>
    1382. 

  1382. 

  1383. <p>If you have an existing struct sockaddr you can convert it to a NSData object like so:<br/>
    1384. 

  1384. struct sockaddr sa  -> NSData <em>dsa = [NSData dataWithBytes:&amp;remoteAddr length:remoteAddr.sa_len];<br/>
    1385. 

  1385. struct sockaddr </em>sa -> NSData *dsa = [NSData dataWithBytes:remoteAddr length:remoteAddr->sa_len];</p>
    1386. 

  1386. 

  1387. <p>The interface may be a name (e.g. &ldquo;en1&rdquo; or &ldquo;lo0&rdquo;) or the corresponding IP address (e.g. &ldquo;192.168.4.35&rdquo;).<br/>
    1388. 

  1388. The interface may also be used to specify the local port (see below).</p>
    1389. 

  1389. 

  1390. <p>The timeout is optional. To not time out use a negative time interval.</p>
    1391. 

  1391. 

  1392. <p>This method will return NO if an error is detected, and set the error pointer (if one was given).<br/>
    1393. 

  1393. Possible errors would be a nil host, invalid interface, or socket is already connected.</p>
    1394. 

  1394. 

  1395. <p>If no errors are detected, this method will start a background connect operation and immediately return YES.<br/>
    1396. 

  1396. The <a href="#//api/name/delegate">delegate</a> callbacks are used to notify you when the socket connects, or if the host was unreachable.</p>
    1397. 

  1397. 

  1398. <p>Since this class supports queued reads and writes, you can immediately start reading and/or writing.<br/>
    1399. 

  1399. All read/write operations will be queued, and upon socket connection,<br/>
    1400. 

  1400. the operations will be dequeued and processed in order.</p>
    1401. 

  1401. 

  1402. <p>The interface may optionally contain a port number at the end of the string, separated by a colon.<br/>
    1403. 

  1403. This allows you to specify the local port that should be used for the outgoing connection. (read paragraph to end)<br/>
    1404. 

  1404. To specify both interface and local port: &ldquo;en1:8082&rdquo; or &ldquo;192.168.4.35:2424&rdquo;.<br/>
    1405. 

  1405. To specify only local port: &ldquo;:8082&rdquo;.<br/>
    1406. 

  1406. Please note this is an advanced feature, and is somewhat hidden on purpose.<br/>
    1407. 

  1407. You should understand that 99.999% of the time you should NOT specify the local port for an outgoing connection.<br/>
    1408. 

  1408. If you think you need to, there is a very good chance you have a fundamental misunderstanding somewhere.<br/>
    1409. 

  1409. Local ports do NOT need to match remote ports. In fact, they almost never do.<br/>
    1410. 

  1410. This feature is here for networking professionals using very advanced techniques.</p>
    1411. 

  1411. 	</div>
    1412. 

  1412. 	
    1413. 

  1413. 	
    1414. 

  1414. 	
    1415. 

  1415. 	
    1416. 

  1416. 	
    1417. 

  1417. 	
    1418. 

  1418. 	
    1419. 

  1419. 	<div class="method-subsection declared-in-section">
    1420. 

  1420. 		<h4 class="method-subtitle">Declared In</h4>
    1421. 

  1421. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1422. 

  1422. 	</div>				
    1423. 

  1423. 	
    1424. 

  1424. 	
    1425. 

  1425. </div>
    1426. 

  1426. 						
    1427. 

  1427. 						<div class="section-method">
    1428. 

  1428. 	<a name="//api/name/connectToAddress:withTimeout:error:" title="connectToAddress:withTimeout:error:"></a>
    1429. 

  1429. 	<h3 class="subsubtitle method-title">connectToAddress:withTimeout:error:</h3>
    1430. 

  1430. 	
    1431. 

  1431. 	
    1432. 

  1432. 	
    1433. 

  1433. 	<div class="method-subsection brief-description">
    1434. 

  1434. 		<p>This method is the same as <a href="#//api/name/connectToAddress:error:">connectToAddress:error:</a> with an additional timeout option.<br/>
    1435. 

  1435. To not time out use a negative time interval, or simply use the <a href="#//api/name/connectToAddress:error:">connectToAddress:error:</a> method.</p>
    1436. 

  1436. 	</div>		
    1437. 

  1437. 	
    1438. 

  1438.     
    1439. 

  1439. 

  1440. 	<div class="method-subsection method-declaration"><code>- (BOOL)connectToAddress:(NSData *)<em>remoteAddr</em> withTimeout:(NSTimeInterval)<em>timeout</em> error:(NSError **)<em>errPtr</em></code></div>
    1441. 

  1441. 

  1442.     
    1443. 

  1443. 	
    1444. 

  1444. 	
    1445. 

  1445. 	
    1446. 

  1446. 	
    1447. 

  1447. 	
    1448. 

  1448. 	
    1449. 

  1449. 	
    1450. 

  1450. 	<div class="method-subsection discussion-section">
    1451. 

  1451. 		<h4 class="method-subtitle">Discussion</h4>
    1452. 

  1452. 		<p>This method is the same as <a href="#//api/name/connectToAddress:error:">connectToAddress:error:</a> with an additional timeout option.<br/>
    1453. 

  1453. To not time out use a negative time interval, or simply use the <a href="#//api/name/connectToAddress:error:">connectToAddress:error:</a> method.</p>
    1454. 

  1454. 	</div>
    1455. 

  1455. 	
    1456. 

  1456. 	
    1457. 

  1457. 	
    1458. 

  1458. 	
    1459. 

  1459. 	
    1460. 

  1460. 	
    1461. 

  1461. 	
    1462. 

  1462. 	<div class="method-subsection declared-in-section">
    1463. 

  1463. 		<h4 class="method-subtitle">Declared In</h4>
    1464. 

  1464. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1465. 

  1465. 	</div>				
    1466. 

  1466. 	
    1467. 

  1467. 	
    1468. 

  1468. </div>
    1469. 

  1469. 						
    1470. 

  1470. 						<div class="section-method">
    1471. 

  1471. 	<a name="//api/name/connectToHost:onPort:error:" title="connectToHost:onPort:error:"></a>
    1472. 

  1472. 	<h3 class="subsubtitle method-title">connectToHost:onPort:error:</h3>
    1473. 

  1473. 	
    1474. 

  1474. 	
    1475. 

  1475. 	
    1476. 

  1476. 	<div class="method-subsection brief-description">
    1477. 

  1477. 		<p>Connects to the given host and port.</p>
    1478. 

  1478. 	</div>		
    1479. 

  1479. 	
    1480. 

  1480.     
    1481. 

  1481. 

  1482. 	<div class="method-subsection method-declaration"><code>- (BOOL)connectToHost:(NSString *)<em>host</em> onPort:(uint16_t)<em>port</em> error:(NSError **)<em>errPtr</em></code></div>
    1483. 

  1483. 

  1484.     
    1485. 

  1485. 	
    1486. 

  1486. 	
    1487. 

  1487. 	
    1488. 

  1488. 	
    1489. 

  1489. 	
    1490. 

  1490. 	
    1491. 

  1491. 	
    1492. 

  1492. 	<div class="method-subsection discussion-section">
    1493. 

  1493. 		<h4 class="method-subtitle">Discussion</h4>
    1494. 

  1494. 		<p>Connects to the given host and port.</p>
    1495. 

  1495. 

  1496. <p>This method invokes <a href="#//api/name/connectToHost:onPort:viaInterface:withTimeout:error:">connectToHost:onPort:viaInterface:withTimeout:error:</a><br/>
    1497. 

  1497. and uses the default interface, and no timeout.</p>
    1498. 

  1498. 	</div>
    1499. 

  1499. 	
    1500. 

  1500. 	
    1501. 

  1501. 	
    1502. 

  1502. 	
    1503. 

  1503. 	
    1504. 

  1504. 	
    1505. 

  1505. 	
    1506. 

  1506. 	<div class="method-subsection declared-in-section">
    1507. 

  1507. 		<h4 class="method-subtitle">Declared In</h4>
    1508. 

  1508. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1509. 

  1509. 	</div>				
    1510. 

  1510. 	
    1511. 

  1511. 	
    1512. 

  1512. </div>
    1513. 

  1513. 						
    1514. 

  1514. 						<div class="section-method">
    1515. 

  1515. 	<a name="//api/name/connectToHost:onPort:viaInterface:withTimeout:error:" title="connectToHost:onPort:viaInterface:withTimeout:error:"></a>
    1516. 

  1516. 	<h3 class="subsubtitle method-title">connectToHost:onPort:viaInterface:withTimeout:error:</h3>
    1517. 

  1517. 	
    1518. 

  1518. 	
    1519. 

  1519. 	
    1520. 

  1520. 	<div class="method-subsection brief-description">
    1521. 

  1521. 		<p>Connects to the given host &amp; port, via the optional interface, with an optional timeout.</p>
    1522. 

  1522. 	</div>		
    1523. 

  1523. 	
    1524. 

  1524.     
    1525. 

  1525. 

  1526. 	<div class="method-subsection method-declaration"><code>- (BOOL)connectToHost:(NSString *)<em>host</em> onPort:(uint16_t)<em>port</em> viaInterface:(NSString *)<em>interface</em> withTimeout:(NSTimeInterval)<em>timeout</em> error:(NSError **)<em>errPtr</em></code></div>
    1527. 

  1527. 

  1528.     
    1529. 

  1529. 	
    1530. 

  1530. 	
    1531. 

  1531. 	
    1532. 

  1532. 	
    1533. 

  1533. 	
    1534. 

  1534. 	
    1535. 

  1535. 	
    1536. 

  1536. 	<div class="method-subsection discussion-section">
    1537. 

  1537. 		<h4 class="method-subtitle">Discussion</h4>
    1538. 

  1538. 		<p>Connects to the given host &amp; port, via the optional interface, with an optional timeout.</p>
    1539. 

  1539. 

  1540. <p>The host may be a domain name (e.g. &ldquo;deusty.com&rdquo;) or an IP address string (e.g. &ldquo;192.168.0.2&rdquo;).<br/>
    1541. 

  1541. The host may also be the special strings &ldquo;localhost&rdquo; or &ldquo;loopback&rdquo; to specify connecting<br/>
    1542. 

  1542. to a service on the local machine.</p>
    1543. 

  1543. 

  1544. <p>The interface may be a name (e.g. &ldquo;en1&rdquo; or &ldquo;lo0&rdquo;) or the corresponding IP address (e.g. &ldquo;192.168.4.35&rdquo;).<br/>
    1545. 

  1545. The interface may also be used to specify the local port (see below).</p>
    1546. 

  1546. 

  1547. <p>To not time out use a negative time interval.</p>
    1548. 

  1548. 

  1549. <p>This method will return NO if an error is detected, and set the error pointer (if one was given).<br/>
    1550. 

  1550. Possible errors would be a nil host, invalid interface, or socket is already connected.</p>
    1551. 

  1551. 

  1552. <p>If no errors are detected, this method will start a background connect operation and immediately return YES.<br/>
    1553. 

  1553. The <a href="#//api/name/delegate">delegate</a> callbacks are used to notify you when the socket connects, or if the host was unreachable.</p>
    1554. 

  1554. 

  1555. <p>Since this class supports queued reads and writes, you can immediately start reading and/or writing.<br/>
    1556. 

  1556. All read/write operations will be queued, and upon socket connection,<br/>
    1557. 

  1557. the operations will be dequeued and processed in order.</p>
    1558. 

  1558. 

  1559. <p>The interface may optionally contain a port number at the end of the string, separated by a colon.<br/>
    1560. 

  1560. This allows you to specify the local port that should be used for the outgoing connection. (read paragraph to end)<br/>
    1561. 

  1561. To specify both interface and local port: &ldquo;en1:8082&rdquo; or &ldquo;192.168.4.35:2424&rdquo;.<br/>
    1562. 

  1562. To specify only local port: &ldquo;:8082&rdquo;.<br/>
    1563. 

  1563. Please note this is an advanced feature, and is somewhat hidden on purpose.<br/>
    1564. 

  1564. You should understand that 99.999% of the time you should NOT specify the local port for an outgoing connection.<br/>
    1565. 

  1565. If you think you need to, there is a very good chance you have a fundamental misunderstanding somewhere.<br/>
    1566. 

  1566. Local ports do NOT need to match remote ports. In fact, they almost never do.<br/>
    1567. 

  1567. This feature is here for networking professionals using very advanced techniques.</p>
    1568. 

  1568. 	</div>
    1569. 

  1569. 	
    1570. 

  1570. 	
    1571. 

  1571. 	
    1572. 

  1572. 	
    1573. 

  1573. 	
    1574. 

  1574. 	
    1575. 

  1575. 	
    1576. 

  1576. 	<div class="method-subsection declared-in-section">
    1577. 

  1577. 		<h4 class="method-subtitle">Declared In</h4>
    1578. 

  1578. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1579. 

  1579. 	</div>				
    1580. 

  1580. 	
    1581. 

  1581. 	
    1582. 

  1582. </div>
    1583. 

  1583. 						
    1584. 

  1584. 						<div class="section-method">
    1585. 

  1585. 	<a name="//api/name/connectToHost:onPort:withTimeout:error:" title="connectToHost:onPort:withTimeout:error:"></a>
    1586. 

  1586. 	<h3 class="subsubtitle method-title">connectToHost:onPort:withTimeout:error:</h3>
    1587. 

  1587. 	
    1588. 

  1588. 	
    1589. 

  1589. 	
    1590. 

  1590. 	<div class="method-subsection brief-description">
    1591. 

  1591. 		<p>Connects to the given host and port with an optional timeout.</p>
    1592. 

  1592. 	</div>		
    1593. 

  1593. 	
    1594. 

  1594.     
    1595. 

  1595. 

  1596. 	<div class="method-subsection method-declaration"><code>- (BOOL)connectToHost:(NSString *)<em>host</em> onPort:(uint16_t)<em>port</em> withTimeout:(NSTimeInterval)<em>timeout</em> error:(NSError **)<em>errPtr</em></code></div>
    1597. 

  1597. 

  1598.     
    1599. 

  1599. 	
    1600. 

  1600. 	
    1601. 

  1601. 	
    1602. 

  1602. 	
    1603. 

  1603. 	
    1604. 

  1604. 	
    1605. 

  1605. 	
    1606. 

  1606. 	<div class="method-subsection discussion-section">
    1607. 

  1607. 		<h4 class="method-subtitle">Discussion</h4>
    1608. 

  1608. 		<p>Connects to the given host and port with an optional timeout.</p>
    1609. 

  1609. 

  1610. <p>This method invokes <a href="#//api/name/connectToHost:onPort:viaInterface:withTimeout:error:">connectToHost:onPort:viaInterface:withTimeout:error:</a> and uses the default interface.</p>
    1611. 

  1611. 	</div>
    1612. 

  1612. 	
    1613. 

  1613. 	
    1614. 

  1614. 	
    1615. 

  1615. 	
    1616. 

  1616. 	
    1617. 

  1617. 	
    1618. 

  1618. 	
    1619. 

  1619. 	<div class="method-subsection declared-in-section">
    1620. 

  1620. 		<h4 class="method-subtitle">Declared In</h4>
    1621. 

  1621. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1622. 

  1622. 	</div>				
    1623. 

  1623. 	
    1624. 

  1624. 	
    1625. 

  1625. </div>
    1626. 

  1626. 						
    1627. 

  1627. 						<div class="section-method">
    1628. 

  1628. 	<a name="//api/name/connectedAddress" title="connectedAddress"></a>
    1629. 

  1629. 	<h3 class="subsubtitle method-title">connectedAddress</h3>
    1630. 

  1630. 	
    1631. 

  1631. 	
    1632. 

  1632. 	
    1633. 

  1633. 	<div class="method-subsection brief-description">
    1634. 

  1634. 		<p>Returns the local or remote address to which this socket is connected,<br/>
    1635. 

  1635. specified as a sockaddr structure wrapped in a NSData object.</p>
    1636. 

  1636. 	</div>		
    1637. 

  1637. 	
    1638. 

  1638.     
    1639. 

  1639. 

  1640. 	<div class="method-subsection method-declaration"><code>- (NSData *)connectedAddress</code></div>
    1641. 

  1641. 

  1642.     
    1643. 

  1643. 	
    1644. 

  1644. 	
    1645. 

  1645. 	
    1646. 

  1646. 	
    1647. 

  1647. 	
    1648. 

  1648. 	
    1649. 

  1649. 	
    1650. 

  1650. 	<div class="method-subsection discussion-section">
    1651. 

  1651. 		<h4 class="method-subtitle">Discussion</h4>
    1652. 

  1652. 		<p>Returns the local or remote address to which this socket is connected,<br/>
    1653. 

  1653. specified as a sockaddr structure wrapped in a NSData object.</p>
    1654. 

  1654. 

  1655. <p>See also the <a href="#//api/name/connectedHost">connectedHost</a>, <a href="#//api/name/connectedPort">connectedPort</a>, <a href="#//api/name/localHost">localHost</a> and <a href="#//api/name/localPort">localPort</a> methods.</p>
    1656. 

  1656. 	</div>
    1657. 

  1657. 	
    1658. 

  1658. 	
    1659. 

  1659. 	
    1660. 

  1660. 	
    1661. 

  1661. 	
    1662. 

  1662. 	
    1663. 

  1663. 	
    1664. 

  1664. 	<div class="method-subsection declared-in-section">
    1665. 

  1665. 		<h4 class="method-subtitle">Declared In</h4>
    1666. 

  1666. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1667. 

  1667. 	</div>				
    1668. 

  1668. 	
    1669. 

  1669. 	
    1670. 

  1670. </div>
    1671. 

  1671. 						
    1672. 

  1672. 						<div class="section-method">
    1673. 

  1673. 	<a name="//api/name/connectedHost" title="connectedHost"></a>
    1674. 

  1674. 	<h3 class="subsubtitle method-title">connectedHost</h3>
    1675. 

  1675. 	
    1676. 

  1676. 	
    1677. 

  1677. 	
    1678. 

  1678. 	<div class="method-subsection brief-description">
    1679. 

  1679. 		<p>Returns the local or remote host and port to which this socket is connected, or nil and 0 if not connected.<br/>
    1680. 

  1680. The host will be an IP address.</p>
    1681. 

  1681. 	</div>		
    1682. 

  1682. 	
    1683. 

  1683.     
    1684. 

  1684. 

  1685. 	<div class="method-subsection method-declaration"><code>- (NSString *)connectedHost</code></div>
    1686. 

  1686. 

  1687.     
    1688. 

  1688. 	
    1689. 

  1689. 	
    1690. 

  1690. 	
    1691. 

  1691. 	
    1692. 

  1692. 	
    1693. 

  1693. 	
    1694. 

  1694. 	
    1695. 

  1695. 	<div class="method-subsection discussion-section">
    1696. 

  1696. 		<h4 class="method-subtitle">Discussion</h4>
    1697. 

  1697. 		<p>Returns the local or remote host and port to which this socket is connected, or nil and 0 if not connected.<br/>
    1698. 

  1698. The host will be an IP address.</p>
    1699. 

  1699. 	</div>
    1700. 

  1700. 	
    1701. 

  1701. 	
    1702. 

  1702. 	
    1703. 

  1703. 	
    1704. 

  1704. 	
    1705. 

  1705. 	
    1706. 

  1706. 	
    1707. 

  1707. 	<div class="method-subsection declared-in-section">
    1708. 

  1708. 		<h4 class="method-subtitle">Declared In</h4>
    1709. 

  1709. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1710. 

  1710. 	</div>				
    1711. 

  1711. 	
    1712. 

  1712. 	
    1713. 

  1713. </div>
    1714. 

  1714. 						
    1715. 

  1715. 						<div class="section-method">
    1716. 

  1716. 	<a name="//api/name/connectedPort" title="connectedPort"></a>
    1717. 

  1717. 	<h3 class="subsubtitle method-title">connectedPort</h3>
    1718. 

  1718. 	
    1719. 

  1719. 	
    1720. 

  1720. 

  1721. 	<div class="method-subsection method-declaration"><code>- (uint16_t)connectedPort</code></div>
    1722. 

  1722. 

  1723.     
    1724. 

  1724. </div>
    1725. 

  1725. 						
    1726. 

  1726. 						<div class="section-method">
    1727. 

  1727. 	<a name="//api/name/delegate" title="delegate"></a>
    1728. 

  1728. 	<h3 class="subsubtitle method-title">delegate</h3>
    1729. 

  1729. 	
    1730. 

  1730. 	
    1731. 

  1731. 

  1732. 	<div class="method-subsection method-declaration"><code>- (id)delegate</code></div>
    1733. 

  1733. 

  1734.     
    1735. 

  1735. </div>
    1736. 

  1736. 						
    1737. 

  1737. 						<div class="section-method">
    1738. 

  1738. 	<a name="//api/name/delegateQueue" title="delegateQueue"></a>
    1739. 

  1739. 	<h3 class="subsubtitle method-title">delegateQueue</h3>
    1740. 

  1740. 	
    1741. 

  1741. 	
    1742. 

  1742. 

  1743. 	<div class="method-subsection method-declaration"><code>- (dispatch_queue_t)delegateQueue</code></div>
    1744. 

  1744. 

  1745.     
    1746. 

  1746. </div>
    1747. 

  1747. 						
    1748. 

  1748. 						<div class="section-method">
    1749. 

  1749. 	<a name="//api/name/disconnect" title="disconnect"></a>
    1750. 

  1750. 	<h3 class="subsubtitle method-title">disconnect</h3>
    1751. 

  1751. 	
    1752. 

  1752. 	
    1753. 

  1753. 	
    1754. 

  1754. 	<div class="method-subsection brief-description">
    1755. 

  1755. 		<p>Disconnects immediately (synchronously). Any pending reads or writes are dropped.</p>
    1756. 

  1756. 	</div>		
    1757. 

  1757. 	
    1758. 

  1758.     
    1759. 

  1759. 

  1760. 	<div class="method-subsection method-declaration"><code>- (void)disconnect</code></div>
    1761. 

  1761. 

  1762.     
    1763. 

  1763. 	
    1764. 

  1764. 	
    1765. 

  1765. 	
    1766. 

  1766. 	
    1767. 

  1767. 	
    1768. 

  1768. 	
    1769. 

  1769. 	
    1770. 

  1770. 	<div class="method-subsection discussion-section">
    1771. 

  1771. 		<h4 class="method-subtitle">Discussion</h4>
    1772. 

  1772. 		<p>Disconnects immediately (synchronously). Any pending reads or writes are dropped.</p>
    1773. 

  1773. 

  1774. <p>If the socket is not already disconnected, an invocation to the socketDidDisconnect:withError: delegate method<br/>
    1775. 

  1775. will be queued onto the delegateQueue asynchronously (behind any previously queued delegate methods).<br/>
    1776. 

  1776. In other words, the disconnected delegate method will be invoked sometime shortly after this method returns.</p>
    1777. 

  1777. 

  1778. <p>Please note the recommended way of releasing a GCDAsyncSocket instance (e.g. in a dealloc method)<br/>
    1779. 

  1779. [asyncSocket setDelegate:nil];<br/>
    1780. 

  1780. [asyncSocket disconnect];<br/>
    1781. 

  1781. [asyncSocket release];</p>
    1782. 

  1782. 

  1783. <p>If you plan on disconnecting the socket, and then immediately asking it to connect again,<br/>
    1784. 

  1784. you&rsquo;ll likely want to do so like this:<br/>
    1785. 

  1785. [asyncSocket setDelegate:nil];<br/>
    1786. 

  1786. [asyncSocket disconnect];<br/>
    1787. 

  1787. [asyncSocket setDelegate:self];<br/>
    1788. 

  1788. [asyncSocket connect&hellip;];</p>
    1789. 

  1789. 	</div>
    1790. 

  1790. 	
    1791. 

  1791. 	
    1792. 

  1792. 	
    1793. 

  1793. 	
    1794. 

  1794. 	
    1795. 

  1795. 	
    1796. 

  1796. 	
    1797. 

  1797. 	<div class="method-subsection declared-in-section">
    1798. 

  1798. 		<h4 class="method-subtitle">Declared In</h4>
    1799. 

  1799. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1800. 

  1800. 	</div>				
    1801. 

  1801. 	
    1802. 

  1802. 	
    1803. 

  1803. </div>
    1804. 

  1804. 						
    1805. 

  1805. 						<div class="section-method">
    1806. 

  1806. 	<a name="//api/name/disconnectAfterReading" title="disconnectAfterReading"></a>
    1807. 

  1807. 	<h3 class="subsubtitle method-title">disconnectAfterReading</h3>
    1808. 

  1808. 	
    1809. 

  1809. 	
    1810. 

  1810. 	
    1811. 

  1811. 	<div class="method-subsection brief-description">
    1812. 

  1812. 		<p>Disconnects after all pending reads have completed.<br/>
    1813. 

  1813. After calling this, the read and write methods will do nothing.<br/>
    1814. 

  1814. The socket will <a href="#//api/name/disconnect">disconnect</a> even if there are still pending writes.</p>
    1815. 

  1815. 	</div>		
    1816. 

  1816. 	
    1817. 

  1817.     
    1818. 

  1818. 

  1819. 	<div class="method-subsection method-declaration"><code>- (void)disconnectAfterReading</code></div>
    1820. 

  1820. 

  1821.     
    1822. 

  1822. 	
    1823. 

  1823. 	
    1824. 

  1824. 	
    1825. 

  1825. 	
    1826. 

  1826. 	
    1827. 

  1827. 	
    1828. 

  1828. 	
    1829. 

  1829. 	<div class="method-subsection discussion-section">
    1830. 

  1830. 		<h4 class="method-subtitle">Discussion</h4>
    1831. 

  1831. 		<p>Disconnects after all pending reads have completed.<br/>
    1832. 

  1832. After calling this, the read and write methods will do nothing.<br/>
    1833. 

  1833. The socket will <a href="#//api/name/disconnect">disconnect</a> even if there are still pending writes.</p>
    1834. 

  1834. 	</div>
    1835. 

  1835. 	
    1836. 

  1836. 	
    1837. 

  1837. 	
    1838. 

  1838. 	
    1839. 

  1839. 	
    1840. 

  1840. 	
    1841. 

  1841. 	
    1842. 

  1842. 	<div class="method-subsection declared-in-section">
    1843. 

  1843. 		<h4 class="method-subtitle">Declared In</h4>
    1844. 

  1844. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1845. 

  1845. 	</div>				
    1846. 

  1846. 	
    1847. 

  1847. 	
    1848. 

  1848. </div>
    1849. 

  1849. 						
    1850. 

  1850. 						<div class="section-method">
    1851. 

  1851. 	<a name="//api/name/disconnectAfterReadingAndWriting" title="disconnectAfterReadingAndWriting"></a>
    1852. 

  1852. 	<h3 class="subsubtitle method-title">disconnectAfterReadingAndWriting</h3>
    1853. 

  1853. 	
    1854. 

  1854. 	
    1855. 

  1855. 	
    1856. 

  1856. 	<div class="method-subsection brief-description">
    1857. 

  1857. 		<p>Disconnects after all pending reads and writes have completed.<br/>
    1858. 

  1858. After calling this, the read and write methods will do nothing.</p>
    1859. 

  1859. 	</div>		
    1860. 

  1860. 	
    1861. 

  1861.     
    1862. 

  1862. 

  1863. 	<div class="method-subsection method-declaration"><code>- (void)disconnectAfterReadingAndWriting</code></div>
    1864. 

  1864. 

  1865.     
    1866. 

  1866. 	
    1867. 

  1867. 	
    1868. 

  1868. 	
    1869. 

  1869. 	
    1870. 

  1870. 	
    1871. 

  1871. 	
    1872. 

  1872. 	
    1873. 

  1873. 	<div class="method-subsection discussion-section">
    1874. 

  1874. 		<h4 class="method-subtitle">Discussion</h4>
    1875. 

  1875. 		<p>Disconnects after all pending reads and writes have completed.<br/>
    1876. 

  1876. After calling this, the read and write methods will do nothing.</p>
    1877. 

  1877. 	</div>
    1878. 

  1878. 	
    1879. 

  1879. 	
    1880. 

  1880. 	
    1881. 

  1881. 	
    1882. 

  1882. 	
    1883. 

  1883. 	
    1884. 

  1884. 	
    1885. 

  1885. 	<div class="method-subsection declared-in-section">
    1886. 

  1886. 		<h4 class="method-subtitle">Declared In</h4>
    1887. 

  1887. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1888. 

  1888. 	</div>				
    1889. 

  1889. 	
    1890. 

  1890. 	
    1891. 

  1891. </div>
    1892. 

  1892. 						
    1893. 

  1893. 						<div class="section-method">
    1894. 

  1894. 	<a name="//api/name/disconnectAfterWriting" title="disconnectAfterWriting"></a>
    1895. 

  1895. 	<h3 class="subsubtitle method-title">disconnectAfterWriting</h3>
    1896. 

  1896. 	
    1897. 

  1897. 	
    1898. 

  1898. 	
    1899. 

  1899. 	<div class="method-subsection brief-description">
    1900. 

  1900. 		<p>Disconnects after all pending writes have completed.<br/>
    1901. 

  1901. After calling this, the read and write methods will do nothing.<br/>
    1902. 

  1902. The socket will <a href="#//api/name/disconnect">disconnect</a> even if there are still pending reads.</p>
    1903. 

  1903. 	</div>		
    1904. 

  1904. 	
    1905. 

  1905.     
    1906. 

  1906. 

  1907. 	<div class="method-subsection method-declaration"><code>- (void)disconnectAfterWriting</code></div>
    1908. 

  1908. 

  1909.     
    1910. 

  1910. 	
    1911. 

  1911. 	
    1912. 

  1912. 	
    1913. 

  1913. 	
    1914. 

  1914. 	
    1915. 

  1915. 	
    1916. 

  1916. 	
    1917. 

  1917. 	<div class="method-subsection discussion-section">
    1918. 

  1918. 		<h4 class="method-subtitle">Discussion</h4>
    1919. 

  1919. 		<p>Disconnects after all pending writes have completed.<br/>
    1920. 

  1920. After calling this, the read and write methods will do nothing.<br/>
    1921. 

  1921. The socket will <a href="#//api/name/disconnect">disconnect</a> even if there are still pending reads.</p>
    1922. 

  1922. 	</div>
    1923. 

  1923. 	
    1924. 

  1924. 	
    1925. 

  1925. 	
    1926. 

  1926. 	
    1927. 

  1927. 	
    1928. 

  1928. 	
    1929. 

  1929. 	
    1930. 

  1930. 	<div class="method-subsection declared-in-section">
    1931. 

  1931. 		<h4 class="method-subtitle">Declared In</h4>
    1932. 

  1932. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    1933. 

  1933. 	</div>				
    1934. 

  1934. 	
    1935. 

  1935. 	
    1936. 

  1936. </div>
    1937. 

  1937. 						
    1938. 

  1938. 						<div class="section-method">
    1939. 

  1939. 	<a name="//api/name/enableBackgroundingOnSocket" title="enableBackgroundingOnSocket"></a>
    1940. 

  1940. 	<h3 class="subsubtitle method-title">enableBackgroundingOnSocket</h3>
    1941. 

  1941. 	
    1942. 

  1942. 	
    1943. 

  1943. 	
    1944. 

  1944. 	<div class="method-subsection brief-description">
    1945. 

  1945. 		<p>This method is only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    1946. 

  1946. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p>
    1947. 

  1947. 	</div>		
    1948. 

  1948. 	
    1949. 

  1949.     
    1950. 

  1950. 

  1951. 	<div class="method-subsection method-declaration"><code>- (BOOL)enableBackgroundingOnSocket</code></div>
    1952. 

  1952. 

  1953.     
    1954. 

  1954. 	
    1955. 

  1955. 	
    1956. 

  1956. 	
    1957. 

  1957. 	
    1958. 

  1958. 	
    1959. 

  1959. 	
    1960. 

  1960. 	
    1961. 

  1961. 	<div class="method-subsection discussion-section">
    1962. 

  1962. 		<h4 class="method-subtitle">Discussion</h4>
    1963. 

  1963. 		<p>This method is only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    1964. 

  1964. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p>
    1965. 

  1965. 

  1966. <p>Configures the socket to allow it to operate when the iOS application has been backgrounded.<br/>
    1967. 

  1967. In other words, this method creates a read &amp; write stream, and invokes:</p>
    1968. 

  1968. 

  1969. <p>CFReadStreamSetProperty(<a href="#//api/name/readStream">readStream</a>, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP);<br/>
    1970. 

  1970. CFWriteStreamSetProperty(<a href="#//api/name/writeStream">writeStream</a>, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP);</p>
    1971. 

  1971. 

  1972. <p>Returns YES if successful, NO otherwise.</p>
    1973. 

  1973. 

  1974. <p>Note: Apple does not officially support backgrounding server sockets.<br/>
    1975. 

  1975. That is, if your socket is accepting incoming connections, Apple does not officially support<br/>
    1976. 

  1976. allowing iOS applications to accept incoming connections while an app is backgrounded.</p>
    1977. 

  1977. 

  1978. <p>Example usage:</p>
    1979. 

  1979. 

  1980. <ul>
    1981. 

  1981. <li>(void)socket:(GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> <em>)sock didConnectToHost:(NSString </em>)host port:(uint16_t)port<br/>
    1982. 

  1982. {<br/>
    1983. 

  1983. [asyncSocket performBlock:^{<br/>
    1984. 

  1984. [asyncSocket enableBackgroundingOnSocket];<br/>
    1985. 

  1985. }];<br/>
    1986. 

  1986. }</li>
    1987. 

  1987. </ul>
    1988. 

  1988. 

  1989. 	</div>
    1990. 

  1990. 	
    1991. 

  1991. 	
    1992. 

  1992. 	
    1993. 

  1993. 	
    1994. 

  1994. 	
    1995. 

  1995. 	
    1996. 

  1996. 	
    1997. 

  1997. 	<div class="method-subsection declared-in-section">
    1998. 

  1998. 		<h4 class="method-subtitle">Declared In</h4>
    1999. 

  1999. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2000. 

  2000. 	</div>				
    2001. 

  2001. 	
    2002. 

  2002. 	
    2003. 

  2003. </div>
    2004. 

  2004. 						
    2005. 

  2005. 						<div class="section-method">
    2006. 

  2006. 	<a name="//api/name/getDelegate:delegateQueue:" title="getDelegate:delegateQueue:"></a>
    2007. 

  2007. 	<h3 class="subsubtitle method-title">getDelegate:delegateQueue:</h3>
    2008. 

  2008. 	
    2009. 

  2009. 	
    2010. 

  2010. 

  2011. 	<div class="method-subsection method-declaration"><code>- (void)getDelegate:(id *)<em>delegatePtr</em> delegateQueue:(dispatch_queue_t *)<em>delegateQueuePtr</em></code></div>
    2012. 

  2012. 

  2013.     
    2014. 

  2014. </div>
    2015. 

  2015. 						
    2016. 

  2016. 						<div class="section-method">
    2017. 

  2017. 	<a name="//api/name/init" title="init"></a>
    2018. 

  2018. 	<h3 class="subsubtitle method-title">init</h3>
    2019. 

  2019. 	
    2020. 

  2020. 	
    2021. 

  2021. 	
    2022. 

  2022. 	<div class="method-subsection brief-description">
    2023. 

  2023. 		<p>GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> uses the standard <a href="#//api/name/delegate">delegate</a> paradigm,<br/>
    2024. 

  2024. but executes all <a href="#//api/name/delegate">delegate</a> callbacks on a given <a href="#//api/name/delegate">delegate</a> dispatch queue.<br/>
    2025. 

  2025. This allows for maximum concurrency, while at the same time providing easy thread safety.</p>
    2026. 

  2026. 	</div>		
    2027. 

  2027. 	
    2028. 

  2028.     
    2029. 

  2029. 

  2030. 	<div class="method-subsection method-declaration"><code>- (id)init</code></div>
    2031. 

  2031. 

  2032.     
    2033. 

  2033. 	
    2034. 

  2034. 	
    2035. 

  2035. 	
    2036. 

  2036. 	
    2037. 

  2037. 	
    2038. 

  2038. 	
    2039. 

  2039. 	
    2040. 

  2040. 	<div class="method-subsection discussion-section">
    2041. 

  2041. 		<h4 class="method-subtitle">Discussion</h4>
    2042. 

  2042. 		<p>GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> uses the standard <a href="#//api/name/delegate">delegate</a> paradigm,<br/>
    2043. 

  2043. but executes all <a href="#//api/name/delegate">delegate</a> callbacks on a given <a href="#//api/name/delegate">delegate</a> dispatch queue.<br/>
    2044. 

  2044. This allows for maximum concurrency, while at the same time providing easy thread safety.</p>
    2045. 

  2045. 

  2046. <p>You MUST set a <a href="#//api/name/delegate">delegate</a> AND <a href="#//api/name/delegate">delegate</a> dispatch queue before attempting to<br/>
    2047. 

  2047. use the socket, or you will get an error.</p>
    2048. 

  2048. 

  2049. <p>The socket queue is optional.<br/>
    2050. 

  2050. If you pass NULL, GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> will automatically create it&rsquo;s own socket queue.<br/>
    2051. 

  2051. If you choose to provide a socket queue, the socket queue must not be a concurrent queue.</p>
    2052. 

  2052. 

  2053. <p>The <a href="#//api/name/delegate">delegate</a> queue and socket queue can optionally be the same.</p>
    2054. 

  2054. 	</div>
    2055. 

  2055. 	
    2056. 

  2056. 	
    2057. 

  2057. 	
    2058. 

  2058. 	
    2059. 

  2059. 	
    2060. 

  2060. 	
    2061. 

  2061. 	
    2062. 

  2062. 	<div class="method-subsection declared-in-section">
    2063. 

  2063. 		<h4 class="method-subtitle">Declared In</h4>
    2064. 

  2064. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2065. 

  2065. 	</div>				
    2066. 

  2066. 	
    2067. 

  2067. 	
    2068. 

  2068. </div>
    2069. 

  2069. 						
    2070. 

  2070. 						<div class="section-method">
    2071. 

  2071. 	<a name="//api/name/initWithDelegate:delegateQueue:" title="initWithDelegate:delegateQueue:"></a>
    2072. 

  2072. 	<h3 class="subsubtitle method-title">initWithDelegate:delegateQueue:</h3>
    2073. 

  2073. 	
    2074. 

  2074. 	
    2075. 

  2075. 

  2076. 	<div class="method-subsection method-declaration"><code>- (id)initWithDelegate:(id)<em>aDelegate</em> delegateQueue:(dispatch_queue_t)<em>dq</em></code></div>
    2077. 

  2077. 

  2078.     
    2079. 

  2079. </div>
    2080. 

  2080. 						
    2081. 

  2081. 						<div class="section-method">
    2082. 

  2082. 	<a name="//api/name/initWithDelegate:delegateQueue:socketQueue:" title="initWithDelegate:delegateQueue:socketQueue:"></a>
    2083. 

  2083. 	<h3 class="subsubtitle method-title">initWithDelegate:delegateQueue:socketQueue:</h3>
    2084. 

  2084. 	
    2085. 

  2085. 	
    2086. 

  2086. 

  2087. 	<div class="method-subsection method-declaration"><code>- (id)initWithDelegate:(id)<em>aDelegate</em> delegateQueue:(dispatch_queue_t)<em>dq</em> socketQueue:(dispatch_queue_t)<em>sq</em></code></div>
    2088. 

  2088. 

  2089.     
    2090. 

  2090. </div>
    2091. 

  2091. 						
    2092. 

  2092. 						<div class="section-method">
    2093. 

  2093. 	<a name="//api/name/initWithSocketQueue:" title="initWithSocketQueue:"></a>
    2094. 

  2094. 	<h3 class="subsubtitle method-title">initWithSocketQueue:</h3>
    2095. 

  2095. 	
    2096. 

  2096. 	
    2097. 

  2097. 

  2098. 	<div class="method-subsection method-declaration"><code>- (id)initWithSocketQueue:(dispatch_queue_t)<em>sq</em></code></div>
    2099. 

  2099. 

  2100.     
    2101. 

  2101. </div>
    2102. 

  2102. 						
    2103. 

  2103. 						<div class="section-method">
    2104. 

  2104. 	<a name="//api/name/isConnected" title="isConnected"></a>
    2105. 

  2105. 	<h3 class="subsubtitle method-title">isConnected</h3>
    2106. 

  2106. 	
    2107. 

  2107. 	
    2108. 

  2108. 

  2109. 	<div class="method-subsection method-declaration"><code>- (BOOL)isConnected</code></div>
    2110. 

  2110. 

  2111.     
    2112. 

  2112. </div>
    2113. 

  2113. 						
    2114. 

  2114. 						<div class="section-method">
    2115. 

  2115. 	<a name="//api/name/isDisconnected" title="isDisconnected"></a>
    2116. 

  2116. 	<h3 class="subsubtitle method-title">isDisconnected</h3>
    2117. 

  2117. 	
    2118. 

  2118. 	
    2119. 

  2119. 	
    2120. 

  2120. 	<div class="method-subsection brief-description">
    2121. 

  2121. 		<p>Returns whether the socket is disconnected or connected.</p>
    2122. 

  2122. 	</div>		
    2123. 

  2123. 	
    2124. 

  2124.     
    2125. 

  2125. 

  2126. 	<div class="method-subsection method-declaration"><code>- (BOOL)isDisconnected</code></div>
    2127. 

  2127. 

  2128.     
    2129. 

  2129. 	
    2130. 

  2130. 	
    2131. 

  2131. 	
    2132. 

  2132. 	
    2133. 

  2133. 	
    2134. 

  2134. 	
    2135. 

  2135. 	
    2136. 

  2136. 	<div class="method-subsection discussion-section">
    2137. 

  2137. 		<h4 class="method-subtitle">Discussion</h4>
    2138. 

  2138. 		<p>Returns whether the socket is disconnected or connected.</p>
    2139. 

  2139. 

  2140. <p>A disconnected socket may be recycled.<br/>
    2141. 

  2141. That is, it can used again for connecting or listening.</p>
    2142. 

  2142. 

  2143. <p>If a socket is in the process of connecting, it may be neither disconnected nor connected.</p>
    2144. 

  2144. 	</div>
    2145. 

  2145. 	
    2146. 

  2146. 	
    2147. 

  2147. 	
    2148. 

  2148. 	
    2149. 

  2149. 	
    2150. 

  2150. 	
    2151. 

  2151. 	
    2152. 

  2152. 	<div class="method-subsection declared-in-section">
    2153. 

  2153. 		<h4 class="method-subtitle">Declared In</h4>
    2154. 

  2154. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2155. 

  2155. 	</div>				
    2156. 

  2156. 	
    2157. 

  2157. 	
    2158. 

  2158. </div>
    2159. 

  2159. 						
    2160. 

  2160. 						<div class="section-method">
    2161. 

  2161. 	<a name="//api/name/isIPv4" title="isIPv4"></a>
    2162. 

  2162. 	<h3 class="subsubtitle method-title">isIPv4</h3>
    2163. 

  2163. 	
    2164. 

  2164. 	
    2165. 

  2165. 	
    2166. 

  2166. 	<div class="method-subsection brief-description">
    2167. 

  2167. 		<p>Returns whether the socket is IPv4 or IPv6.<br/>
    2168. 

  2168. An accepting socket may be both.</p>
    2169. 

  2169. 	</div>		
    2170. 

  2170. 	
    2171. 

  2171.     
    2172. 

  2172. 

  2173. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv4</code></div>
    2174. 

  2174. 

  2175.     
    2176. 

  2176. 	
    2177. 

  2177. 	
    2178. 

  2178. 	
    2179. 

  2179. 	
    2180. 

  2180. 	
    2181. 

  2181. 	
    2182. 

  2182. 	
    2183. 

  2183. 	<div class="method-subsection discussion-section">
    2184. 

  2184. 		<h4 class="method-subtitle">Discussion</h4>
    2185. 

  2185. 		<p>Returns whether the socket is IPv4 or IPv6.<br/>
    2186. 

  2186. An accepting socket may be both.</p>
    2187. 

  2187. 	</div>
    2188. 

  2188. 	
    2189. 

  2189. 	
    2190. 

  2190. 	
    2191. 

  2191. 	
    2192. 

  2192. 	
    2193. 

  2193. 	
    2194. 

  2194. 	
    2195. 

  2195. 	<div class="method-subsection declared-in-section">
    2196. 

  2196. 		<h4 class="method-subtitle">Declared In</h4>
    2197. 

  2197. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2198. 

  2198. 	</div>				
    2199. 

  2199. 	
    2200. 

  2200. 	
    2201. 

  2201. </div>
    2202. 

  2202. 						
    2203. 

  2203. 						<div class="section-method">
    2204. 

  2204. 	<a name="//api/name/isIPv4Enabled" title="isIPv4Enabled"></a>
    2205. 

  2205. 	<h3 class="subsubtitle method-title">isIPv4Enabled</h3>
    2206. 

  2206. 	
    2207. 

  2207. 	
    2208. 

  2208. 	
    2209. 

  2209. 	<div class="method-subsection brief-description">
    2210. 

  2210. 		<p>By default, both IPv4 and IPv6 are enabled.</p>
    2211. 

  2211. 	</div>		
    2212. 

  2212. 	
    2213. 

  2213.     
    2214. 

  2214. 

  2215. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv4Enabled</code></div>
    2216. 

  2216. 

  2217.     
    2218. 

  2218. 	
    2219. 

  2219. 	
    2220. 

  2220. 	
    2221. 

  2221. 	
    2222. 

  2222. 	
    2223. 

  2223. 	
    2224. 

  2224. 	
    2225. 

  2225. 	<div class="method-subsection discussion-section">
    2226. 

  2226. 		<h4 class="method-subtitle">Discussion</h4>
    2227. 

  2227. 		<p>By default, both IPv4 and IPv6 are enabled.</p>
    2228. 

  2228. 

  2229. <p>For accepting incoming connections, this means GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> automatically supports both protocols,<br/>
    2230. 

  2230. and can simulataneously accept incoming connections on either protocol.</p>
    2231. 

  2231. 

  2232. <p>For outgoing connections, this means GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> can connect to remote hosts running either protocol.<br/>
    2233. 

  2233. If a DNS lookup returns only IPv4 results, GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> will automatically use IPv4.<br/>
    2234. 

  2234. If a DNS lookup returns only IPv6 results, GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> will automatically use IPv6.<br/>
    2235. 

  2235. If a DNS lookup returns both IPv4 and IPv6 results, the preferred protocol will be chosen.<br/>
    2236. 

  2236. By default, the preferred protocol is IPv4, but may be configured as desired.</p>
    2237. 

  2237. 	</div>
    2238. 

  2238. 	
    2239. 

  2239. 	
    2240. 

  2240. 	
    2241. 

  2241. 	
    2242. 

  2242. 	
    2243. 

  2243. 	
    2244. 

  2244. 	
    2245. 

  2245. 	<div class="method-subsection declared-in-section">
    2246. 

  2246. 		<h4 class="method-subtitle">Declared In</h4>
    2247. 

  2247. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2248. 

  2248. 	</div>				
    2249. 

  2249. 	
    2250. 

  2250. 	
    2251. 

  2251. </div>
    2252. 

  2252. 						
    2253. 

  2253. 						<div class="section-method">
    2254. 

  2254. 	<a name="//api/name/isIPv4PreferredOverIPv6" title="isIPv4PreferredOverIPv6"></a>
    2255. 

  2255. 	<h3 class="subsubtitle method-title">isIPv4PreferredOverIPv6</h3>
    2256. 

  2256. 	
    2257. 

  2257. 	
    2258. 

  2258. 

  2259. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv4PreferredOverIPv6</code></div>
    2260. 

  2260. 

  2261.     
    2262. 

  2262. </div>
    2263. 

  2263. 						
    2264. 

  2264. 						<div class="section-method">
    2265. 

  2265. 	<a name="//api/name/isIPv6" title="isIPv6"></a>
    2266. 

  2266. 	<h3 class="subsubtitle method-title">isIPv6</h3>
    2267. 

  2267. 	
    2268. 

  2268. 	
    2269. 

  2269. 

  2270. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv6</code></div>
    2271. 

  2271. 

  2272.     
    2273. 

  2273. </div>
    2274. 

  2274. 						
    2275. 

  2275. 						<div class="section-method">
    2276. 

  2276. 	<a name="//api/name/isIPv6Enabled" title="isIPv6Enabled"></a>
    2277. 

  2277. 	<h3 class="subsubtitle method-title">isIPv6Enabled</h3>
    2278. 

  2278. 	
    2279. 

  2279. 	
    2280. 

  2280. 

  2281. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv6Enabled</code></div>
    2282. 

  2282. 

  2283.     
    2284. 

  2284. </div>
    2285. 

  2285. 						
    2286. 

  2286. 						<div class="section-method">
    2287. 

  2287. 	<a name="//api/name/isSecure" title="isSecure"></a>
    2288. 

  2288. 	<h3 class="subsubtitle method-title">isSecure</h3>
    2289. 

  2289. 	
    2290. 

  2290. 	
    2291. 

  2291. 	
    2292. 

  2292. 	<div class="method-subsection brief-description">
    2293. 

  2293. 		<p>Returns whether or not the socket has been secured via SSL/TLS.</p>
    2294. 

  2294. 	</div>		
    2295. 

  2295. 	
    2296. 

  2296.     
    2297. 

  2297. 

  2298. 	<div class="method-subsection method-declaration"><code>- (BOOL)isSecure</code></div>
    2299. 

  2299. 

  2300.     
    2301. 

  2301. 	
    2302. 

  2302. 	
    2303. 

  2303. 	
    2304. 

  2304. 	
    2305. 

  2305. 	
    2306. 

  2306. 	
    2307. 

  2307. 	
    2308. 

  2308. 	<div class="method-subsection discussion-section">
    2309. 

  2309. 		<h4 class="method-subtitle">Discussion</h4>
    2310. 

  2310. 		<p>Returns whether or not the socket has been secured via SSL/TLS.</p>
    2311. 

  2311. 

  2312. <p>See also the startTLS method.</p>
    2313. 

  2313. 	</div>
    2314. 

  2314. 	
    2315. 

  2315. 	
    2316. 

  2316. 	
    2317. 

  2317. 	
    2318. 

  2318. 	
    2319. 

  2319. 	
    2320. 

  2320. 	
    2321. 

  2321. 	<div class="method-subsection declared-in-section">
    2322. 

  2322. 		<h4 class="method-subtitle">Declared In</h4>
    2323. 

  2323. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2324. 

  2324. 	</div>				
    2325. 

  2325. 	
    2326. 

  2326. 	
    2327. 

  2327. </div>
    2328. 

  2328. 						
    2329. 

  2329. 						<div class="section-method">
    2330. 

  2330. 	<a name="//api/name/localAddress" title="localAddress"></a>
    2331. 

  2331. 	<h3 class="subsubtitle method-title">localAddress</h3>
    2332. 

  2332. 	
    2333. 

  2333. 	
    2334. 

  2334. 

  2335. 	<div class="method-subsection method-declaration"><code>- (NSData *)localAddress</code></div>
    2336. 

  2336. 

  2337.     
    2338. 

  2338. </div>
    2339. 

  2339. 						
    2340. 

  2340. 						<div class="section-method">
    2341. 

  2341. 	<a name="//api/name/localHost" title="localHost"></a>
    2342. 

  2342. 	<h3 class="subsubtitle method-title">localHost</h3>
    2343. 

  2343. 	
    2344. 

  2344. 	
    2345. 

  2345. 

  2346. 	<div class="method-subsection method-declaration"><code>- (NSString *)localHost</code></div>
    2347. 

  2347. 

  2348.     
    2349. 

  2349. </div>
    2350. 

  2350. 						
    2351. 

  2351. 						<div class="section-method">
    2352. 

  2352. 	<a name="//api/name/localPort" title="localPort"></a>
    2353. 

  2353. 	<h3 class="subsubtitle method-title">localPort</h3>
    2354. 

  2354. 	
    2355. 

  2355. 	
    2356. 

  2356. 

  2357. 	<div class="method-subsection method-declaration"><code>- (uint16_t)localPort</code></div>
    2358. 

  2358. 

  2359.     
    2360. 

  2360. </div>
    2361. 

  2361. 						
    2362. 

  2362. 						<div class="section-method">
    2363. 

  2363. 	<a name="//api/name/performBlock:" title="performBlock:"></a>
    2364. 

  2364. 	<h3 class="subsubtitle method-title">performBlock:</h3>
    2365. 

  2365. 	
    2366. 

  2366. 	
    2367. 

  2367. 	
    2368. 

  2368. 	<div class="method-subsection brief-description">
    2369. 

  2369. 		<p>It&rsquo;s not thread-safe to access certain variables from outside the socket&rsquo;s internal queue.</p>
    2370. 

  2370. 	</div>		
    2371. 

  2371. 	
    2372. 

  2372.     
    2373. 

  2373. 

  2374. 	<div class="method-subsection method-declaration"><code>- (void)performBlock:(dispatch_block_t)<em>block</em></code></div>
    2375. 

  2375. 

  2376.     
    2377. 

  2377. 	
    2378. 

  2378. 	
    2379. 

  2379. 	
    2380. 

  2380. 	
    2381. 

  2381. 	
    2382. 

  2382. 	
    2383. 

  2383. 	
    2384. 

  2384. 	<div class="method-subsection discussion-section">
    2385. 

  2385. 		<h4 class="method-subtitle">Discussion</h4>
    2386. 

  2386. 		<p>It&rsquo;s not thread-safe to access certain variables from outside the socket&rsquo;s internal queue.</p>
    2387. 

  2387. 

  2388. <p>For example, the socket file descriptor.<br/>
    2389. 

  2389. File descriptors are simply integers which reference an index in the per-process file table.<br/>
    2390. 

  2390. However, when one requests a new file descriptor (by opening a file or socket),<br/>
    2391. 

  2391. the file descriptor returned is guaranteed to be the lowest numbered unused descriptor.<br/>
    2392. 

  2392. So if we&rsquo;re not careful, the following could be possible:</p>
    2393. 

  2393. 

  2394. <ul>
    2395. 

  2395. <li>Thread A invokes a method which returns the socket&rsquo;s file descriptor.</li>
    2396. 

  2396. <li>The socket is closed via the socket&rsquo;s internal queue on thread B.</li>
    2397. 

  2397. <li>Thread C opens a file, and subsequently receives the file descriptor that was previously the socket&rsquo;s FD.</li>
    2398. 

  2398. <li>Thread A is now accessing/altering the file instead of the socket.</li>
    2399. 

  2399. </ul>
    2400. 

  2400. 

  2401. 

  2402. <p>In addition to this, other variables are not actually objects,<br/>
    2403. 

  2403. and thus cannot be retained/released or even autoreleased.<br/>
    2404. 

  2404. An example is the <a href="#//api/name/sslContext">sslContext</a>, of type SSLContextRef, which is actually a malloc&rsquo;d struct.</p>
    2405. 

  2405. 

  2406. <p>Although there are internal variables that make it difficult to maintain thread-safety,<br/>
    2407. 

  2407. it is important to provide access to these variables<br/>
    2408. 

  2408. to ensure this class can be used in a wide array of environments.<br/>
    2409. 

  2409. This method helps to accomplish this by invoking the current block on the socket&rsquo;s internal queue.<br/>
    2410. 

  2410. The methods below can be invoked from within the block to access<br/>
    2411. 

  2411. those generally thread-unsafe internal variables in a thread-safe manner.<br/>
    2412. 

  2412. The given block will be invoked synchronously on the socket&rsquo;s internal queue.</p>
    2413. 

  2413. 

  2414. <p>If you save references to any protected variables and use them outside the block, you do so at your own peril.</p>
    2415. 

  2415. 	</div>
    2416. 

  2416. 	
    2417. 

  2417. 	
    2418. 

  2418. 	
    2419. 

  2419. 	
    2420. 

  2420. 	
    2421. 

  2421. 	
    2422. 

  2422. 	
    2423. 

  2423. 	<div class="method-subsection declared-in-section">
    2424. 

  2424. 		<h4 class="method-subtitle">Declared In</h4>
    2425. 

  2425. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2426. 

  2426. 	</div>				
    2427. 

  2427. 	
    2428. 

  2428. 	
    2429. 

  2429. </div>
    2430. 

  2430. 						
    2431. 

  2431. 						<div class="section-method">
    2432. 

  2432. 	<a name="//api/name/progressOfReadReturningTag:bytesDone:total:" title="progressOfReadReturningTag:bytesDone:total:"></a>
    2433. 

  2433. 	<h3 class="subsubtitle method-title">progressOfReadReturningTag:bytesDone:total:</h3>
    2434. 

  2434. 	
    2435. 

  2435. 	
    2436. 

  2436. 	
    2437. 

  2437. 	<div class="method-subsection brief-description">
    2438. 

  2438. 		<p>Returns progress of the current read, from 0.0 to 1.0, or NaN if no current read (use isnan() to check).<br/>
    2439. 

  2439. The parameters &ldquo;tag&rdquo;, &ldquo;done&rdquo; and &ldquo;total&rdquo; will be filled in if they aren&rsquo;t NULL.</p>
    2440. 

  2440. 	</div>		
    2441. 

  2441. 	
    2442. 

  2442.     
    2443. 

  2443. 

  2444. 	<div class="method-subsection method-declaration"><code>- (float)progressOfReadReturningTag:(long *)<em>tagPtr</em> bytesDone:(NSUInteger *)<em>donePtr</em> total:(NSUInteger *)<em>totalPtr</em></code></div>
    2445. 

  2445. 

  2446.     
    2447. 

  2447. 	
    2448. 

  2448. 	
    2449. 

  2449. 	
    2450. 

  2450. 	
    2451. 

  2451. 	
    2452. 

  2452. 	
    2453. 

  2453. 	
    2454. 

  2454. 	<div class="method-subsection discussion-section">
    2455. 

  2455. 		<h4 class="method-subtitle">Discussion</h4>
    2456. 

  2456. 		<p>Returns progress of the current read, from 0.0 to 1.0, or NaN if no current read (use isnan() to check).<br/>
    2457. 

  2457. The parameters &ldquo;tag&rdquo;, &ldquo;done&rdquo; and &ldquo;total&rdquo; will be filled in if they aren&rsquo;t NULL.</p>
    2458. 

  2458. 	</div>
    2459. 

  2459. 	
    2460. 

  2460. 	
    2461. 

  2461. 	
    2462. 

  2462. 	
    2463. 

  2463. 	
    2464. 

  2464. 	
    2465. 

  2465. 	
    2466. 

  2466. 	<div class="method-subsection declared-in-section">
    2467. 

  2467. 		<h4 class="method-subtitle">Declared In</h4>
    2468. 

  2468. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2469. 

  2469. 	</div>				
    2470. 

  2470. 	
    2471. 

  2471. 	
    2472. 

  2472. </div>
    2473. 

  2473. 						
    2474. 

  2474. 						<div class="section-method">
    2475. 

  2475. 	<a name="//api/name/progressOfWriteReturningTag:bytesDone:total:" title="progressOfWriteReturningTag:bytesDone:total:"></a>
    2476. 

  2476. 	<h3 class="subsubtitle method-title">progressOfWriteReturningTag:bytesDone:total:</h3>
    2477. 

  2477. 	
    2478. 

  2478. 	
    2479. 

  2479. 	
    2480. 

  2480. 	<div class="method-subsection brief-description">
    2481. 

  2481. 		<p>Returns progress of the current write, from 0.0 to 1.0, or NaN if no current write (use isnan() to check).<br/>
    2482. 

  2482. The parameters &ldquo;tag&rdquo;, &ldquo;done&rdquo; and &ldquo;total&rdquo; will be filled in if they aren&rsquo;t NULL.</p>
    2483. 

  2483. 	</div>		
    2484. 

  2484. 	
    2485. 

  2485.     
    2486. 

  2486. 

  2487. 	<div class="method-subsection method-declaration"><code>- (float)progressOfWriteReturningTag:(long *)<em>tagPtr</em> bytesDone:(NSUInteger *)<em>donePtr</em> total:(NSUInteger *)<em>totalPtr</em></code></div>
    2488. 

  2488. 

  2489.     
    2490. 

  2490. 	
    2491. 

  2491. 	
    2492. 

  2492. 	
    2493. 

  2493. 	
    2494. 

  2494. 	
    2495. 

  2495. 	
    2496. 

  2496. 	
    2497. 

  2497. 	<div class="method-subsection discussion-section">
    2498. 

  2498. 		<h4 class="method-subtitle">Discussion</h4>
    2499. 

  2499. 		<p>Returns progress of the current write, from 0.0 to 1.0, or NaN if no current write (use isnan() to check).<br/>
    2500. 

  2500. The parameters &ldquo;tag&rdquo;, &ldquo;done&rdquo; and &ldquo;total&rdquo; will be filled in if they aren&rsquo;t NULL.</p>
    2501. 

  2501. 	</div>
    2502. 

  2502. 	
    2503. 

  2503. 	
    2504. 

  2504. 	
    2505. 

  2505. 	
    2506. 

  2506. 	
    2507. 

  2507. 	
    2508. 

  2508. 	
    2509. 

  2509. 	<div class="method-subsection declared-in-section">
    2510. 

  2510. 		<h4 class="method-subtitle">Declared In</h4>
    2511. 

  2511. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2512. 

  2512. 	</div>				
    2513. 

  2513. 	
    2514. 

  2514. 	
    2515. 

  2515. </div>
    2516. 

  2516. 						
    2517. 

  2517. 						<div class="section-method">
    2518. 

  2518. 	<a name="//api/name/readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:" title="readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:"></a>
    2519. 

  2519. 	<h3 class="subsubtitle method-title">readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:</h3>
    2520. 

  2520. 	
    2521. 

  2521. 	
    2522. 

  2522. 	
    2523. 

  2523. 	<div class="method-subsection brief-description">
    2524. 

  2524. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    2525. 

  2525. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2526. 

  2526. The given buffer will automatically be increased in size if needed.</p>
    2527. 

  2527. 	</div>		
    2528. 

  2528. 	
    2529. 

  2529.     
    2530. 

  2530. 

  2531. 	<div class="method-subsection method-declaration"><code>- (void)readDataToData:(NSData *)<em>data</em> withTimeout:(NSTimeInterval)<em>timeout</em> buffer:(NSMutableData *)<em>buffer</em> bufferOffset:(NSUInteger)<em>offset</em> maxLength:(NSUInteger)<em>length</em> tag:(long)<em>tag</em></code></div>
    2532. 

  2532. 

  2533.     
    2534. 

  2534. 	
    2535. 

  2535. 	
    2536. 

  2536. 	
    2537. 

  2537. 	
    2538. 

  2538. 	
    2539. 

  2539. 	
    2540. 

  2540. 	
    2541. 

  2541. 	<div class="method-subsection discussion-section">
    2542. 

  2542. 		<h4 class="method-subtitle">Discussion</h4>
    2543. 

  2543. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    2544. 

  2544. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2545. 

  2545. The given buffer will automatically be increased in size if needed.</p>
    2546. 

  2546. 

  2547. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    2548. 

  2548. If the buffer if nil, a buffer will automatically be created for you.</p>
    2549. 

  2549. 

  2550. <p>If maxLength is zero, no length restriction is enforced.<br/>
    2551. 

  2551. Otherwise if maxLength bytes are read without completing the read,<br/>
    2552. 

  2552. it is treated similarly to a timeout - the socket is closed with a GCDAsyncSocketReadMaxedOutError.<br/>
    2553. 

  2553. The read will complete successfully if exactly maxLength bytes are read and the given data is found at the end.</p>
    2554. 

  2554. 

  2555. <p>If you pass a maxLength parameter that is less than the length of the data (separator) parameter,<br/>
    2556. 

  2556. the method will do nothing (except maybe print a warning), and the delegate will not be called.<br/>
    2557. 

  2557. If the bufferOffset is greater than the length of the given buffer,<br/>
    2558. 

  2558. the method will do nothing (except maybe print a warning), and the delegate will not be called.</p>
    2559. 

  2559. 

  2560. <p>If you pass a buffer, you must not alter it in any way while the socket is using it.<br/>
    2561. 

  2561. After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer.<br/>
    2562. 

  2562. That is, it will reference the bytes that were appended to the given buffer via<br/>
    2563. 

  2563. the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO].</p>
    2564. 

  2564. 

  2565. <p>To read a line from the socket, use the line separator (e.g. CRLF for HTTP, see below) as the &ldquo;data&rdquo; parameter.<br/>
    2566. 

  2566. If you&rsquo;re developing your own custom protocol, be sure your separator can not occur naturally as<br/>
    2567. 

  2567. part of the data between separators.<br/>
    2568. 

  2568. For example, imagine you want to send several small documents over a socket.<br/>
    2569. 

  2569. Using CRLF as a separator is likely unwise, as a CRLF could easily exist within the documents.<br/>
    2570. 

  2570. In this particular example, it would be better to use a protocol similar to HTTP with<br/>
    2571. 

  2571. a header that includes the length of the document.<br/>
    2572. 

  2572. Also be careful that your separator cannot occur naturally as part of the encoding for a character.</p>
    2573. 

  2573. 

  2574. <p>The given data (separator) parameter should be immutable.<br/>
    2575. 

  2575. For performance reasons, the socket will retain it, not copy it.<br/>
    2576. 

  2576. So if it is immutable, don&rsquo;t modify it while the socket is using it.</p>
    2577. 

  2577. 	</div>
    2578. 

  2578. 	
    2579. 

  2579. 	
    2580. 

  2580. 	
    2581. 

  2581. 	
    2582. 

  2582. 	
    2583. 

  2583. 	
    2584. 

  2584. 	
    2585. 

  2585. 	<div class="method-subsection declared-in-section">
    2586. 

  2586. 		<h4 class="method-subtitle">Declared In</h4>
    2587. 

  2587. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2588. 

  2588. 	</div>				
    2589. 

  2589. 	
    2590. 

  2590. 	
    2591. 

  2591. </div>
    2592. 

  2592. 						
    2593. 

  2593. 						<div class="section-method">
    2594. 

  2594. 	<a name="//api/name/readDataToData:withTimeout:buffer:bufferOffset:tag:" title="readDataToData:withTimeout:buffer:bufferOffset:tag:"></a>
    2595. 

  2595. 	<h3 class="subsubtitle method-title">readDataToData:withTimeout:buffer:bufferOffset:tag:</h3>
    2596. 

  2596. 	
    2597. 

  2597. 	
    2598. 

  2598. 	
    2599. 

  2599. 	<div class="method-subsection brief-description">
    2600. 

  2600. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    2601. 

  2601. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2602. 

  2602. The given buffer will automatically be increased in size if needed.</p>
    2603. 

  2603. 	</div>		
    2604. 

  2604. 	
    2605. 

  2605.     
    2606. 

  2606. 

  2607. 	<div class="method-subsection method-declaration"><code>- (void)readDataToData:(NSData *)<em>data</em> withTimeout:(NSTimeInterval)<em>timeout</em> buffer:(NSMutableData *)<em>buffer</em> bufferOffset:(NSUInteger)<em>offset</em> tag:(long)<em>tag</em></code></div>
    2608. 

  2608. 

  2609.     
    2610. 

  2610. 	
    2611. 

  2611. 	
    2612. 

  2612. 	
    2613. 

  2613. 	
    2614. 

  2614. 	
    2615. 

  2615. 	
    2616. 

  2616. 	
    2617. 

  2617. 	<div class="method-subsection discussion-section">
    2618. 

  2618. 		<h4 class="method-subtitle">Discussion</h4>
    2619. 

  2619. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    2620. 

  2620. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2621. 

  2621. The given buffer will automatically be increased in size if needed.</p>
    2622. 

  2622. 

  2623. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    2624. 

  2624. If the buffer if nil, a buffer will automatically be created for you.</p>
    2625. 

  2625. 

  2626. <p>If the bufferOffset is greater than the length of the given buffer,<br/>
    2627. 

  2627. the method will do nothing (except maybe print a warning), and the delegate will not be called.</p>
    2628. 

  2628. 

  2629. <p>If you pass a buffer, you must not alter it in any way while the socket is using it.<br/>
    2630. 

  2630. After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer.<br/>
    2631. 

  2631. That is, it will reference the bytes that were appended to the given buffer via<br/>
    2632. 

  2632. the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO].</p>
    2633. 

  2633. 

  2634. <p>To read a line from the socket, use the line separator (e.g. CRLF for HTTP, see below) as the &ldquo;data&rdquo; parameter.<br/>
    2635. 

  2635. If you&rsquo;re developing your own custom protocol, be sure your separator can not occur naturally as<br/>
    2636. 

  2636. part of the data between separators.<br/>
    2637. 

  2637. For example, imagine you want to send several small documents over a socket.<br/>
    2638. 

  2638. Using CRLF as a separator is likely unwise, as a CRLF could easily exist within the documents.<br/>
    2639. 

  2639. In this particular example, it would be better to use a protocol similar to HTTP with<br/>
    2640. 

  2640. a header that includes the length of the document.<br/>
    2641. 

  2641. Also be careful that your separator cannot occur naturally as part of the encoding for a character.</p>
    2642. 

  2642. 

  2643. <p>The given data (separator) parameter should be immutable.<br/>
    2644. 

  2644. For performance reasons, the socket will retain it, not copy it.<br/>
    2645. 

  2645. So if it is immutable, don&rsquo;t modify it while the socket is using it.</p>
    2646. 

  2646. 	</div>
    2647. 

  2647. 	
    2648. 

  2648. 	
    2649. 

  2649. 	
    2650. 

  2650. 	
    2651. 

  2651. 	
    2652. 

  2652. 	
    2653. 

  2653. 	
    2654. 

  2654. 	<div class="method-subsection declared-in-section">
    2655. 

  2655. 		<h4 class="method-subtitle">Declared In</h4>
    2656. 

  2656. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2657. 

  2657. 	</div>				
    2658. 

  2658. 	
    2659. 

  2659. 	
    2660. 

  2660. </div>
    2661. 

  2661. 						
    2662. 

  2662. 						<div class="section-method">
    2663. 

  2663. 	<a name="//api/name/readDataToData:withTimeout:maxLength:tag:" title="readDataToData:withTimeout:maxLength:tag:"></a>
    2664. 

  2664. 	<h3 class="subsubtitle method-title">readDataToData:withTimeout:maxLength:tag:</h3>
    2665. 

  2665. 	
    2666. 

  2666. 	
    2667. 

  2667. 	
    2668. 

  2668. 	<div class="method-subsection brief-description">
    2669. 

  2669. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p>
    2670. 

  2670. 	</div>		
    2671. 

  2671. 	
    2672. 

  2672.     
    2673. 

  2673. 

  2674. 	<div class="method-subsection method-declaration"><code>- (void)readDataToData:(NSData *)<em>data</em> withTimeout:(NSTimeInterval)<em>timeout</em> maxLength:(NSUInteger)<em>length</em> tag:(long)<em>tag</em></code></div>
    2675. 

  2675. 

  2676.     
    2677. 

  2677. 	
    2678. 

  2678. 	
    2679. 

  2679. 	
    2680. 

  2680. 	
    2681. 

  2681. 	
    2682. 

  2682. 	
    2683. 

  2683. 	
    2684. 

  2684. 	<div class="method-subsection discussion-section">
    2685. 

  2685. 		<h4 class="method-subtitle">Discussion</h4>
    2686. 

  2686. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p>
    2687. 

  2687. 

  2688. <p>If the timeout value is negative, the read operation will not use a timeout.</p>
    2689. 

  2689. 

  2690. <p>If maxLength is zero, no length restriction is enforced.<br/>
    2691. 

  2691. Otherwise if maxLength bytes are read without completing the read,<br/>
    2692. 

  2692. it is treated similarly to a timeout - the socket is closed with a GCDAsyncSocketReadMaxedOutError.<br/>
    2693. 

  2693. The read will complete successfully if exactly maxLength bytes are read and the given data is found at the end.</p>
    2694. 

  2694. 

  2695. <p>If you pass nil or zero-length data as the &ldquo;data&rdquo; parameter,<br/>
    2696. 

  2696. the method will do nothing (except maybe print a warning), and the <a href="#//api/name/delegate">delegate</a> will not be called.<br/>
    2697. 

  2697. If you pass a maxLength parameter that is less than the length of the data parameter,<br/>
    2698. 

  2698. the method will do nothing (except maybe print a warning), and the <a href="#//api/name/delegate">delegate</a> will not be called.</p>
    2699. 

  2699. 

  2700. <p>To read a line from the socket, use the line separator (e.g. CRLF for HTTP, see below) as the &ldquo;data&rdquo; parameter.<br/>
    2701. 

  2701. If you&rsquo;re developing your own custom protocol, be sure your separator can not occur naturally as<br/>
    2702. 

  2702. part of the data between separators.<br/>
    2703. 

  2703. For example, imagine you want to send several small documents over a socket.<br/>
    2704. 

  2704. Using CRLF as a separator is likely unwise, as a CRLF could easily exist within the documents.<br/>
    2705. 

  2705. In this particular example, it would be better to use a protocol similar to HTTP with<br/>
    2706. 

  2706. a header that includes the length of the document.<br/>
    2707. 

  2707. Also be careful that your separator cannot occur naturally as part of the encoding for a character.</p>
    2708. 

  2708. 

  2709. <p>The given data (separator) parameter should be immutable.<br/>
    2710. 

  2710. For performance reasons, the socket will retain it, not copy it.<br/>
    2711. 

  2711. So if it is immutable, don&rsquo;t modify it while the socket is using it.</p>
    2712. 

  2712. 	</div>
    2713. 

  2713. 	
    2714. 

  2714. 	
    2715. 

  2715. 	
    2716. 

  2716. 	
    2717. 

  2717. 	
    2718. 

  2718. 	
    2719. 

  2719. 	
    2720. 

  2720. 	<div class="method-subsection declared-in-section">
    2721. 

  2721. 		<h4 class="method-subtitle">Declared In</h4>
    2722. 

  2722. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2723. 

  2723. 	</div>				
    2724. 

  2724. 	
    2725. 

  2725. 	
    2726. 

  2726. </div>
    2727. 

  2727. 						
    2728. 

  2728. 						<div class="section-method">
    2729. 

  2729. 	<a name="//api/name/readDataToData:withTimeout:tag:" title="readDataToData:withTimeout:tag:"></a>
    2730. 

  2730. 	<h3 class="subsubtitle method-title">readDataToData:withTimeout:tag:</h3>
    2731. 

  2731. 	
    2732. 

  2732. 	
    2733. 

  2733. 	
    2734. 

  2734. 	<div class="method-subsection brief-description">
    2735. 

  2735. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p>
    2736. 

  2736. 	</div>		
    2737. 

  2737. 	
    2738. 

  2738.     
    2739. 

  2739. 

  2740. 	<div class="method-subsection method-declaration"><code>- (void)readDataToData:(NSData *)<em>data</em> withTimeout:(NSTimeInterval)<em>timeout</em> tag:(long)<em>tag</em></code></div>
    2741. 

  2741. 

  2742.     
    2743. 

  2743. 	
    2744. 

  2744. 	
    2745. 

  2745. 	
    2746. 

  2746. 	
    2747. 

  2747. 	
    2748. 

  2748. 	
    2749. 

  2749. 	
    2750. 

  2750. 	<div class="method-subsection discussion-section">
    2751. 

  2751. 		<h4 class="method-subtitle">Discussion</h4>
    2752. 

  2752. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p>
    2753. 

  2753. 

  2754. <p>If the timeout value is negative, the read operation will not use a timeout.</p>
    2755. 

  2755. 

  2756. <p>If you pass nil or zero-length data as the &ldquo;data&rdquo; parameter,<br/>
    2757. 

  2757. the method will do nothing (except maybe print a warning), and the <a href="#//api/name/delegate">delegate</a> will not be called.</p>
    2758. 

  2758. 

  2759. <p>To read a line from the socket, use the line separator (e.g. CRLF for HTTP, see below) as the &ldquo;data&rdquo; parameter.<br/>
    2760. 

  2760. If you&rsquo;re developing your own custom protocol, be sure your separator can not occur naturally as<br/>
    2761. 

  2761. part of the data between separators.<br/>
    2762. 

  2762. For example, imagine you want to send several small documents over a socket.<br/>
    2763. 

  2763. Using CRLF as a separator is likely unwise, as a CRLF could easily exist within the documents.<br/>
    2764. 

  2764. In this particular example, it would be better to use a protocol similar to HTTP with<br/>
    2765. 

  2765. a header that includes the length of the document.<br/>
    2766. 

  2766. Also be careful that your separator cannot occur naturally as part of the encoding for a character.</p>
    2767. 

  2767. 

  2768. <p>The given data (separator) parameter should be immutable.<br/>
    2769. 

  2769. For performance reasons, the socket will retain it, not copy it.<br/>
    2770. 

  2770. So if it is immutable, don&rsquo;t modify it while the socket is using it.</p>
    2771. 

  2771. 	</div>
    2772. 

  2772. 	
    2773. 

  2773. 	
    2774. 

  2774. 	
    2775. 

  2775. 	
    2776. 

  2776. 	
    2777. 

  2777. 	
    2778. 

  2778. 	
    2779. 

  2779. 	<div class="method-subsection declared-in-section">
    2780. 

  2780. 		<h4 class="method-subtitle">Declared In</h4>
    2781. 

  2781. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2782. 

  2782. 	</div>				
    2783. 

  2783. 	
    2784. 

  2784. 	
    2785. 

  2785. </div>
    2786. 

  2786. 						
    2787. 

  2787. 						<div class="section-method">
    2788. 

  2788. 	<a name="//api/name/readDataToLength:withTimeout:buffer:bufferOffset:tag:" title="readDataToLength:withTimeout:buffer:bufferOffset:tag:"></a>
    2789. 

  2789. 	<h3 class="subsubtitle method-title">readDataToLength:withTimeout:buffer:bufferOffset:tag:</h3>
    2790. 

  2790. 	
    2791. 

  2791. 	
    2792. 

  2792. 	
    2793. 

  2793. 	<div class="method-subsection brief-description">
    2794. 

  2794. 		<p>Reads the given number of bytes.<br/>
    2795. 

  2795. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2796. 

  2796. The given buffer will automatically be increased in size if needed.</p>
    2797. 

  2797. 	</div>		
    2798. 

  2798. 	
    2799. 

  2799.     
    2800. 

  2800. 

  2801. 	<div class="method-subsection method-declaration"><code>- (void)readDataToLength:(NSUInteger)<em>length</em> withTimeout:(NSTimeInterval)<em>timeout</em> buffer:(NSMutableData *)<em>buffer</em> bufferOffset:(NSUInteger)<em>offset</em> tag:(long)<em>tag</em></code></div>
    2802. 

  2802. 

  2803.     
    2804. 

  2804. 	
    2805. 

  2805. 	
    2806. 

  2806. 	
    2807. 

  2807. 	
    2808. 

  2808. 	
    2809. 

  2809. 	
    2810. 

  2810. 	
    2811. 

  2811. 	<div class="method-subsection discussion-section">
    2812. 

  2812. 		<h4 class="method-subtitle">Discussion</h4>
    2813. 

  2813. 		<p>Reads the given number of bytes.<br/>
    2814. 

  2814. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2815. 

  2815. The given buffer will automatically be increased in size if needed.</p>
    2816. 

  2816. 

  2817. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    2818. 

  2818. If the buffer if nil, a buffer will automatically be created for you.</p>
    2819. 

  2819. 

  2820. <p>If the length is 0, this method does nothing and the delegate is not called.<br/>
    2821. 

  2821. If the bufferOffset is greater than the length of the given buffer,<br/>
    2822. 

  2822. the method will do nothing, and the delegate will not be called.</p>
    2823. 

  2823. 

  2824. <p>If you pass a buffer, you must not alter it in any way while AsyncSocket is using it.<br/>
    2825. 

  2825. After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer.<br/>
    2826. 

  2826. That is, it will reference the bytes that were appended to the given buffer via<br/>
    2827. 

  2827. the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO].</p>
    2828. 

  2828. 	</div>
    2829. 

  2829. 	
    2830. 

  2830. 	
    2831. 

  2831. 	
    2832. 

  2832. 	
    2833. 

  2833. 	
    2834. 

  2834. 	
    2835. 

  2835. 	
    2836. 

  2836. 	<div class="method-subsection declared-in-section">
    2837. 

  2837. 		<h4 class="method-subtitle">Declared In</h4>
    2838. 

  2838. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2839. 

  2839. 	</div>				
    2840. 

  2840. 	
    2841. 

  2841. 	
    2842. 

  2842. </div>
    2843. 

  2843. 						
    2844. 

  2844. 						<div class="section-method">
    2845. 

  2845. 	<a name="//api/name/readDataToLength:withTimeout:tag:" title="readDataToLength:withTimeout:tag:"></a>
    2846. 

  2846. 	<h3 class="subsubtitle method-title">readDataToLength:withTimeout:tag:</h3>
    2847. 

  2847. 	
    2848. 

  2848. 	
    2849. 

  2849. 	
    2850. 

  2850. 	<div class="method-subsection brief-description">
    2851. 

  2851. 		<p>Reads the given number of bytes.</p>
    2852. 

  2852. 	</div>		
    2853. 

  2853. 	
    2854. 

  2854.     
    2855. 

  2855. 

  2856. 	<div class="method-subsection method-declaration"><code>- (void)readDataToLength:(NSUInteger)<em>length</em> withTimeout:(NSTimeInterval)<em>timeout</em> tag:(long)<em>tag</em></code></div>
    2857. 

  2857. 

  2858.     
    2859. 

  2859. 	
    2860. 

  2860. 	
    2861. 

  2861. 	
    2862. 

  2862. 	
    2863. 

  2863. 	
    2864. 

  2864. 	
    2865. 

  2865. 	
    2866. 

  2866. 	<div class="method-subsection discussion-section">
    2867. 

  2867. 		<h4 class="method-subtitle">Discussion</h4>
    2868. 

  2868. 		<p>Reads the given number of bytes.</p>
    2869. 

  2869. 

  2870. <p>If the timeout value is negative, the read operation will not use a timeout.</p>
    2871. 

  2871. 

  2872. <p>If the length is 0, this method does nothing and the <a href="#//api/name/delegate">delegate</a> is not called.</p>
    2873. 

  2873. 	</div>
    2874. 

  2874. 	
    2875. 

  2875. 	
    2876. 

  2876. 	
    2877. 

  2877. 	
    2878. 

  2878. 	
    2879. 

  2879. 	
    2880. 

  2880. 	
    2881. 

  2881. 	<div class="method-subsection declared-in-section">
    2882. 

  2882. 		<h4 class="method-subtitle">Declared In</h4>
    2883. 

  2883. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2884. 

  2884. 	</div>				
    2885. 

  2885. 	
    2886. 

  2886. 	
    2887. 

  2887. </div>
    2888. 

  2888. 						
    2889. 

  2889. 						<div class="section-method">
    2890. 

  2890. 	<a name="//api/name/readDataWithTimeout:buffer:bufferOffset:maxLength:tag:" title="readDataWithTimeout:buffer:bufferOffset:maxLength:tag:"></a>
    2891. 

  2891. 	<h3 class="subsubtitle method-title">readDataWithTimeout:buffer:bufferOffset:maxLength:tag:</h3>
    2892. 

  2892. 	
    2893. 

  2893. 	
    2894. 

  2894. 	
    2895. 

  2895. 	<div class="method-subsection brief-description">
    2896. 

  2896. 		<p>Reads the first available bytes that become available on the socket.<br/>
    2897. 

  2897. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2898. 

  2898. The given buffer will automatically be increased in size if needed.<br/>
    2899. 

  2899. A maximum of length bytes will be read.</p>
    2900. 

  2900. 	</div>		
    2901. 

  2901. 	
    2902. 

  2902.     
    2903. 

  2903. 

  2904. 	<div class="method-subsection method-declaration"><code>- (void)readDataWithTimeout:(NSTimeInterval)<em>timeout</em> buffer:(NSMutableData *)<em>buffer</em> bufferOffset:(NSUInteger)<em>offset</em> maxLength:(NSUInteger)<em>length</em> tag:(long)<em>tag</em></code></div>
    2905. 

  2905. 

  2906.     
    2907. 

  2907. 	
    2908. 

  2908. 	
    2909. 

  2909. 	
    2910. 

  2910. 	
    2911. 

  2911. 	
    2912. 

  2912. 	
    2913. 

  2913. 	
    2914. 

  2914. 	<div class="method-subsection discussion-section">
    2915. 

  2915. 		<h4 class="method-subtitle">Discussion</h4>
    2916. 

  2916. 		<p>Reads the first available bytes that become available on the socket.<br/>
    2917. 

  2917. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2918. 

  2918. The given buffer will automatically be increased in size if needed.<br/>
    2919. 

  2919. A maximum of length bytes will be read.</p>
    2920. 

  2920. 

  2921. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    2922. 

  2922. If the buffer if nil, a buffer will automatically be created for you.<br/>
    2923. 

  2923. If maxLength is zero, no length restriction is enforced.</p>
    2924. 

  2924. 

  2925. <p>If the bufferOffset is greater than the length of the given buffer,<br/>
    2926. 

  2926. the method will do nothing, and the delegate will not be called.</p>
    2927. 

  2927. 

  2928. <p>If you pass a buffer, you must not alter it in any way while the socket is using it.<br/>
    2929. 

  2929. After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer.<br/>
    2930. 

  2930. That is, it will reference the bytes that were appended to the given buffer  via<br/>
    2931. 

  2931. the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO].</p>
    2932. 

  2932. 	</div>
    2933. 

  2933. 	
    2934. 

  2934. 	
    2935. 

  2935. 	
    2936. 

  2936. 	
    2937. 

  2937. 	
    2938. 

  2938. 	
    2939. 

  2939. 	
    2940. 

  2940. 	<div class="method-subsection declared-in-section">
    2941. 

  2941. 		<h4 class="method-subtitle">Declared In</h4>
    2942. 

  2942. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2943. 

  2943. 	</div>				
    2944. 

  2944. 	
    2945. 

  2945. 	
    2946. 

  2946. </div>
    2947. 

  2947. 						
    2948. 

  2948. 						<div class="section-method">
    2949. 

  2949. 	<a name="//api/name/readDataWithTimeout:buffer:bufferOffset:tag:" title="readDataWithTimeout:buffer:bufferOffset:tag:"></a>
    2950. 

  2950. 	<h3 class="subsubtitle method-title">readDataWithTimeout:buffer:bufferOffset:tag:</h3>
    2951. 

  2951. 	
    2952. 

  2952. 	
    2953. 

  2953. 	
    2954. 

  2954. 	<div class="method-subsection brief-description">
    2955. 

  2955. 		<p>Reads the first available bytes that become available on the socket.<br/>
    2956. 

  2956. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2957. 

  2957. The given buffer will automatically be increased in size if needed.</p>
    2958. 

  2958. 	</div>		
    2959. 

  2959. 	
    2960. 

  2960.     
    2961. 

  2961. 

  2962. 	<div class="method-subsection method-declaration"><code>- (void)readDataWithTimeout:(NSTimeInterval)<em>timeout</em> buffer:(NSMutableData *)<em>buffer</em> bufferOffset:(NSUInteger)<em>offset</em> tag:(long)<em>tag</em></code></div>
    2963. 

  2963. 

  2964.     
    2965. 

  2965. 	
    2966. 

  2966. 	
    2967. 

  2967. 	
    2968. 

  2968. 	
    2969. 

  2969. 	
    2970. 

  2970. 	
    2971. 

  2971. 	
    2972. 

  2972. 	<div class="method-subsection discussion-section">
    2973. 

  2973. 		<h4 class="method-subtitle">Discussion</h4>
    2974. 

  2974. 		<p>Reads the first available bytes that become available on the socket.<br/>
    2975. 

  2975. The bytes will be appended to the given byte buffer starting at the given offset.<br/>
    2976. 

  2976. The given buffer will automatically be increased in size if needed.</p>
    2977. 

  2977. 

  2978. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    2979. 

  2979. If the buffer if nil, the socket will create a buffer for you.</p>
    2980. 

  2980. 

  2981. <p>If the bufferOffset is greater than the length of the given buffer,<br/>
    2982. 

  2982. the method will do nothing, and the delegate will not be called.</p>
    2983. 

  2983. 

  2984. <p>If you pass a buffer, you must not alter it in any way while the socket is using it.<br/>
    2985. 

  2985. After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer.<br/>
    2986. 

  2986. That is, it will reference the bytes that were appended to the given buffer via<br/>
    2987. 

  2987. the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO].</p>
    2988. 

  2988. 	</div>
    2989. 

  2989. 	
    2990. 

  2990. 	
    2991. 

  2991. 	
    2992. 

  2992. 	
    2993. 

  2993. 	
    2994. 

  2994. 	
    2995. 

  2995. 	
    2996. 

  2996. 	<div class="method-subsection declared-in-section">
    2997. 

  2997. 		<h4 class="method-subtitle">Declared In</h4>
    2998. 

  2998. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    2999. 

  2999. 	</div>				
    3000. 

  3000. 	
    3001. 

  3001. 	
    3002. 

  3002. </div>
    3003. 

  3003. 						
    3004. 

  3004. 						<div class="section-method">
    3005. 

  3005. 	<a name="//api/name/readDataWithTimeout:tag:" title="readDataWithTimeout:tag:"></a>
    3006. 

  3006. 	<h3 class="subsubtitle method-title">readDataWithTimeout:tag:</h3>
    3007. 

  3007. 	
    3008. 

  3008. 	
    3009. 

  3009. 	
    3010. 

  3010. 	<div class="method-subsection brief-description">
    3011. 

  3011. 		<p>Reads the first available bytes that become available on the socket.</p>
    3012. 

  3012. 	</div>		
    3013. 

  3013. 	
    3014. 

  3014.     
    3015. 

  3015. 

  3016. 	<div class="method-subsection method-declaration"><code>- (void)readDataWithTimeout:(NSTimeInterval)<em>timeout</em> tag:(long)<em>tag</em></code></div>
    3017. 

  3017. 

  3018.     
    3019. 

  3019. 	
    3020. 

  3020. 	
    3021. 

  3021. 	
    3022. 

  3022. 	
    3023. 

  3023. 	
    3024. 

  3024. 	
    3025. 

  3025. 	
    3026. 

  3026. 	<div class="method-subsection discussion-section">
    3027. 

  3027. 		<h4 class="method-subtitle">Discussion</h4>
    3028. 

  3028. 		<p>Reads the first available bytes that become available on the socket.</p>
    3029. 

  3029. 

  3030. <p>If the timeout value is negative, the read operation will not use a timeout.</p>
    3031. 

  3031. 	</div>
    3032. 

  3032. 	
    3033. 

  3033. 	
    3034. 

  3034. 	
    3035. 

  3035. 	
    3036. 

  3036. 	
    3037. 

  3037. 	
    3038. 

  3038. 	
    3039. 

  3039. 	<div class="method-subsection declared-in-section">
    3040. 

  3040. 		<h4 class="method-subtitle">Declared In</h4>
    3041. 

  3041. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    3042. 

  3042. 	</div>				
    3043. 

  3043. 	
    3044. 

  3044. 	
    3045. 

  3045. </div>
    3046. 

  3046. 						
    3047. 

  3047. 						<div class="section-method">
    3048. 

  3048. 	<a name="//api/name/readStream" title="readStream"></a>
    3049. 

  3049. 	<h3 class="subsubtitle method-title">readStream</h3>
    3050. 

  3050. 	
    3051. 

  3051. 	
    3052. 

  3052. 	
    3053. 

  3053. 	<div class="method-subsection brief-description">
    3054. 

  3054. 		<p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    3055. 

  3055. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p>
    3056. 

  3056. 	</div>		
    3057. 

  3057. 	
    3058. 

  3058.     
    3059. 

  3059. 

  3060. 	<div class="method-subsection method-declaration"><code>- (CFReadStreamRef)readStream</code></div>
    3061. 

  3061. 

  3062.     
    3063. 

  3063. 	
    3064. 

  3064. 	
    3065. 

  3065. 	
    3066. 

  3066. 	
    3067. 

  3067. 	
    3068. 

  3068. 	
    3069. 

  3069. 	
    3070. 

  3070. 	<div class="method-subsection discussion-section">
    3071. 

  3071. 		<h4 class="method-subtitle">Discussion</h4>
    3072. 

  3072. 		<p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    3073. 

  3073. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p>
    3074. 

  3074. 

  3075. <p>Provides access to the socket&rsquo;s internal CFReadStream/CFWriteStream.</p>
    3076. 

  3076. 

  3077. <p>These streams are only used as workarounds for specific iOS shortcomings:</p>
    3078. 

  3078. 

  3079. <ul>
    3080. 

  3080. <li><p>Apple has decided to keep the SecureTransport framework private is iOS.<br/>
    3081. 

  3081. This means the only supplied way to do SSL/TLS is via CFStream or some other API layered on top of it.<br/>
    3082. 

  3082. Thus, in order to provide SSL/TLS support on iOS we are forced to rely on CFStream,<br/>
    3083. 

  3083. instead of the preferred and faster and more powerful SecureTransport.</p></li>
    3084. 

  3084. <li><p>If a socket doesn&rsquo;t have backgrounding enabled, and that socket is closed while the app is backgrounded,<br/>
    3085. 

  3085. Apple only bothers to notify us via the CFStream API.<br/>
    3086. 

  3086. The faster and more powerful GCD API isn&rsquo;t notified properly in this case.</p></li>
    3087. 

  3087. </ul>
    3088. 

  3088. 

  3089. 

  3090. <p>See also: (BOOL)<a href="#//api/name/enableBackgroundingOnSocket">enableBackgroundingOnSocket</a></p>
    3091. 

  3091. 	</div>
    3092. 

  3092. 	
    3093. 

  3093. 	
    3094. 

  3094. 	
    3095. 

  3095. 	
    3096. 

  3096. 	
    3097. 

  3097. 	
    3098. 

  3098. 	
    3099. 

  3099. 	<div class="method-subsection declared-in-section">
    3100. 

  3100. 		<h4 class="method-subtitle">Declared In</h4>
    3101. 

  3101. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    3102. 

  3102. 	</div>				
    3103. 

  3103. 	
    3104. 

  3104. 	
    3105. 

  3105. </div>
    3106. 

  3106. 						
    3107. 

  3107. 						<div class="section-method">
    3108. 

  3108. 	<a name="//api/name/setAutoDisconnectOnClosedReadStream:" title="setAutoDisconnectOnClosedReadStream:"></a>
    3109. 

  3109. 	<h3 class="subsubtitle method-title">setAutoDisconnectOnClosedReadStream:</h3>
    3110. 

  3110. 	
    3111. 

  3111. 	
    3112. 

  3112. 

  3113. 	<div class="method-subsection method-declaration"><code>- (void)setAutoDisconnectOnClosedReadStream:(BOOL)<em>flag</em></code></div>
    3114. 

  3114. 

  3115.     
    3116. 

  3116. </div>
    3117. 

  3117. 						
    3118. 

  3118. 						<div class="section-method">
    3119. 

  3119. 	<a name="//api/name/setDelegate:" title="setDelegate:"></a>
    3120. 

  3120. 	<h3 class="subsubtitle method-title">setDelegate:</h3>
    3121. 

  3121. 	
    3122. 

  3122. 	
    3123. 

  3123. 

  3124. 	<div class="method-subsection method-declaration"><code>- (void)setDelegate:(id)<em>delegate</em></code></div>
    3125. 

  3125. 

  3126.     
    3127. 

  3127. </div>
    3128. 

  3128. 						
    3129. 

  3129. 						<div class="section-method">
    3130. 

  3130. 	<a name="//api/name/setDelegate:delegateQueue:" title="setDelegate:delegateQueue:"></a>
    3131. 

  3131. 	<h3 class="subsubtitle method-title">setDelegate:delegateQueue:</h3>
    3132. 

  3132. 	
    3133. 

  3133. 	
    3134. 

  3134. 

  3135. 	<div class="method-subsection method-declaration"><code>- (void)setDelegate:(id)<em>delegate</em> delegateQueue:(dispatch_queue_t)<em>delegateQueue</em></code></div>
    3136. 

  3136. 

  3137.     
    3138. 

  3138. </div>
    3139. 

  3139. 						
    3140. 

  3140. 						<div class="section-method">
    3141. 

  3141. 	<a name="//api/name/setDelegateQueue:" title="setDelegateQueue:"></a>
    3142. 

  3142. 	<h3 class="subsubtitle method-title">setDelegateQueue:</h3>
    3143. 

  3143. 	
    3144. 

  3144. 	
    3145. 

  3145. 

  3146. 	<div class="method-subsection method-declaration"><code>- (void)setDelegateQueue:(dispatch_queue_t)<em>delegateQueue</em></code></div>
    3147. 

  3147. 

  3148.     
    3149. 

  3149. </div>
    3150. 

  3150. 						
    3151. 

  3151. 						<div class="section-method">
    3152. 

  3152. 	<a name="//api/name/setIPv4Enabled:" title="setIPv4Enabled:"></a>
    3153. 

  3153. 	<h3 class="subsubtitle method-title">setIPv4Enabled:</h3>
    3154. 

  3154. 	
    3155. 

  3155. 	
    3156. 

  3156. 

  3157. 	<div class="method-subsection method-declaration"><code>- (void)setIPv4Enabled:(BOOL)<em>flag</em></code></div>
    3158. 

  3158. 

  3159.     
    3160. 

  3160. </div>
    3161. 

  3161. 						
    3162. 

  3162. 						<div class="section-method">
    3163. 

  3163. 	<a name="//api/name/setIPv6Enabled:" title="setIPv6Enabled:"></a>
    3164. 

  3164. 	<h3 class="subsubtitle method-title">setIPv6Enabled:</h3>
    3165. 

  3165. 	
    3166. 

  3166. 	
    3167. 

  3167. 

  3168. 	<div class="method-subsection method-declaration"><code>- (void)setIPv6Enabled:(BOOL)<em>flag</em></code></div>
    3169. 

  3169. 

  3170.     
    3171. 

  3171. </div>
    3172. 

  3172. 						
    3173. 

  3173. 						<div class="section-method">
    3174. 

  3174. 	<a name="//api/name/setPreferIPv4OverIPv6:" title="setPreferIPv4OverIPv6:"></a>
    3175. 

  3175. 	<h3 class="subsubtitle method-title">setPreferIPv4OverIPv6:</h3>
    3176. 

  3176. 	
    3177. 

  3177. 	
    3178. 

  3178. 

  3179. 	<div class="method-subsection method-declaration"><code>- (void)setPreferIPv4OverIPv6:(BOOL)<em>flag</em></code></div>
    3180. 

  3180. 

  3181.     
    3182. 

  3182. </div>
    3183. 

  3183. 						
    3184. 

  3184. 						<div class="section-method">
    3185. 

  3185. 	<a name="//api/name/setUserData:" title="setUserData:"></a>
    3186. 

  3186. 	<h3 class="subsubtitle method-title">setUserData:</h3>
    3187. 

  3187. 	
    3188. 

  3188. 	
    3189. 

  3189. 

  3190. 	<div class="method-subsection method-declaration"><code>- (void)setUserData:(id)<em>arbitraryUserData</em></code></div>
    3191. 

  3191. 

  3192.     
    3193. 

  3193. </div>
    3194. 

  3194. 						
    3195. 

  3195. 						<div class="section-method">
    3196. 

  3196. 	<a name="//api/name/socket4FD" title="socket4FD"></a>
    3197. 

  3197. 	<h3 class="subsubtitle method-title">socket4FD</h3>
    3198. 

  3198. 	
    3199. 

  3199. 	
    3200. 

  3200. 

  3201. 	<div class="method-subsection method-declaration"><code>- (int)socket4FD</code></div>
    3202. 

  3202. 

  3203.     
    3204. 

  3204. </div>
    3205. 

  3205. 						
    3206. 

  3206. 						<div class="section-method">
    3207. 

  3207. 	<a name="//api/name/socket6FD" title="socket6FD"></a>
    3208. 

  3208. 	<h3 class="subsubtitle method-title">socket6FD</h3>
    3209. 

  3209. 	
    3210. 

  3210. 	
    3211. 

  3211. 

  3212. 	<div class="method-subsection method-declaration"><code>- (int)socket6FD</code></div>
    3213. 

  3213. 

  3214.     
    3215. 

  3215. </div>
    3216. 

  3216. 						
    3217. 

  3217. 						<div class="section-method">
    3218. 

  3218. 	<a name="//api/name/socketFD" title="socketFD"></a>
    3219. 

  3219. 	<h3 class="subsubtitle method-title">socketFD</h3>
    3220. 

  3220. 	
    3221. 

  3221. 	
    3222. 

  3222. 	
    3223. 

  3223. 	<div class="method-subsection brief-description">
    3224. 

  3224. 		<p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    3225. 

  3225. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p>
    3226. 

  3226. 	</div>		
    3227. 

  3227. 	
    3228. 

  3228.     
    3229. 

  3229. 

  3230. 	<div class="method-subsection method-declaration"><code>- (int)socketFD</code></div>
    3231. 

  3231. 

  3232.     
    3233. 

  3233. 	
    3234. 

  3234. 	
    3235. 

  3235. 	
    3236. 

  3236. 	
    3237. 

  3237. 	
    3238. 

  3238. 	
    3239. 

  3239. 	
    3240. 

  3240. 	<div class="method-subsection discussion-section">
    3241. 

  3241. 		<h4 class="method-subtitle">Discussion</h4>
    3242. 

  3242. 		<p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    3243. 

  3243. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p>
    3244. 

  3244. 

  3245. <p>Provides access to the socket&rsquo;s file descriptor(s).<br/>
    3246. 

  3246. If the socket is a server socket (is accepting incoming connections),<br/>
    3247. 

  3247. it might actually have multiple internal socket file descriptors - one for IPv4 and one for IPv6.</p>
    3248. 

  3248. 	</div>
    3249. 

  3249. 	
    3250. 

  3250. 	
    3251. 

  3251. 	
    3252. 

  3252. 	
    3253. 

  3253. 	
    3254. 

  3254. 	
    3255. 

  3255. 	
    3256. 

  3256. 	<div class="method-subsection declared-in-section">
    3257. 

  3257. 		<h4 class="method-subtitle">Declared In</h4>
    3258. 

  3258. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    3259. 

  3259. 	</div>				
    3260. 

  3260. 	
    3261. 

  3261. 	
    3262. 

  3262. </div>
    3263. 

  3263. 						
    3264. 

  3264. 						<div class="section-method">
    3265. 

  3265. 	<a name="//api/name/sslContext" title="sslContext"></a>
    3266. 

  3266. 	<h3 class="subsubtitle method-title">sslContext</h3>
    3267. 

  3267. 	
    3268. 

  3268. 	
    3269. 

  3269. 	
    3270. 

  3270. 	<div class="method-subsection brief-description">
    3271. 

  3271. 		<p>This method is only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    3272. 

  3272. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p>
    3273. 

  3273. 	</div>		
    3274. 

  3274. 	
    3275. 

  3275.     
    3276. 

  3276. 

  3277. 	<div class="method-subsection method-declaration"><code>- (SSLContextRef)sslContext</code></div>
    3278. 

  3278. 

  3279.     
    3280. 

  3280. 	
    3281. 

  3281. 	
    3282. 

  3282. 	
    3283. 

  3283. 	
    3284. 

  3284. 	
    3285. 

  3285. 	
    3286. 

  3286. 	
    3287. 

  3287. 	<div class="method-subsection discussion-section">
    3288. 

  3288. 		<h4 class="method-subtitle">Discussion</h4>
    3289. 

  3289. 		<p>This method is only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    3290. 

  3290. See the documentation for the <a href="#//api/name/performBlock:">performBlock:</a> method above.</p>
    3291. 

  3291. 

  3292. <p>Provides access to the socket&rsquo;s SSLContext, if SSL/TLS has been started on the socket.</p>
    3293. 

  3293. 	</div>
    3294. 

  3294. 	
    3295. 

  3295. 	
    3296. 

  3296. 	
    3297. 

  3297. 	
    3298. 

  3298. 	
    3299. 

  3299. 	
    3300. 

  3300. 	
    3301. 

  3301. 	<div class="method-subsection declared-in-section">
    3302. 

  3302. 		<h4 class="method-subtitle">Declared In</h4>
    3303. 

  3303. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    3304. 

  3304. 	</div>				
    3305. 

  3305. 	
    3306. 

  3306. 	
    3307. 

  3307. </div>
    3308. 

  3308. 						
    3309. 

  3309. 						<div class="section-method">
    3310. 

  3310. 	<a name="//api/name/startTLS:" title="startTLS:"></a>
    3311. 

  3311. 	<h3 class="subsubtitle method-title">startTLS:</h3>
    3312. 

  3312. 	
    3313. 

  3313. 	
    3314. 

  3314. 	
    3315. 

  3315. 	<div class="method-subsection brief-description">
    3316. 

  3316. 		<p>Secures the connection using SSL/TLS.</p>
    3317. 

  3317. 	</div>		
    3318. 

  3318. 	
    3319. 

  3319.     
    3320. 

  3320. 

  3321. 	<div class="method-subsection method-declaration"><code>- (void)startTLS:(NSDictionary *)<em>tlsSettings</em></code></div>
    3322. 

  3322. 

  3323.     
    3324. 

  3324. 	
    3325. 

  3325. 	
    3326. 

  3326. 	
    3327. 

  3327. 	
    3328. 

  3328. 	
    3329. 

  3329. 	
    3330. 

  3330. 	
    3331. 

  3331. 	<div class="method-subsection discussion-section">
    3332. 

  3332. 		<h4 class="method-subtitle">Discussion</h4>
    3333. 

  3333. 		<p>Secures the connection using SSL/TLS.</p>
    3334. 

  3334. 

  3335. <p>This method may be called at any time, and the TLS handshake will occur after all pending reads and writes<br/>
    3336. 

  3336. are finished. This allows one the option of sending a protocol dependent StartTLS message, and queuing<br/>
    3337. 

  3337. the upgrade to TLS at the same time, without having to wait for the write to finish.<br/>
    3338. 

  3338. Any reads or writes scheduled after this method is called will occur over the secured connection.</p>
    3339. 

  3339. 

  3340. <p>The possible keys and values for the TLS settings are well documented.<br/>
    3341. 

  3341. Standard keys are:</p>
    3342. 

  3342. 

  3343. <ul>
    3344. 

  3344. <li>kCFStreamSSLLevel</li>
    3345. 

  3345. <li>kCFStreamSSLAllowsExpiredCertificates</li>
    3346. 

  3346. <li>kCFStreamSSLAllowsExpiredRoots</li>
    3347. 

  3347. <li>kCFStreamSSLAllowsAnyRoot</li>
    3348. 

  3348. <li>kCFStreamSSLValidatesCertificateChain</li>
    3349. 

  3349. <li>kCFStreamSSLPeerName</li>
    3350. 

  3350. <li>kCFStreamSSLCertificates</li>
    3351. 

  3351. <li>kCFStreamSSLIsServer</li>
    3352. 

  3352. </ul>
    3353. 

  3353. 

  3354. 

  3355. <p>If SecureTransport is available on iOS:</p>
    3356. 

  3356. 

  3357. <ul>
    3358. 

  3358. <li>GCDAsyncSocketSSLCipherSuites</li>
    3359. 

  3359. <li>GCDAsyncSocketSSLProtocolVersionMin</li>
    3360. 

  3360. <li>GCDAsyncSocketSSLProtocolVersionMax</li>
    3361. 

  3361. </ul>
    3362. 

  3362. 

  3363. 

  3364. <p>If SecureTransport is available on Mac OS X:</p>
    3365. 

  3365. 

  3366. <ul>
    3367. 

  3367. <li>GCDAsyncSocketSSLCipherSuites</li>
    3368. 

  3368. <li>GCDAsyncSocketSSLDiffieHellmanParameters;</li>
    3369. 

  3369. </ul>
    3370. 

  3370. 

  3371. 

  3372. <p>Please refer to Apple&rsquo;s documentation for associated values, as well as other possible keys.</p>
    3373. 

  3373. 

  3374. <p>If you pass in nil or an empty dictionary, the default settings will be used.</p>
    3375. 

  3375. 

  3376. <p>The default settings will check to make sure the remote party&rsquo;s certificate is signed by a<br/>
    3377. 

  3377. trusted 3rd party certificate agency (e.g. verisign) and that the certificate is not expired.<br/>
    3378. 

  3378. However it will not verify the name on the certificate unless you<br/>
    3379. 

  3379. give it a name to verify against via the kCFStreamSSLPeerName key.<br/>
    3380. 

  3380. The security implications of this are important to understand.<br/>
    3381. 

  3381. Imagine you are attempting to create a secure connection to MySecureServer.com,<br/>
    3382. 

  3382. but your socket gets directed to MaliciousServer.com because of a hacked DNS server.<br/>
    3383. 

  3383. If you simply use the default settings, and MaliciousServer.com has a valid certificate,<br/>
    3384. 

  3384. the default settings will not detect any problems since the certificate is valid.<br/>
    3385. 

  3385. To properly secure your connection in this particular scenario you<br/>
    3386. 

  3386. should set the kCFStreamSSLPeerName property to &ldquo;MySecureServer.com&rdquo;.<br/>
    3387. 

  3387. If you do not know the peer name of the remote host in advance (for example, you&rsquo;re not sure<br/>
    3388. 

  3388. if it will be &ldquo;domain.com&rdquo; or &ldquo;www.domain.com&rdquo;), then you can use the default settings to validate the<br/>
    3389. 

  3389. certificate, and then use the X509Certificate class to verify the issuer after the socket has been secured.<br/>
    3390. 

  3390. The X509Certificate class is part of the Cocoa<a href="../Classes/AsyncSocket.html">AsyncSocket</a> open source project.</p>
    3391. 

  3391. 	</div>
    3392. 

  3392. 	
    3393. 

  3393. 	
    3394. 

  3394. 	
    3395. 

  3395. 	
    3396. 

  3396. 	
    3397. 

  3397. 	
    3398. 

  3398. 	
    3399. 

  3399. 	<div class="method-subsection declared-in-section">
    3400. 

  3400. 		<h4 class="method-subtitle">Declared In</h4>
    3401. 

  3401. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    3402. 

  3402. 	</div>				
    3403. 

  3403. 	
    3404. 

  3404. 	
    3405. 

  3405. </div>
    3406. 

  3406. 						
    3407. 

  3407. 						<div class="section-method">
    3408. 

  3408. 	<a name="//api/name/synchronouslySetDelegate:" title="synchronouslySetDelegate:"></a>
    3409. 

  3409. 	<h3 class="subsubtitle method-title">synchronouslySetDelegate:</h3>
    3410. 

  3410. 	
    3411. 

  3411. 	
    3412. 

  3412. 

  3413. 	<div class="method-subsection method-declaration"><code>- (void)synchronouslySetDelegate:(id)<em>delegate</em></code></div>
    3414. 

  3414. 

  3415.     
    3416. 

  3416. </div>
    3417. 

  3417. 						
    3418. 

  3418. 						<div class="section-method">
    3419. 

  3419. 	<a name="//api/name/synchronouslySetDelegate:delegateQueue:" title="synchronouslySetDelegate:delegateQueue:"></a>
    3420. 

  3420. 	<h3 class="subsubtitle method-title">synchronouslySetDelegate:delegateQueue:</h3>
    3421. 

  3421. 	
    3422. 

  3422. 	
    3423. 

  3423. 

  3424. 	<div class="method-subsection method-declaration"><code>- (void)synchronouslySetDelegate:(id)<em>delegate</em> delegateQueue:(dispatch_queue_t)<em>delegateQueue</em></code></div>
    3425. 

  3425. 

  3426.     
    3427. 

  3427. </div>
    3428. 

  3428. 						
    3429. 

  3429. 						<div class="section-method">
    3430. 

  3430. 	<a name="//api/name/synchronouslySetDelegateQueue:" title="synchronouslySetDelegateQueue:"></a>
    3431. 

  3431. 	<h3 class="subsubtitle method-title">synchronouslySetDelegateQueue:</h3>
    3432. 

  3432. 	
    3433. 

  3433. 	
    3434. 

  3434. 

  3435. 	<div class="method-subsection method-declaration"><code>- (void)synchronouslySetDelegateQueue:(dispatch_queue_t)<em>delegateQueue</em></code></div>
    3436. 

  3436. 

  3437.     
    3438. 

  3438. </div>
    3439. 

  3439. 						
    3440. 

  3440. 						<div class="section-method">
    3441. 

  3441. 	<a name="//api/name/userData" title="userData"></a>
    3442. 

  3442. 	<h3 class="subsubtitle method-title">userData</h3>
    3443. 

  3443. 	
    3444. 

  3444. 	
    3445. 

  3445. 	
    3446. 

  3446. 	<div class="method-subsection brief-description">
    3447. 

  3447. 		<p>User data allows you to associate arbitrary information with the socket.<br/>
    3448. 

  3448. This data is not used internally by socket in any way.</p>
    3449. 

  3449. 	</div>		
    3450. 

  3450. 	
    3451. 

  3451.     
    3452. 

  3452. 

  3453. 	<div class="method-subsection method-declaration"><code>- (id)userData</code></div>
    3454. 

  3454. 

  3455.     
    3456. 

  3456. 	
    3457. 

  3457. 	
    3458. 

  3458. 	
    3459. 

  3459. 	
    3460. 

  3460. 	
    3461. 

  3461. 	
    3462. 

  3462. 	
    3463. 

  3463. 	<div class="method-subsection discussion-section">
    3464. 

  3464. 		<h4 class="method-subtitle">Discussion</h4>
    3465. 

  3465. 		<p>User data allows you to associate arbitrary information with the socket.<br/>
    3466. 

  3466. This data is not used internally by socket in any way.</p>
    3467. 

  3467. 	</div>
    3468. 

  3468. 	
    3469. 

  3469. 	
    3470. 

  3470. 	
    3471. 

  3471. 	
    3472. 

  3472. 	
    3473. 

  3473. 	
    3474. 

  3474. 	
    3475. 

  3475. 	<div class="method-subsection declared-in-section">
    3476. 

  3476. 		<h4 class="method-subtitle">Declared In</h4>
    3477. 

  3477. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    3478. 

  3478. 	</div>				
    3479. 

  3479. 	
    3480. 

  3480. 	
    3481. 

  3481. </div>
    3482. 

  3482. 						
    3483. 

  3483. 						<div class="section-method">
    3484. 

  3484. 	<a name="//api/name/writeData:withTimeout:tag:" title="writeData:withTimeout:tag:"></a>
    3485. 

  3485. 	<h3 class="subsubtitle method-title">writeData:withTimeout:tag:</h3>
    3486. 

  3486. 	
    3487. 

  3487. 	
    3488. 

  3488. 	
    3489. 

  3489. 	<div class="method-subsection brief-description">
    3490. 

  3490. 		<p>Writes data to the socket, and calls the <a href="#//api/name/delegate">delegate</a> when finished.</p>
    3491. 

  3491. 	</div>		
    3492. 

  3492. 	
    3493. 

  3493.     
    3494. 

  3494. 

  3495. 	<div class="method-subsection method-declaration"><code>- (void)writeData:(NSData *)<em>data</em> withTimeout:(NSTimeInterval)<em>timeout</em> tag:(long)<em>tag</em></code></div>
    3496. 

  3496. 

  3497.     
    3498. 

  3498. 	
    3499. 

  3499. 	
    3500. 

  3500. 	
    3501. 

  3501. 	
    3502. 

  3502. 	
    3503. 

  3503. 	
    3504. 

  3504. 	
    3505. 

  3505. 	<div class="method-subsection discussion-section">
    3506. 

  3506. 		<h4 class="method-subtitle">Discussion</h4>
    3507. 

  3507. 		<p>Writes data to the socket, and calls the <a href="#//api/name/delegate">delegate</a> when finished.</p>
    3508. 

  3508. 

  3509. <p>If you pass in nil or zero-length data, this method does nothing and the <a href="#//api/name/delegate">delegate</a> will not be called.<br/>
    3510. 

  3510. If the timeout value is negative, the write operation will not use a timeout.</p>
    3511. 

  3511. 

  3512. <p>Thread-Safety Note:<br/>
    3513. 

  3513. If the given data parameter is mutable (NSMutableData) then you MUST NOT alter the data while<br/>
    3514. 

  3514. the socket is writing it. In other words, it&rsquo;s not safe to alter the data until after the <a href="#//api/name/delegate">delegate</a> method<br/>
    3515. 

  3515. socket:didWriteDataWithTag: is invoked signifying that this particular write operation has completed.<br/>
    3516. 

  3516. This is due to the fact that GCD<a href="../Classes/AsyncSocket.html">AsyncSocket</a> does NOT copy the data. It simply retains it.<br/>
    3517. 

  3517. This is for performance reasons. Often times, if NSMutableData is passed, it is because<br/>
    3518. 

  3518. a request/response was built up in memory. Copying this data adds an unwanted/unneeded overhead.<br/>
    3519. 

  3519. If you need to write data from an immutable buffer, and you need to alter the buffer before the socket<br/>
    3520. 

  3520. completes writing the bytes (which is NOT immediately after this method returns, but rather at a later time<br/>
    3521. 

  3521. when the <a href="#//api/name/delegate">delegate</a> method notifies you), then you should first copy the bytes, and pass the copy to this method.</p>
    3522. 

  3522. 	</div>
    3523. 

  3523. 	
    3524. 

  3524. 	
    3525. 

  3525. 	
    3526. 

  3526. 	
    3527. 

  3527. 	
    3528. 

  3528. 	
    3529. 

  3529. 	
    3530. 

  3530. 	<div class="method-subsection declared-in-section">
    3531. 

  3531. 		<h4 class="method-subtitle">Declared In</h4>
    3532. 

  3532. 		<code class="declared-in-ref">GCDAsyncSocket.h</code><br />
    3533. 

  3533. 	</div>				
    3534. 

  3534. 	
    3535. 

  3535. 	
    3536. 

  3536. </div>
    3537. 

  3537. 						
    3538. 

  3538. 						<div class="section-method">
    3539. 

  3539. 	<a name="//api/name/writeStream" title="writeStream"></a>
    3540. 

  3540. 	<h3 class="subsubtitle method-title">writeStream</h3>
    3541. 

  3541. 	
    3542. 

  3542. 	
    3543. 

  3543. 

  3544. 	<div class="method-subsection method-declaration"><code>- (CFWriteStreamRef)writeStream</code></div>
    3545. 

  3545. 

  3546.     
    3547. 

  3547. </div>
    3548. 

  3548. 						
    3549. 

  3549. 					</div>
    3550. 

  3550. 					
    3551. 

  3551. 					
    3552. 

  3552. 				</div>
    3553. 

  3553. 				<div class="main-navigation navigation-bottom">
    3554. 

  3554. 					<ul>
    3555. 

  3555. 	<li><a href="../index.html">Index</a></li>
    3556. 

  3556. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    3557. 

  3557. </ul>
    3558. 

  3558. 				</div>
    3559. 

  3559. 				<div id="footer">
    3560. 

  3560. 					<hr />
    3561. 

  3561. 					<div class="footer-copyright">
    3562. 

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

  3563. 						
    3564. 

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

  3565. 						
    3566. 

  3566. 					</div>
    3567. 

  3567. 				</div>
    3568. 

  3568. 			</div>
    3569. 

  3569. 		</article>
    3570. 

  3570. 		<script type="text/javascript">
    3571. 

  3571. 			function jumpToChange()
    3572. 

  3572. 			{
    3573. 

  3573. 				window.location.hash = this.options[this.selectedIndex].value;
    3574. 

  3574. 			}
    3575. 

  3575. 			
    3576. 

  3576. 			function toggleTOC()
    3577. 

  3577. 			{
    3578. 

  3578. 				var contents = document.getElementById('contents');
    3579. 

  3579. 				var tocContainer = document.getElementById('tocContainer');
    3580. 

  3580. 				
    3581. 

  3581. 				if (this.getAttribute('class') == 'open')
    3582. 

  3582. 				{
    3583. 

  3583. 					this.setAttribute('class', '');
    3584. 

  3584. 					contents.setAttribute('class', '');
    3585. 

  3585. 					tocContainer.setAttribute('class', '');
    3586. 

  3586. 					
    3587. 

  3587. 					window.name = "hideTOC";
    3588. 

  3588. 				}
    3589. 

  3589. 				else
    3590. 

  3590. 				{
    3591. 

  3591. 					this.setAttribute('class', 'open');
    3592. 

  3592. 					contents.setAttribute('class', 'isShowingTOC');
    3593. 

  3593. 					tocContainer.setAttribute('class', 'isShowingTOC');
    3594. 

  3594. 					
    3595. 

  3595. 					window.name = "";
    3596. 

  3596. 				}
    3597. 

  3597. 				return false;
    3598. 

  3598. 			}
    3599. 

  3599. 			
    3600. 

  3600. 			function toggleTOCEntryChildren(e)
    3601. 

  3601. 			{
    3602. 

  3602. 				e.stopPropagation();
    3603. 

  3603. 				var currentClass = this.getAttribute('class');
    3604. 

  3604. 				if (currentClass == 'children') {
    3605. 

  3605. 					this.setAttribute('class', 'children open');
    3606. 

  3606. 				}
    3607. 

  3607. 				else if (currentClass == 'children open') {
    3608. 

  3608. 					this.setAttribute('class', 'children');
    3609. 

  3609. 				}
    3610. 

  3610. 				return false;
    3611. 

  3611. 			}
    3612. 

  3612. 			
    3613. 

  3613. 			function tocEntryClick(e)
    3614. 

  3614. 			{
    3615. 

  3615. 				e.stopPropagation();
    3616. 

  3616. 				return true;
    3617. 

  3617. 			}
    3618. 

  3618. 			
    3619. 

  3619. 			function init()
    3620. 

  3620. 			{
    3621. 

  3621. 				var selectElement = document.getElementById('jumpTo');
    3622. 

  3622. 				selectElement.addEventListener('change', jumpToChange, false);
    3623. 

  3623. 				
    3624. 

  3624. 				var tocButton = document.getElementById('table_of_contents');
    3625. 

  3625. 				tocButton.addEventListener('click', toggleTOC, false);
    3626. 

  3626. 				
    3627. 

  3627. 				var taskTreeItem = document.getElementById('task_treeitem');
    3628. 

  3628. 				if (taskTreeItem.getElementsByTagName('li').length > 0)
    3629. 

  3629. 				{
    3630. 

  3630. 					taskTreeItem.setAttribute('class', 'children');
    3631. 

  3631. 					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
    3632. 

  3632. 				}
    3633. 

  3633. 				
    3634. 

  3634. 				var tocList = document.getElementById('toc');
    3635. 

  3635. 				
    3636. 

  3636. 				var tocEntries = tocList.getElementsByTagName('li');
    3637. 

  3637. 				for (var i = 0; i < tocEntries.length; i++) {
    3638. 

  3638. 					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
    3639. 

  3639. 				}
    3640. 

  3640. 				
    3641. 

  3641. 				var tocLinks = tocList.getElementsByTagName('a');
    3642. 

  3642. 				for (var i = 0; i < tocLinks.length; i++) {
    3643. 

  3643. 					tocLinks[i].addEventListener('click', tocEntryClick, false);
    3644. 

  3644. 				}
    3645. 

  3645. 				
    3646. 

  3646. 				if (window.name == "hideTOC") {
    3647. 

  3647. 					toggleTOC.call(tocButton);
    3648. 

  3648. 				}
    3649. 

  3649. 			}
    3650. 

  3650. 			
    3651. 

  3651. 			window.onload = init;
    3652. 

  3652. 			
    3653. 

  3653. 			// If showing in Xcode, hide the TOC and Header
    3654. 

  3654. 			if (navigator.userAgent.match(/xcode/i)) {
    3655. 

  3655. 				document.getElementById("contents").className = "hideInXcode"
    3656. 

  3656. 				document.getElementById("tocContainer").className = "hideInXcode"
    3657. 

  3657. 				document.getElementById("top_header").className = "hideInXcode"
    3658. 

  3658. 			}
    3659. 

  3659. 			
    3660. 

  3660. 		</script>
    3661. 

  3661. 	</body>
    3662. 

  3662. </html>
    3663.