PageRenderTime 84ms CodeModel.GetById 23ms RepoModel.GetById 1ms app.codeStats 0ms

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

https://gitlab.com/mba811/tokaidoapp
HTML | 2723 lines | 1419 code | 1304 blank | 0 comment | 0 complexity | 521388357f202c0aa2f3639ba34346b2 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>AsyncSocket 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">AsyncSocket 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. 	
    51. 

  51. 	
    52. 

  52. 	
    53. 

  53. 	<option value="instance_methods">Instance Methods</option>
    54. 

  54. 	
    55. 

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

  56. 	
    57. 

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

  58. 	
    59. 

  59. 	<option value="//api/name/addRunLoopMode:">&nbsp;&nbsp;&nbsp;&nbsp;- addRunLoopMode:</option>
    60. 

  60. 	
    61. 

  61. 	<option value="//api/name/canSafelySetDelegate">&nbsp;&nbsp;&nbsp;&nbsp;- canSafelySetDelegate</option>
    62. 

  62. 	
    63. 

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

  64. 	
    65. 

  65. 	<option value="//api/name/connectToAddress:viaInterfaceAddress:withTimeout:error:">&nbsp;&nbsp;&nbsp;&nbsp;- connectToAddress:viaInterfaceAddress:withTimeout:error:</option>
    66. 

  66. 	
    67. 

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

  68. 	
    69. 

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

  70. 	
    71. 

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

  72. 	
    73. 

  73. 	<option value="//api/name/connectedAddress">&nbsp;&nbsp;&nbsp;&nbsp;- connectedAddress</option>
    74. 

  74. 	
    75. 

  75. 	<option value="//api/name/connectedHost">&nbsp;&nbsp;&nbsp;&nbsp;- connectedHost</option>
    76. 

  76. 	
    77. 

  77. 	<option value="//api/name/connectedPort">&nbsp;&nbsp;&nbsp;&nbsp;- connectedPort</option>
    78. 

  78. 	
    79. 

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

  80. 	
    81. 

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

  82. 	
    83. 

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

  84. 	
    85. 

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

  86. 	
    87. 

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

  88. 	
    89. 

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

  90. 	
    91. 

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

  92. 	
    93. 

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

  94. 	
    95. 

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

  96. 	
    97. 

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

  98. 	
    99. 

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

  100. 	
    101. 

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

  102. 	
    103. 

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

  104. 	
    105. 

  105. 	<option value="//api/name/isConnected">&nbsp;&nbsp;&nbsp;&nbsp;- isConnected</option>
    106. 

  106. 	
    107. 

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

  108. 	
    109. 

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

  110. 	
    111. 

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

  112. 	
    113. 

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

  114. 	
    115. 

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

  116. 	
    117. 

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

  118. 	
    119. 

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

  120. 	
    121. 

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

  122. 	
    123. 

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

  124. 	
    125. 

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

  126. 	
    127. 

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

  128. 	
    129. 

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

  130. 	
    131. 

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

  132. 	
    133. 

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

  134. 	
    135. 

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

  136. 	
    137. 

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

  138. 	
    139. 

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

  140. 	
    141. 

  141. 	<option value="//api/name/removeRunLoopMode:">&nbsp;&nbsp;&nbsp;&nbsp;- removeRunLoopMode:</option>
    142. 

  142. 	
    143. 

  143. 	<option value="//api/name/runLoopModes">&nbsp;&nbsp;&nbsp;&nbsp;- runLoopModes</option>
    144. 

  144. 	
    145. 

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

  146. 	
    147. 

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

  148. 	
    149. 

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

  150. 	
    151. 

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

  152. 	
    153. 

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

  154. 	
    155. 

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

  156. 	
    157. 

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

  158. 	
    159. 

  159. 	
    160. 

  160. 	
    161. 

  161. </select>
    162. 

  162. 				</li>
    163. 

  163. 			</ul>
    164. 

  164. 		</header>
    165. 

  165. 		<nav id="tocContainer" class="isShowingTOC">
    166. 

  166. 			<ul id="toc" role="tree">
    167. 

  167. 				
    168. 

  168. 

  169. 

  170. 

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

  172. 	
    173. 

  173. </ul></li>
    174. 

  174. 

  175. 

  176. 

  177. 

  178. 

  179. 

  180. 

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

  182. 	
    183. 

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

  184. 	
    185. 

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

  186. 	
    187. 

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

  188. 	
    189. 

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

  190. 	
    191. 

  191. </ul></li>
    192. 

  192. 

  193. 

  194. 

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

  196. 	
    197. 

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

  198. 	
    199. 

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

  200. 	
    201. 

  201. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/addRunLoopMode:">addRunLoopMode:</a></span></li>
    202. 

  202. 	
    203. 

  203. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/canSafelySetDelegate">canSafelySetDelegate</a></span></li>
    204. 

  204. 	
    205. 

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

  206. 	
    207. 

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

  208. 	
    209. 

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

  210. 	
    211. 

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

  212. 	
    213. 

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

  214. 	
    215. 

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

  216. 	
    217. 

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

  218. 	
    219. 

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

  220. 	
    221. 

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

  222. 	
    223. 

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

  224. 	
    225. 

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

  226. 	
    227. 

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

  228. 	
    229. 

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

  230. 	
    231. 

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

  232. 	
    233. 

  233. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/enablePreBuffering">enablePreBuffering</a></span></li>
    234. 

  234. 	
    235. 

  235. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getCFReadStream">getCFReadStream</a></span></li>
    236. 

  236. 	
    237. 

  237. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getCFSocket">getCFSocket</a></span></li>
    238. 

  238. 	
    239. 

  239. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getCFWriteStream">getCFWriteStream</a></span></li>
    240. 

  240. 	
    241. 

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

  242. 	
    243. 

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

  244. 	
    245. 

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

  246. 	
    247. 

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

  248. 	
    249. 

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

  250. 	
    251. 

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

  252. 	
    253. 

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

  254. 	
    255. 

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

  256. 	
    257. 

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

  258. 	
    259. 

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

  260. 	
    261. 

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

  262. 	
    263. 

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

  264. 	
    265. 

  265. 	<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>
    266. 

  266. 	
    267. 

  267. 	<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>
    268. 

  268. 	
    269. 

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

  270. 	
    271. 

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

  272. 	
    273. 

  273. 	<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>
    274. 

  274. 	
    275. 

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

  276. 	
    277. 

  277. 	<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>
    278. 

  278. 	
    279. 

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

  280. 	
    281. 

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

  282. 	
    283. 

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

  284. 	
    285. 

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

  286. 	
    287. 

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

  288. 	
    289. 

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

  290. 	
    291. 

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

  292. 	
    293. 

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

  294. 	
    295. 

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

  296. 	
    297. 

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

  298. 	
    299. 

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

  300. 	
    301. 

  301. </ul></li>
    302. 

  302. 

  303. 

  304. 			</ul>
    305. 

  305. 		</nav>
    306. 

  306. 		<article>
    307. 

  307. 			<div id="contents" class="isShowingTOC" role="main">
    308. 

  308. 				<a title="AsyncSocket Class Reference" name="top"></a>
    309. 

  309. 				<div class="main-navigation navigation-top">
    310. 

  310. 					<ul>
    311. 

  311. 	<li><a href="../index.html">Index</a></li>
    312. 

  312. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    313. 

  313. </ul>
    314. 

  314. 				</div>
    315. 

  315. 				<div id="header">
    316. 

  316. 					<div class="section-header">
    317. 

  317. 						<h1 class="title title-header">AsyncSocket Class Reference</h1>
    318. 

  318. 					</div>		
    319. 

  319. 				</div>
    320. 

  320. 				<div id="container">	
    321. 

  321. 					
    322. 

  322. 					<div class="section section-specification"><table cellspacing="0"><tbody>
    323. 

  323. 						<tr>
    324. 

  324. 	<td class="specification-title">Inherits from</td>
    325. 

  325. 	<td class="specification-value">NSObject</td>
    326. 

  326. </tr><tr>
    327. 

  327. 	<td class="specification-title">Declared in</td>
    328. 

  328. 	<td class="specification-value">AsyncSocket.h</td>
    329. 

  329. </tr>
    330. 

  330. 						</tbody></table></div>
    331. 

  331. 					
    332. 

  332. 					
    333. 

  333. 					
    334. 

  334. 					
    335. 

  335. 					
    336. 

  336. 					
    337. 

  337. 					<div class="section section-tasks">
    338. 

  338. 						<a title="Tasks" name="tasks"></a>
    339. 

  339. 						<h2 class="subtitle subtitle-tasks">Tasks</h2>
    340. 

  340. 						
    341. 

  341. 						
    342. 

  342. 						
    343. 

  343. 						
    344. 

  344. 

  345. 						<ul class="task-list">
    346. 

  346. 							<li>
    347. 

  347. 	<span class="tooltip">
    348. 

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

  349. 		
    350. 

  350. 	</span>
    351. 

  351. 	
    352. 

  352. 	
    353. 

  353. </li><li>
    354. 

  354. 	<span class="tooltip">
    355. 

  355. 		<code><a href="#//api/name/initWithDelegate:">&ndash;&nbsp;initWithDelegate:</a></code>
    356. 

  356. 		
    357. 

  357. 	</span>
    358. 

  358. 	
    359. 

  359. 	
    360. 

  360. </li><li>
    361. 

  361. 	<span class="tooltip">
    362. 

  362. 		<code><a href="#//api/name/initWithDelegate:userData:">&ndash;&nbsp;initWithDelegate:userData:</a></code>
    363. 

  363. 		
    364. 

  364. 	</span>
    365. 

  365. 	
    366. 

  366. 	
    367. 

  367. </li><li>
    368. 

  368. 	<span class="tooltip">
    369. 

  369. 		<code><a href="#//api/name/description">&ndash;&nbsp;description</a></code>
    370. 

  370. 		
    371. 

  371. 	</span>
    372. 

  372. 	
    373. 

  373. 	
    374. 

  374. </li><li>
    375. 

  375. 	<span class="tooltip">
    376. 

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

  377. 		<span class="tooltip"><p>Use &ldquo;canSafelySetDelegate&rdquo; to see if there is any pending business (reads and writes) with the current delegate<br/>
    378. 

  378. before changing it.  It is, of course, safe to change the delegate before connecting or accepting connections.</p></span>
    379. 

  379. 	</span>
    380. 

  380. 	
    381. 

  381. 	
    382. 

  382. </li><li>
    383. 

  383. 	<span class="tooltip">
    384. 

  384. 		<code><a href="#//api/name/canSafelySetDelegate">&ndash;&nbsp;canSafelySetDelegate</a></code>
    385. 

  385. 		
    386. 

  386. 	</span>
    387. 

  387. 	
    388. 

  388. 	
    389. 

  389. </li><li>
    390. 

  390. 	<span class="tooltip">
    391. 

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

  392. 		
    393. 

  393. 	</span>
    394. 

  394. 	
    395. 

  395. 	
    396. 

  396. </li><li>
    397. 

  397. 	<span class="tooltip">
    398. 

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

  399. 		
    400. 

  400. 	</span>
    401. 

  401. 	
    402. 

  402. 	
    403. 

  403. </li><li>
    404. 

  404. 	<span class="tooltip">
    405. 

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

  406. 		
    407. 

  407. 	</span>
    408. 

  408. 	
    409. 

  409. 	
    410. 

  410. </li><li>
    411. 

  411. 	<span class="tooltip">
    412. 

  412. 		<code><a href="#//api/name/getCFSocket">&ndash;&nbsp;getCFSocket</a></code>
    413. 

  413. 		
    414. 

  414. 	</span>
    415. 

  415. 	
    416. 

  416. 	
    417. 

  417. </li><li>
    418. 

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

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

  420. 		
    421. 

  421. 	</span>
    422. 

  422. 	
    423. 

  423. 	
    424. 

  424. </li><li>
    425. 

  425. 	<span class="tooltip">
    426. 

  426. 		<code><a href="#//api/name/getCFWriteStream">&ndash;&nbsp;getCFWriteStream</a></code>
    427. 

  427. 		
    428. 

  428. 	</span>
    429. 

  429. 	
    430. 

  430. 	
    431. 

  431. </li><li>
    432. 

  432. 	<span class="tooltip">
    433. 

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

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

  435. When a connection comes in, the AsyncSocket instance will call the various <a href="#//api/name/delegate">delegate</a> methods (see above).<br/>
    436. 

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

  437. 	</span>
    438. 

  438. 	
    439. 

  439. 	
    440. 

  440. </li><li>
    441. 

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

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

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

  444. of specifying which interface to listen on. So, for example, if you were writing code for a server that<br/>
    445. 

  445. has multiple IP addresses, you could specify which address you wanted to listen on.  Or you could use it<br/>
    446. 

  446. to specify that the socket should only accept connections over ethernet, and not other interfaces such as wifi.<br/>
    447. 

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

  448. the socket only accept connections from the local machine.</p></span>
    449. 

  449. 	</span>
    450. 

  450. 	
    451. 

  451. 	
    452. 

  452. </li><li>
    453. 

  453. 	<span class="tooltip">
    454. 

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

  455. 		<span class="tooltip"><p>Connects to the given host and port.<br/>
    456. 

  456. 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;)</p></span>
    457. 

  457. 	</span>
    458. 

  458. 	
    459. 

  459. 	
    460. 

  460. </li><li>
    461. 

  461. 	<span class="tooltip">
    462. 

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

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

  464. To not time out use a negative time interval, or simply use the <a href="#//api/name/connectToHost:onPort:error:">connectToHost:onPort:error:</a> method.</p></span>
    465. 

  465. 	</span>
    466. 

  466. 	
    467. 

  467. 	
    468. 

  468. </li><li>
    469. 

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

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

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

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

  473. 	</span>
    474. 

  474. 	
    475. 

  475. 	
    476. 

  476. </li><li>
    477. 

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

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

  479. 		<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/>
    480. 

  480. 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>
    481. 

  481. 	</span>
    482. 

  482. 	
    483. 

  483. 	
    484. 

  484. </li><li>
    485. 

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

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

  487. 		
    488. 

  488. 	</span>
    489. 

  489. 	
    490. 

  490. 	
    491. 

  491. </li><li>
    492. 

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

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

  494. 		<span class="tooltip"><p>Disconnects immediately. Any pending reads or writes are dropped.<br/>
    495. 

  495. If the socket is not already disconnected, the onSocketDidDisconnect <a href="#//api/name/delegate">delegate</a> method<br/>
    496. 

  496. will be called immediately, before this method returns.</p></span>
    497. 

  497. 	</span>
    498. 

  498. 	
    499. 

  499. 	
    500. 

  500. </li><li>
    501. 

  501. 	<span class="tooltip">
    502. 

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

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

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

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

  506. 	</span>
    507. 

  507. 	
    508. 

  508. 	
    509. 

  509. </li><li>
    510. 

  510. 	<span class="tooltip">
    511. 

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

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

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

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

  515. 	</span>
    516. 

  516. 	
    517. 

  517. 	
    518. 

  518. </li><li>
    519. 

  519. 	<span class="tooltip">
    520. 

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

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

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

  523. 	</span>
    524. 

  524. 	
    525. 

  525. 	
    526. 

  526. </li><li>
    527. 

  527. 	<span class="tooltip">
    528. 

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

  529. 		
    530. 

  530. 	</span>
    531. 

  531. 	
    532. 

  532. 	
    533. 

  533. </li><li>
    534. 

  534. 	<span class="tooltip">
    535. 

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

  536. 		<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/>
    537. 

  537. The host will be an IP address.</p></span>
    538. 

  538. 	</span>
    539. 

  539. 	
    540. 

  540. 	
    541. 

  541. </li><li>
    542. 

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

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

  544. 		
    545. 

  545. 	</span>
    546. 

  546. 	
    547. 

  547. 	
    548. 

  548. </li><li>
    549. 

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

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

  551. 		
    552. 

  552. 	</span>
    553. 

  553. 	
    554. 

  554. 	
    555. 

  555. </li><li>
    556. 

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

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

  558. 		
    559. 

  559. 	</span>
    560. 

  560. 	
    561. 

  561. 	
    562. 

  562. </li><li>
    563. 

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

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

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

  566. specified as a sockaddr structure wrapped in a NSData object.</p></span>
    567. 

  567. 	</span>
    568. 

  568. 	
    569. 

  569. 	
    570. 

  570. </li><li>
    571. 

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

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

  573. 		
    574. 

  574. 	</span>
    575. 

  575. 	
    576. 

  576. 	
    577. 

  577. </li><li>
    578. 

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

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

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

  581. An accepting socket may be both.</p></span>
    582. 

  582. 	</span>
    583. 

  583. 	
    584. 

  584. 	
    585. 

  585. </li><li>
    586. 

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

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

  588. 		
    589. 

  589. 	</span>
    590. 

  590. 	
    591. 

  591. 	
    592. 

  592. </li><li>
    593. 

  593. 	<span class="tooltip">
    594. 

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

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

  596. 	</span>
    597. 

  597. 	
    598. 

  598. 	
    599. 

  599. </li><li>
    600. 

  600. 	<span class="tooltip">
    601. 

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

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

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

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

  605. 	</span>
    606. 

  606. 	
    607. 

  607. 	
    608. 

  608. </li><li>
    609. 

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

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

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

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

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

  614. A maximum of length bytes will be read.</p></span>
    615. 

  615. 	</span>
    616. 

  616. 	
    617. 

  617. 	
    618. 

  618. </li><li>
    619. 

  619. 	<span class="tooltip">
    620. 

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

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

  622. 	</span>
    623. 

  623. 	
    624. 

  624. 	
    625. 

  625. </li><li>
    626. 

  626. 	<span class="tooltip">
    627. 

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

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

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

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

  631. 	</span>
    632. 

  632. 	
    633. 

  633. 	
    634. 

  634. </li><li>
    635. 

  635. 	<span class="tooltip">
    636. 

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

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

  638. 	</span>
    639. 

  639. 	
    640. 

  640. 	
    641. 

  641. </li><li>
    642. 

  642. 	<span class="tooltip">
    643. 

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

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

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

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

  647. 	</span>
    648. 

  648. 	
    649. 

  649. 	
    650. 

  650. </li><li>
    651. 

  651. 	<span class="tooltip">
    652. 

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

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

  654. 	</span>
    655. 

  655. 	
    656. 

  656. 	
    657. 

  657. </li><li>
    658. 

  658. 	<span class="tooltip">
    659. 

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

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

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

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

  663. A maximum of length bytes will be read.</p></span>
    664. 

  664. 	</span>
    665. 

  665. 	
    666. 

  666. 	
    667. 

  667. </li><li>
    668. 

  668. 	<span class="tooltip">
    669. 

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

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

  671. 	</span>
    672. 

  672. 	
    673. 

  673. 	
    674. 

  674. </li><li>
    675. 

  675. 	<span class="tooltip">
    676. 

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

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

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

  679. 	</span>
    680. 

  680. 	
    681. 

  681. 	
    682. 

  682. </li><li>
    683. 

  683. 	<span class="tooltip">
    684. 

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

  685. 		
    686. 

  686. 	</span>
    687. 

  687. 	
    688. 

  688. 	
    689. 

  689. </li><li>
    690. 

  690. 	<span class="tooltip">
    691. 

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

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

  693. 	</span>
    694. 

  694. 	
    695. 

  695. 	
    696. 

  696. </li><li>
    697. 

  697. 	<span class="tooltip">
    698. 

  698. 		<code><a href="#//api/name/enablePreBuffering">&ndash;&nbsp;enablePreBuffering</a></code>
    699. 

  699. 		<span class="tooltip"><p>For handling readDataToData requests, data is necessarily read from the socket in small increments.<br/>
    700. 

  700. The performance can be much improved by allowing AsyncSocket to read larger chunks at a time and<br/>
    701. 

  701. store any overflow in a small internal buffer.<br/>
    702. 

  702. This is termed pre-buffering, as some data may be read for you before you ask for it.<br/>
    703. 

  703. If you use readDataToData a lot, enabling pre-buffering will result in better performance, especially on the iPhone.</p></span>
    704. 

  704. 	</span>
    705. 

  705. 	
    706. 

  706. 	
    707. 

  707. </li><li>
    708. 

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

  709. 		<code><a href="#//api/name/moveToRunLoop:">&ndash;&nbsp;moveToRunLoop:</a></code>
    710. 

  710. 		<span class="tooltip"><p>When you create an AsyncSocket, it is added to the runloop of the current thread.<br/>
    711. 

  711. So for manually created sockets, it is easiest to simply create the socket on the thread you intend to use it.</p></span>
    712. 

  712. 	</span>
    713. 

  713. 	
    714. 

  714. 	
    715. 

  715. </li><li>
    716. 

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

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

  718. 		<span class="tooltip"><p>Allows you to configure which run loop modes the socket uses.<br/>
    719. 

  719. The default set of run loop modes is NSDefaultRunLoopMode.</p></span>
    720. 

  720. 	</span>
    721. 

  721. 	
    722. 

  722. 	
    723. 

  723. </li><li>
    724. 

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

  725. 		<code><a href="#//api/name/addRunLoopMode:">&ndash;&nbsp;addRunLoopMode:</a></code>
    726. 

  726. 		
    727. 

  727. 	</span>
    728. 

  728. 	
    729. 

  729. 	
    730. 

  730. </li><li>
    731. 

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

  732. 		<code><a href="#//api/name/removeRunLoopMode:">&ndash;&nbsp;removeRunLoopMode:</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/runLoopModes">&ndash;&nbsp;runLoopModes</a></code>
    740. 

  740. 		<span class="tooltip"><p>Returns the current run loop modes the AsyncSocket instance is operating in.<br/>
    741. 

  741. The default set of run loop modes is NSDefaultRunLoopMode.</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/unreadData">&ndash;&nbsp;unreadData</a></code>
    748. 

  748. 		<span class="tooltip"><p>In the event of an error, this method may be called during onSocket:willDisconnectWithError: to read<br/>
    749. 

  749. any data that&rsquo;s left on the socket.</p></span>
    750. 

  750. 	</span>
    751. 

  751. 	
    752. 

  752. 	
    753. 

  753. </li><li>
    754. 

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

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

  756. 		
    757. 

  757. 	</span>
    758. 

  758. 	
    759. 

  759. 	
    760. 

  760. </li><li>
    761. 

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

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

  763. 		
    764. 

  764. 	</span>
    765. 

  765. 	
    766. 

  766. 	
    767. 

  767. </li><li>
    768. 

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

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

  770. 		
    771. 

  771. 	</span>
    772. 

  772. 	
    773. 

  773. 	
    774. 

  774. </li><li>
    775. 

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

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

  777. 		
    778. 

  778. 	</span>
    779. 

  779. 	
    780. 

  780. 	
    781. 

  781. </li>
    782. 

  782. 						</ul>
    783. 

  783. 						
    784. 

  784. 					</div>
    785. 

  785. 					
    786. 

  786. 					
    787. 

  787. 					
    788. 

  788. 					
    789. 

  789. 					
    790. 

  790. 					
    791. 

  791. 					
    792. 

  792. 					<div class="section section-methods">
    793. 

  793. 						<a title="Class Methods" name="class_methods"></a>
    794. 

  794. 						<h2 class="subtitle subtitle-methods">Class Methods</h2>
    795. 

  795. 						
    796. 

  796. 						<div class="section-method">
    797. 

  797. 	<a name="//api/name/CRData" title="CRData"></a>
    798. 

  798. 	<h3 class="subsubtitle method-title">CRData</h3>
    799. 

  799. 	
    800. 

  800. 	
    801. 

  801. 

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

  803. 

  804.     
    805. 

  805. </div>
    806. 

  806. 						
    807. 

  807. 						<div class="section-method">
    808. 

  808. 	<a name="//api/name/CRLFData" title="CRLFData"></a>
    809. 

  809. 	<h3 class="subsubtitle method-title">CRLFData</h3>
    810. 

  810. 	
    811. 

  811. 	
    812. 

  812. 

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

  814. 

  815.     
    816. 

  816. </div>
    817. 

  817. 						
    818. 

  818. 						<div class="section-method">
    819. 

  819. 	<a name="//api/name/LFData" title="LFData"></a>
    820. 

  820. 	<h3 class="subsubtitle method-title">LFData</h3>
    821. 

  821. 	
    822. 

  822. 	
    823. 

  823. 

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

  825. 

  826.     
    827. 

  827. </div>
    828. 

  828. 						
    829. 

  829. 						<div class="section-method">
    830. 

  830. 	<a name="//api/name/ZeroData" title="ZeroData"></a>
    831. 

  831. 	<h3 class="subsubtitle method-title">ZeroData</h3>
    832. 

  832. 	
    833. 

  833. 	
    834. 

  834. 

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

  836. 

  837.     
    838. 

  838. </div>
    839. 

  839. 						
    840. 

  840. 					</div>
    841. 

  841. 					
    842. 

  842. 					
    843. 

  843. 					
    844. 

  844. 					<div class="section section-methods">
    845. 

  845. 						<a title="Instance Methods" name="instance_methods"></a>
    846. 

  846. 						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
    847. 

  847. 						
    848. 

  848. 						<div class="section-method">
    849. 

  849. 	<a name="//api/name/acceptOnInterface:port:error:" title="acceptOnInterface:port:error:"></a>
    850. 

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

  851. 	
    852. 

  852. 	
    853. 

  853. 	
    854. 

  854. 	<div class="method-subsection brief-description">
    855. 

  855. 		<p>This method is the same as <a href="#//api/name/acceptOnPort:error:">acceptOnPort:error:</a> with the additional option<br/>
    856. 

  856. of specifying which interface to listen on. So, for example, if you were writing code for a server that<br/>
    857. 

  857. has multiple IP addresses, you could specify which address you wanted to listen on.  Or you could use it<br/>
    858. 

  858. to specify that the socket should only accept connections over ethernet, and not other interfaces such as wifi.<br/>
    859. 

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

  860. the socket only accept connections from the local machine.</p>
    861. 

  861. 	</div>		
    862. 

  862. 	
    863. 

  863.     
    864. 

  864. 

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

  866. 

  867.     
    868. 

  868. 	
    869. 

  869. 	
    870. 

  870. 	
    871. 

  871. 	
    872. 

  872. 	
    873. 

  873. 	
    874. 

  874. 	
    875. 

  875. 	<div class="method-subsection discussion-section">
    876. 

  876. 		<h4 class="method-subtitle">Discussion</h4>
    877. 

  877. 		<p>This method is the same as <a href="#//api/name/acceptOnPort:error:">acceptOnPort:error:</a> with the additional option<br/>
    878. 

  878. of specifying which interface to listen on. So, for example, if you were writing code for a server that<br/>
    879. 

  879. has multiple IP addresses, you could specify which address you wanted to listen on.  Or you could use it<br/>
    880. 

  880. to specify that the socket should only accept connections over ethernet, and not other interfaces such as wifi.<br/>
    881. 

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

  882. the socket only accept connections from the local machine.</p>
    883. 

  883. 

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

  885. 	</div>
    886. 

  886. 	
    887. 

  887. 	
    888. 

  888. 	
    889. 

  889. 	
    890. 

  890. 	
    891. 

  891. 	
    892. 

  892. 	
    893. 

  893. 	<div class="method-subsection declared-in-section">
    894. 

  894. 		<h4 class="method-subtitle">Declared In</h4>
    895. 

  895. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    896. 

  896. 	</div>				
    897. 

  897. 	
    898. 

  898. 	
    899. 

  899. </div>
    900. 

  900. 						
    901. 

  901. 						<div class="section-method">
    902. 

  902. 	<a name="//api/name/acceptOnPort:error:" title="acceptOnPort:error:"></a>
    903. 

  903. 	<h3 class="subsubtitle method-title">acceptOnPort:error:</h3>
    904. 

  904. 	
    905. 

  905. 	
    906. 

  906. 	
    907. 

  907. 	<div class="method-subsection brief-description">
    908. 

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

  909. When a connection comes in, the AsyncSocket instance will call the various <a href="#//api/name/delegate">delegate</a> methods (see above).<br/>
    910. 

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

  911. 	</div>		
    912. 

  912. 	
    913. 

  913.     
    914. 

  914. 

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

  916. 

  917.     
    918. 

  918. 	
    919. 

  919. 	
    920. 

  920. 	
    921. 

  921. 	
    922. 

  922. 	
    923. 

  923. 	
    924. 

  924. 	
    925. 

  925. 	<div class="method-subsection discussion-section">
    926. 

  926. 		<h4 class="method-subtitle">Discussion</h4>
    927. 

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

  928. When a connection comes in, the AsyncSocket instance will call the various <a href="#//api/name/delegate">delegate</a> methods (see above).<br/>
    929. 

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

  930. 	</div>
    931. 

  931. 	
    932. 

  932. 	
    933. 

  933. 	
    934. 

  934. 	
    935. 

  935. 	
    936. 

  936. 	
    937. 

  937. 	
    938. 

  938. 	<div class="method-subsection declared-in-section">
    939. 

  939. 		<h4 class="method-subtitle">Declared In</h4>
    940. 

  940. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    941. 

  941. 	</div>				
    942. 

  942. 	
    943. 

  943. 	
    944. 

  944. </div>
    945. 

  945. 						
    946. 

  946. 						<div class="section-method">
    947. 

  947. 	<a name="//api/name/addRunLoopMode:" title="addRunLoopMode:"></a>
    948. 

  948. 	<h3 class="subsubtitle method-title">addRunLoopMode:</h3>
    949. 

  949. 	
    950. 

  950. 	
    951. 

  951. 

  952. 	<div class="method-subsection method-declaration"><code>- (BOOL)addRunLoopMode:(NSString *)<em>runLoopMode</em></code></div>
    953. 

  953. 

  954.     
    955. 

  955. </div>
    956. 

  956. 						
    957. 

  957. 						<div class="section-method">
    958. 

  958. 	<a name="//api/name/canSafelySetDelegate" title="canSafelySetDelegate"></a>
    959. 

  959. 	<h3 class="subsubtitle method-title">canSafelySetDelegate</h3>
    960. 

  960. 	
    961. 

  961. 	
    962. 

  962. 

  963. 	<div class="method-subsection method-declaration"><code>- (BOOL)canSafelySetDelegate</code></div>
    964. 

  964. 

  965.     
    966. 

  966. </div>
    967. 

  967. 						
    968. 

  968. 						<div class="section-method">
    969. 

  969. 	<a name="//api/name/connectToAddress:error:" title="connectToAddress:error:"></a>
    970. 

  970. 	<h3 class="subsubtitle method-title">connectToAddress:error:</h3>
    971. 

  971. 	
    972. 

  972. 	
    973. 

  973. 	
    974. 

  974. 	<div class="method-subsection brief-description">
    975. 

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

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

  977. 	</div>		
    978. 

  978. 	
    979. 

  979.     
    980. 

  980. 

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

  982. 

  983.     
    984. 

  984. 	
    985. 

  985. 	
    986. 

  986. 	
    987. 

  987. 	
    988. 

  988. 	
    989. 

  989. 	
    990. 

  990. 	
    991. 

  991. 	<div class="method-subsection discussion-section">
    992. 

  992. 		<h4 class="method-subtitle">Discussion</h4>
    993. 

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

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

  995. 

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

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

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

  999. 	</div>
    1000. 

  1000. 	
    1001. 

  1001. 	
    1002. 

  1002. 	
    1003. 

  1003. 	
    1004. 

  1004. 	
    1005. 

  1005. 	
    1006. 

  1006. 	
    1007. 

  1007. 	<div class="method-subsection declared-in-section">
    1008. 

  1008. 		<h4 class="method-subtitle">Declared In</h4>
    1009. 

  1009. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1010. 

  1010. 	</div>				
    1011. 

  1011. 	
    1012. 

  1012. 	
    1013. 

  1013. </div>
    1014. 

  1014. 						
    1015. 

  1015. 						<div class="section-method">
    1016. 

  1016. 	<a name="//api/name/connectToAddress:viaInterfaceAddress:withTimeout:error:" title="connectToAddress:viaInterfaceAddress:withTimeout:error:"></a>
    1017. 

  1017. 	<h3 class="subsubtitle method-title">connectToAddress:viaInterfaceAddress:withTimeout:error:</h3>
    1018. 

  1018. 	
    1019. 

  1019. 	
    1020. 

  1020. 

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

  1022. 

  1023.     
    1024. 

  1024. </div>
    1025. 

  1025. 						
    1026. 

  1026. 						<div class="section-method">
    1027. 

  1027. 	<a name="//api/name/connectToAddress:withTimeout:error:" title="connectToAddress:withTimeout:error:"></a>
    1028. 

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

  1029. 	
    1030. 

  1030. 	
    1031. 

  1031. 	
    1032. 

  1032. 	<div class="method-subsection brief-description">
    1033. 

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

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

  1035. 	</div>		
    1036. 

  1036. 	
    1037. 

  1037.     
    1038. 

  1038. 

  1039. 	<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>
    1040. 

  1040. 

  1041.     
    1042. 

  1042. 	
    1043. 

  1043. 	
    1044. 

  1044. 	
    1045. 

  1045. 	
    1046. 

  1046. 	
    1047. 

  1047. 	
    1048. 

  1048. 	
    1049. 

  1049. 	<div class="method-subsection discussion-section">
    1050. 

  1050. 		<h4 class="method-subtitle">Discussion</h4>
    1051. 

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

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

  1053. 	</div>
    1054. 

  1054. 	
    1055. 

  1055. 	
    1056. 

  1056. 	
    1057. 

  1057. 	
    1058. 

  1058. 	
    1059. 

  1059. 	
    1060. 

  1060. 	
    1061. 

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

  1062. 		<h4 class="method-subtitle">Declared In</h4>
    1063. 

  1063. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1064. 

  1064. 	</div>				
    1065. 

  1065. 	
    1066. 

  1066. 	
    1067. 

  1067. </div>
    1068. 

  1068. 						
    1069. 

  1069. 						<div class="section-method">
    1070. 

  1070. 	<a name="//api/name/connectToHost:onPort:error:" title="connectToHost:onPort:error:"></a>
    1071. 

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

  1072. 	
    1073. 

  1073. 	
    1074. 

  1074. 	
    1075. 

  1075. 	<div class="method-subsection brief-description">
    1076. 

  1076. 		<p>Connects to the given host and port.<br/>
    1077. 

  1077. 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;)</p>
    1078. 

  1078. 	</div>		
    1079. 

  1079. 	
    1080. 

  1080.     
    1081. 

  1081. 

  1082. 	<div class="method-subsection method-declaration"><code>- (BOOL)connectToHost:(NSString *)<em>hostname</em> onPort:(UInt16)<em>port</em> error:(NSError **)<em>errPtr</em></code></div>
    1083. 

  1083. 

  1084.     
    1085. 

  1085. 	
    1086. 

  1086. 	
    1087. 

  1087. 	
    1088. 

  1088. 	
    1089. 

  1089. 	
    1090. 

  1090. 	
    1091. 

  1091. 	
    1092. 

  1092. 	<div class="method-subsection discussion-section">
    1093. 

  1093. 		<h4 class="method-subtitle">Discussion</h4>
    1094. 

  1094. 		<p>Connects to the given host and port.<br/>
    1095. 

  1095. 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;)</p>
    1096. 

  1096. 	</div>
    1097. 

  1097. 	
    1098. 

  1098. 	
    1099. 

  1099. 	
    1100. 

  1100. 	
    1101. 

  1101. 	
    1102. 

  1102. 	
    1103. 

  1103. 	
    1104. 

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

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

  1106. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1107. 

  1107. 	</div>				
    1108. 

  1108. 	
    1109. 

  1109. 	
    1110. 

  1110. </div>
    1111. 

  1111. 						
    1112. 

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

  1113. 	<a name="//api/name/connectToHost:onPort:withTimeout:error:" title="connectToHost:onPort:withTimeout:error:"></a>
    1114. 

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

  1115. 	
    1116. 

  1116. 	
    1117. 

  1117. 	
    1118. 

  1118. 	<div class="method-subsection brief-description">
    1119. 

  1119. 		<p>This method is the same as <a href="#//api/name/connectToHost:onPort:error:">connectToHost:onPort:error:</a> with an additional timeout option.<br/>
    1120. 

  1120. To not time out use a negative time interval, or simply use the <a href="#//api/name/connectToHost:onPort:error:">connectToHost:onPort:error:</a> method.</p>
    1121. 

  1121. 	</div>		
    1122. 

  1122. 	
    1123. 

  1123.     
    1124. 

  1124. 

  1125. 	<div class="method-subsection method-declaration"><code>- (BOOL)connectToHost:(NSString *)<em>hostname</em> onPort:(UInt16)<em>port</em> withTimeout:(NSTimeInterval)<em>timeout</em> error:(NSError **)<em>errPtr</em></code></div>
    1126. 

  1126. 

  1127.     
    1128. 

  1128. 	
    1129. 

  1129. 	
    1130. 

  1130. 	
    1131. 

  1131. 	
    1132. 

  1132. 	
    1133. 

  1133. 	
    1134. 

  1134. 	
    1135. 

  1135. 	<div class="method-subsection discussion-section">
    1136. 

  1136. 		<h4 class="method-subtitle">Discussion</h4>
    1137. 

  1137. 		<p>This method is the same as <a href="#//api/name/connectToHost:onPort:error:">connectToHost:onPort:error:</a> with an additional timeout option.<br/>
    1138. 

  1138. To not time out use a negative time interval, or simply use the <a href="#//api/name/connectToHost:onPort:error:">connectToHost:onPort:error:</a> method.</p>
    1139. 

  1139. 	</div>
    1140. 

  1140. 	
    1141. 

  1141. 	
    1142. 

  1142. 	
    1143. 

  1143. 	
    1144. 

  1144. 	
    1145. 

  1145. 	
    1146. 

  1146. 	
    1147. 

  1147. 	<div class="method-subsection declared-in-section">
    1148. 

  1148. 		<h4 class="method-subtitle">Declared In</h4>
    1149. 

  1149. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1150. 

  1150. 	</div>				
    1151. 

  1151. 	
    1152. 

  1152. 	
    1153. 

  1153. </div>
    1154. 

  1154. 						
    1155. 

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

  1156. 	<a name="//api/name/connectedAddress" title="connectedAddress"></a>
    1157. 

  1157. 	<h3 class="subsubtitle method-title">connectedAddress</h3>
    1158. 

  1158. 	
    1159. 

  1159. 	
    1160. 

  1160. 	
    1161. 

  1161. 	<div class="method-subsection brief-description">
    1162. 

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

  1163. specified as a sockaddr structure wrapped in a NSData object.</p>
    1164. 

  1164. 	</div>		
    1165. 

  1165. 	
    1166. 

  1166.     
    1167. 

  1167. 

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

  1169. 

  1170.     
    1171. 

  1171. 	
    1172. 

  1172. 	
    1173. 

  1173. 	
    1174. 

  1174. 	
    1175. 

  1175. 	
    1176. 

  1176. 	
    1177. 

  1177. 	
    1178. 

  1178. 	<div class="method-subsection discussion-section">
    1179. 

  1179. 		<h4 class="method-subtitle">Discussion</h4>
    1180. 

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

  1181. specified as a sockaddr structure wrapped in a NSData object.</p>
    1182. 

  1182. 

  1183. <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>
    1184. 

  1184. 	</div>
    1185. 

  1185. 	
    1186. 

  1186. 	
    1187. 

  1187. 	
    1188. 

  1188. 	
    1189. 

  1189. 	
    1190. 

  1190. 	
    1191. 

  1191. 	
    1192. 

  1192. 	<div class="method-subsection declared-in-section">
    1193. 

  1193. 		<h4 class="method-subtitle">Declared In</h4>
    1194. 

  1194. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1195. 

  1195. 	</div>				
    1196. 

  1196. 	
    1197. 

  1197. 	
    1198. 

  1198. </div>
    1199. 

  1199. 						
    1200. 

  1200. 						<div class="section-method">
    1201. 

  1201. 	<a name="//api/name/connectedHost" title="connectedHost"></a>
    1202. 

  1202. 	<h3 class="subsubtitle method-title">connectedHost</h3>
    1203. 

  1203. 	
    1204. 

  1204. 	
    1205. 

  1205. 	
    1206. 

  1206. 	<div class="method-subsection brief-description">
    1207. 

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

  1208. The host will be an IP address.</p>
    1209. 

  1209. 	</div>		
    1210. 

  1210. 	
    1211. 

  1211.     
    1212. 

  1212. 

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

  1214. 

  1215.     
    1216. 

  1216. 	
    1217. 

  1217. 	
    1218. 

  1218. 	
    1219. 

  1219. 	
    1220. 

  1220. 	
    1221. 

  1221. 	
    1222. 

  1222. 	
    1223. 

  1223. 	<div class="method-subsection discussion-section">
    1224. 

  1224. 		<h4 class="method-subtitle">Discussion</h4>
    1225. 

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

  1226. The host will be an IP address.</p>
    1227. 

  1227. 	</div>
    1228. 

  1228. 	
    1229. 

  1229. 	
    1230. 

  1230. 	
    1231. 

  1231. 	
    1232. 

  1232. 	
    1233. 

  1233. 	
    1234. 

  1234. 	
    1235. 

  1235. 	<div class="method-subsection declared-in-section">
    1236. 

  1236. 		<h4 class="method-subtitle">Declared In</h4>
    1237. 

  1237. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1238. 

  1238. 	</div>				
    1239. 

  1239. 	
    1240. 

  1240. 	
    1241. 

  1241. </div>
    1242. 

  1242. 						
    1243. 

  1243. 						<div class="section-method">
    1244. 

  1244. 	<a name="//api/name/connectedPort" title="connectedPort"></a>
    1245. 

  1245. 	<h3 class="subsubtitle method-title">connectedPort</h3>
    1246. 

  1246. 	
    1247. 

  1247. 	
    1248. 

  1248. 

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

  1250. 

  1251.     
    1252. 

  1252. </div>
    1253. 

  1253. 						
    1254. 

  1254. 						<div class="section-method">
    1255. 

  1255. 	<a name="//api/name/delegate" title="delegate"></a>
    1256. 

  1256. 	<h3 class="subsubtitle method-title">delegate</h3>
    1257. 

  1257. 	
    1258. 

  1258. 	
    1259. 

  1259. 	
    1260. 

  1260. 	<div class="method-subsection brief-description">
    1261. 

  1261. 		<p>Use &ldquo;canSafelySetDelegate&rdquo; to see if there is any pending business (reads and writes) with the current delegate<br/>
    1262. 

  1262. before changing it.  It is, of course, safe to change the delegate before connecting or accepting connections.</p>
    1263. 

  1263. 	</div>		
    1264. 

  1264. 	
    1265. 

  1265.     
    1266. 

  1266. 

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

  1268. 

  1269.     
    1270. 

  1270. 	
    1271. 

  1271. 	
    1272. 

  1272. 	
    1273. 

  1273. 	
    1274. 

  1274. 	
    1275. 

  1275. 	
    1276. 

  1276. 	
    1277. 

  1277. 	<div class="method-subsection discussion-section">
    1278. 

  1278. 		<h4 class="method-subtitle">Discussion</h4>
    1279. 

  1279. 		<p>Use &ldquo;canSafelySetDelegate&rdquo; to see if there is any pending business (reads and writes) with the current delegate<br/>
    1280. 

  1280. before changing it.  It is, of course, safe to change the delegate before connecting or accepting connections.</p>
    1281. 

  1281. 	</div>
    1282. 

  1282. 	
    1283. 

  1283. 	
    1284. 

  1284. 	
    1285. 

  1285. 	
    1286. 

  1286. 	
    1287. 

  1287. 	
    1288. 

  1288. 	
    1289. 

  1289. 	<div class="method-subsection declared-in-section">
    1290. 

  1290. 		<h4 class="method-subtitle">Declared In</h4>
    1291. 

  1291. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1292. 

  1292. 	</div>				
    1293. 

  1293. 	
    1294. 

  1294. 	
    1295. 

  1295. </div>
    1296. 

  1296. 						
    1297. 

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

  1298. 	<a name="//api/name/description" title="description"></a>
    1299. 

  1299. 	<h3 class="subsubtitle method-title">description</h3>
    1300. 

  1300. 	
    1301. 

  1301. 	
    1302. 

  1302. 

  1303. 	<div class="method-subsection method-declaration"><code>- (NSString *)description</code></div>
    1304. 

  1304. 

  1305.     
    1306. 

  1306. </div>
    1307. 

  1307. 						
    1308. 

  1308. 						<div class="section-method">
    1309. 

  1309. 	<a name="//api/name/disconnect" title="disconnect"></a>
    1310. 

  1310. 	<h3 class="subsubtitle method-title">disconnect</h3>
    1311. 

  1311. 	
    1312. 

  1312. 	
    1313. 

  1313. 	
    1314. 

  1314. 	<div class="method-subsection brief-description">
    1315. 

  1315. 		<p>Disconnects immediately. Any pending reads or writes are dropped.<br/>
    1316. 

  1316. If the socket is not already disconnected, the onSocketDidDisconnect <a href="#//api/name/delegate">delegate</a> method<br/>
    1317. 

  1317. will be called immediately, before this method returns.</p>
    1318. 

  1318. 	</div>		
    1319. 

  1319. 	
    1320. 

  1320.     
    1321. 

  1321. 

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

  1323. 

  1324.     
    1325. 

  1325. 	
    1326. 

  1326. 	
    1327. 

  1327. 	
    1328. 

  1328. 	
    1329. 

  1329. 	
    1330. 

  1330. 	
    1331. 

  1331. 	
    1332. 

  1332. 	<div class="method-subsection discussion-section">
    1333. 

  1333. 		<h4 class="method-subtitle">Discussion</h4>
    1334. 

  1334. 		<p>Disconnects immediately. Any pending reads or writes are dropped.<br/>
    1335. 

  1335. If the socket is not already disconnected, the onSocketDidDisconnect delegate method<br/>
    1336. 

  1336. will be called immediately, before this method returns.</p>
    1337. 

  1337. 

  1338. <p>Please note the recommended way of releasing an AsyncSocket instance (e.g. in a dealloc method)<br/>
    1339. 

  1339. [asyncSocket setDelegate:nil];<br/>
    1340. 

  1340. [asyncSocket disconnect];<br/>
    1341. 

  1341. [asyncSocket release];</p>
    1342. 

  1342. 	</div>
    1343. 

  1343. 	
    1344. 

  1344. 	
    1345. 

  1345. 	
    1346. 

  1346. 	
    1347. 

  1347. 	
    1348. 

  1348. 	
    1349. 

  1349. 	
    1350. 

  1350. 	<div class="method-subsection declared-in-section">
    1351. 

  1351. 		<h4 class="method-subtitle">Declared In</h4>
    1352. 

  1352. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1353. 

  1353. 	</div>				
    1354. 

  1354. 	
    1355. 

  1355. 	
    1356. 

  1356. </div>
    1357. 

  1357. 						
    1358. 

  1358. 						<div class="section-method">
    1359. 

  1359. 	<a name="//api/name/disconnectAfterReading" title="disconnectAfterReading"></a>
    1360. 

  1360. 	<h3 class="subsubtitle method-title">disconnectAfterReading</h3>
    1361. 

  1361. 	
    1362. 

  1362. 	
    1363. 

  1363. 	
    1364. 

  1364. 	<div class="method-subsection brief-description">
    1365. 

  1365. 		<p>Disconnects after all pending reads have completed.<br/>
    1366. 

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

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

  1368. 	</div>		
    1369. 

  1369. 	
    1370. 

  1370.     
    1371. 

  1371. 

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

  1373. 

  1374.     
    1375. 

  1375. 	
    1376. 

  1376. 	
    1377. 

  1377. 	
    1378. 

  1378. 	
    1379. 

  1379. 	
    1380. 

  1380. 	
    1381. 

  1381. 	
    1382. 

  1382. 	<div class="method-subsection discussion-section">
    1383. 

  1383. 		<h4 class="method-subtitle">Discussion</h4>
    1384. 

  1384. 		<p>Disconnects after all pending reads have completed.<br/>
    1385. 

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

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

  1387. 	</div>
    1388. 

  1388. 	
    1389. 

  1389. 	
    1390. 

  1390. 	
    1391. 

  1391. 	
    1392. 

  1392. 	
    1393. 

  1393. 	
    1394. 

  1394. 	
    1395. 

  1395. 	<div class="method-subsection declared-in-section">
    1396. 

  1396. 		<h4 class="method-subtitle">Declared In</h4>
    1397. 

  1397. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1398. 

  1398. 	</div>				
    1399. 

  1399. 	
    1400. 

  1400. 	
    1401. 

  1401. </div>
    1402. 

  1402. 						
    1403. 

  1403. 						<div class="section-method">
    1404. 

  1404. 	<a name="//api/name/disconnectAfterReadingAndWriting" title="disconnectAfterReadingAndWriting"></a>
    1405. 

  1405. 	<h3 class="subsubtitle method-title">disconnectAfterReadingAndWriting</h3>
    1406. 

  1406. 	
    1407. 

  1407. 	
    1408. 

  1408. 	
    1409. 

  1409. 	<div class="method-subsection brief-description">
    1410. 

  1410. 		<p>Disconnects after all pending reads and writes have completed.<br/>
    1411. 

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

  1412. 	</div>		
    1413. 

  1413. 	
    1414. 

  1414.     
    1415. 

  1415. 

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

  1417. 

  1418.     
    1419. 

  1419. 	
    1420. 

  1420. 	
    1421. 

  1421. 	
    1422. 

  1422. 	
    1423. 

  1423. 	
    1424. 

  1424. 	
    1425. 

  1425. 	
    1426. 

  1426. 	<div class="method-subsection discussion-section">
    1427. 

  1427. 		<h4 class="method-subtitle">Discussion</h4>
    1428. 

  1428. 		<p>Disconnects after all pending reads and writes have completed.<br/>
    1429. 

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

  1430. 	</div>
    1431. 

  1431. 	
    1432. 

  1432. 	
    1433. 

  1433. 	
    1434. 

  1434. 	
    1435. 

  1435. 	
    1436. 

  1436. 	
    1437. 

  1437. 	
    1438. 

  1438. 	<div class="method-subsection declared-in-section">
    1439. 

  1439. 		<h4 class="method-subtitle">Declared In</h4>
    1440. 

  1440. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1441. 

  1441. 	</div>				
    1442. 

  1442. 	
    1443. 

  1443. 	
    1444. 

  1444. </div>
    1445. 

  1445. 						
    1446. 

  1446. 						<div class="section-method">
    1447. 

  1447. 	<a name="//api/name/disconnectAfterWriting" title="disconnectAfterWriting"></a>
    1448. 

  1448. 	<h3 class="subsubtitle method-title">disconnectAfterWriting</h3>
    1449. 

  1449. 	
    1450. 

  1450. 	
    1451. 

  1451. 	
    1452. 

  1452. 	<div class="method-subsection brief-description">
    1453. 

  1453. 		<p>Disconnects after all pending writes have completed.<br/>
    1454. 

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

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

  1456. 	</div>		
    1457. 

  1457. 	
    1458. 

  1458.     
    1459. 

  1459. 

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

  1461. 

  1462.     
    1463. 

  1463. 	
    1464. 

  1464. 	
    1465. 

  1465. 	
    1466. 

  1466. 	
    1467. 

  1467. 	
    1468. 

  1468. 	
    1469. 

  1469. 	
    1470. 

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

  1471. 		<h4 class="method-subtitle">Discussion</h4>
    1472. 

  1472. 		<p>Disconnects after all pending writes have completed.<br/>
    1473. 

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

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

  1475. 	</div>
    1476. 

  1476. 	
    1477. 

  1477. 	
    1478. 

  1478. 	
    1479. 

  1479. 	
    1480. 

  1480. 	
    1481. 

  1481. 	
    1482. 

  1482. 	
    1483. 

  1483. 	<div class="method-subsection declared-in-section">
    1484. 

  1484. 		<h4 class="method-subtitle">Declared In</h4>
    1485. 

  1485. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1486. 

  1486. 	</div>				
    1487. 

  1487. 	
    1488. 

  1488. 	
    1489. 

  1489. </div>
    1490. 

  1490. 						
    1491. 

  1491. 						<div class="section-method">
    1492. 

  1492. 	<a name="//api/name/enablePreBuffering" title="enablePreBuffering"></a>
    1493. 

  1493. 	<h3 class="subsubtitle method-title">enablePreBuffering</h3>
    1494. 

  1494. 	
    1495. 

  1495. 	
    1496. 

  1496. 	
    1497. 

  1497. 	<div class="method-subsection brief-description">
    1498. 

  1498. 		<p>For handling readDataToData requests, data is necessarily read from the socket in small increments.<br/>
    1499. 

  1499. The performance can be much improved by allowing AsyncSocket to read larger chunks at a time and<br/>
    1500. 

  1500. store any overflow in a small internal buffer.<br/>
    1501. 

  1501. This is termed pre-buffering, as some data may be read for you before you ask for it.<br/>
    1502. 

  1502. If you use readDataToData a lot, enabling pre-buffering will result in better performance, especially on the iPhone.</p>
    1503. 

  1503. 	</div>		
    1504. 

  1504. 	
    1505. 

  1505.     
    1506. 

  1506. 

  1507. 	<div class="method-subsection method-declaration"><code>- (void)enablePreBuffering</code></div>
    1508. 

  1508. 

  1509.     
    1510. 

  1510. 	
    1511. 

  1511. 	
    1512. 

  1512. 	
    1513. 

  1513. 	
    1514. 

  1514. 	
    1515. 

  1515. 	
    1516. 

  1516. 	
    1517. 

  1517. 	<div class="method-subsection discussion-section">
    1518. 

  1518. 		<h4 class="method-subtitle">Discussion</h4>
    1519. 

  1519. 		<p>For handling readDataToData requests, data is necessarily read from the socket in small increments.<br/>
    1520. 

  1520. The performance can be much improved by allowing AsyncSocket to read larger chunks at a time and<br/>
    1521. 

  1521. store any overflow in a small internal buffer.<br/>
    1522. 

  1522. This is termed pre-buffering, as some data may be read for you before you ask for it.<br/>
    1523. 

  1523. If you use readDataToData a lot, enabling pre-buffering will result in better performance, especially on the iPhone.</p>
    1524. 

  1524. 

  1525. <p>The default pre-buffering state is controlled by the DEFAULT_PREBUFFERING definition.<br/>
    1526. 

  1526. It is highly recommended one leave this set to YES.</p>
    1527. 

  1527. 

  1528. <p>This method exists in case pre-buffering needs to be disabled by default for some unforeseen reason.<br/>
    1529. 

  1529. In that case, this method exists to allow one to easily enable pre-buffering when ready.</p>
    1530. 

  1530. 	</div>
    1531. 

  1531. 	
    1532. 

  1532. 	
    1533. 

  1533. 	
    1534. 

  1534. 	
    1535. 

  1535. 	
    1536. 

  1536. 	
    1537. 

  1537. 	
    1538. 

  1538. 	<div class="method-subsection declared-in-section">
    1539. 

  1539. 		<h4 class="method-subtitle">Declared In</h4>
    1540. 

  1540. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1541. 

  1541. 	</div>				
    1542. 

  1542. 	
    1543. 

  1543. 	
    1544. 

  1544. </div>
    1545. 

  1545. 						
    1546. 

  1546. 						<div class="section-method">
    1547. 

  1547. 	<a name="//api/name/getCFReadStream" title="getCFReadStream"></a>
    1548. 

  1548. 	<h3 class="subsubtitle method-title">getCFReadStream</h3>
    1549. 

  1549. 	
    1550. 

  1550. 	
    1551. 

  1551. 

  1552. 	<div class="method-subsection method-declaration"><code>- (CFReadStreamRef)getCFReadStream</code></div>
    1553. 

  1553. 

  1554.     
    1555. 

  1555. </div>
    1556. 

  1556. 						
    1557. 

  1557. 						<div class="section-method">
    1558. 

  1558. 	<a name="//api/name/getCFSocket" title="getCFSocket"></a>
    1559. 

  1559. 	<h3 class="subsubtitle method-title">getCFSocket</h3>
    1560. 

  1560. 	
    1561. 

  1561. 	
    1562. 

  1562. 

  1563. 	<div class="method-subsection method-declaration"><code>- (CFSocketRef)getCFSocket</code></div>
    1564. 

  1564. 

  1565.     
    1566. 

  1566. </div>
    1567. 

  1567. 						
    1568. 

  1568. 						<div class="section-method">
    1569. 

  1569. 	<a name="//api/name/getCFWriteStream" title="getCFWriteStream"></a>
    1570. 

  1570. 	<h3 class="subsubtitle method-title">getCFWriteStream</h3>
    1571. 

  1571. 	
    1572. 

  1572. 	
    1573. 

  1573. 

  1574. 	<div class="method-subsection method-declaration"><code>- (CFWriteStreamRef)getCFWriteStream</code></div>
    1575. 

  1575. 

  1576.     
    1577. 

  1577. </div>
    1578. 

  1578. 						
    1579. 

  1579. 						<div class="section-method">
    1580. 

  1580. 	<a name="//api/name/init" title="init"></a>
    1581. 

  1581. 	<h3 class="subsubtitle method-title">init</h3>
    1582. 

  1582. 	
    1583. 

  1583. 	
    1584. 

  1584. 

  1585. 	<div class="method-subsection method-declaration"><code>- (id)init</code></div>
    1586. 

  1586. 

  1587.     
    1588. 

  1588. </div>
    1589. 

  1589. 						
    1590. 

  1590. 						<div class="section-method">
    1591. 

  1591. 	<a name="//api/name/initWithDelegate:" title="initWithDelegate:"></a>
    1592. 

  1592. 	<h3 class="subsubtitle method-title">initWithDelegate:</h3>
    1593. 

  1593. 	
    1594. 

  1594. 	
    1595. 

  1595. 

  1596. 	<div class="method-subsection method-declaration"><code>- (id)initWithDelegate:(id)<em>delegate</em></code></div>
    1597. 

  1597. 

  1598.     
    1599. 

  1599. </div>
    1600. 

  1600. 						
    1601. 

  1601. 						<div class="section-method">
    1602. 

  1602. 	<a name="//api/name/initWithDelegate:userData:" title="initWithDelegate:userData:"></a>
    1603. 

  1603. 	<h3 class="subsubtitle method-title">initWithDelegate:userData:</h3>
    1604. 

  1604. 	
    1605. 

  1605. 	
    1606. 

  1606. 

  1607. 	<div class="method-subsection method-declaration"><code>- (id)initWithDelegate:(id)<em>delegate</em> userData:(long)<em>userData</em></code></div>
    1608. 

  1608. 

  1609.     
    1610. 

  1610. </div>
    1611. 

  1611. 						
    1612. 

  1612. 						<div class="section-method">
    1613. 

  1613. 	<a name="//api/name/isConnected" title="isConnected"></a>
    1614. 

  1614. 	<h3 class="subsubtitle method-title">isConnected</h3>
    1615. 

  1615. 	
    1616. 

  1616. 	
    1617. 

  1617. 

  1618. 	<div class="method-subsection method-declaration"><code>- (BOOL)isConnected</code></div>
    1619. 

  1619. 

  1620.     
    1621. 

  1621. </div>
    1622. 

  1622. 						
    1623. 

  1623. 						<div class="section-method">
    1624. 

  1624. 	<a name="//api/name/isIPv4" title="isIPv4"></a>
    1625. 

  1625. 	<h3 class="subsubtitle method-title">isIPv4</h3>
    1626. 

  1626. 	
    1627. 

  1627. 	
    1628. 

  1628. 	
    1629. 

  1629. 	<div class="method-subsection brief-description">
    1630. 

  1630. 		<p>Returns whether the socket is IPv4 or IPv6.<br/>
    1631. 

  1631. An accepting socket may be both.</p>
    1632. 

  1632. 	</div>		
    1633. 

  1633. 	
    1634. 

  1634.     
    1635. 

  1635. 

  1636. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv4</code></div>
    1637. 

  1637. 

  1638.     
    1639. 

  1639. 	
    1640. 

  1640. 	
    1641. 

  1641. 	
    1642. 

  1642. 	
    1643. 

  1643. 	
    1644. 

  1644. 	
    1645. 

  1645. 	
    1646. 

  1646. 	<div class="method-subsection discussion-section">
    1647. 

  1647. 		<h4 class="method-subtitle">Discussion</h4>
    1648. 

  1648. 		<p>Returns whether the socket is IPv4 or IPv6.<br/>
    1649. 

  1649. An accepting socket may be both.</p>
    1650. 

  1650. 	</div>
    1651. 

  1651. 	
    1652. 

  1652. 	
    1653. 

  1653. 	
    1654. 

  1654. 	
    1655. 

  1655. 	
    1656. 

  1656. 	
    1657. 

  1657. 	
    1658. 

  1658. 	<div class="method-subsection declared-in-section">
    1659. 

  1659. 		<h4 class="method-subtitle">Declared In</h4>
    1660. 

  1660. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1661. 

  1661. 	</div>				
    1662. 

  1662. 	
    1663. 

  1663. 	
    1664. 

  1664. </div>
    1665. 

  1665. 						
    1666. 

  1666. 						<div class="section-method">
    1667. 

  1667. 	<a name="//api/name/isIPv6" title="isIPv6"></a>
    1668. 

  1668. 	<h3 class="subsubtitle method-title">isIPv6</h3>
    1669. 

  1669. 	
    1670. 

  1670. 	
    1671. 

  1671. 

  1672. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv6</code></div>
    1673. 

  1673. 

  1674.     
    1675. 

  1675. </div>
    1676. 

  1676. 						
    1677. 

  1677. 						<div class="section-method">
    1678. 

  1678. 	<a name="//api/name/localAddress" title="localAddress"></a>
    1679. 

  1679. 	<h3 class="subsubtitle method-title">localAddress</h3>
    1680. 

  1680. 	
    1681. 

  1681. 	
    1682. 

  1682. 

  1683. 	<div class="method-subsection method-declaration"><code>- (NSData *)localAddress</code></div>
    1684. 

  1684. 

  1685.     
    1686. 

  1686. </div>
    1687. 

  1687. 						
    1688. 

  1688. 						<div class="section-method">
    1689. 

  1689. 	<a name="//api/name/localHost" title="localHost"></a>
    1690. 

  1690. 	<h3 class="subsubtitle method-title">localHost</h3>
    1691. 

  1691. 	
    1692. 

  1692. 	
    1693. 

  1693. 

  1694. 	<div class="method-subsection method-declaration"><code>- (NSString *)localHost</code></div>
    1695. 

  1695. 

  1696.     
    1697. 

  1697. </div>
    1698. 

  1698. 						
    1699. 

  1699. 						<div class="section-method">
    1700. 

  1700. 	<a name="//api/name/localPort" title="localPort"></a>
    1701. 

  1701. 	<h3 class="subsubtitle method-title">localPort</h3>
    1702. 

  1702. 	
    1703. 

  1703. 	
    1704. 

  1704. 

  1705. 	<div class="method-subsection method-declaration"><code>- (UInt16)localPort</code></div>
    1706. 

  1706. 

  1707.     
    1708. 

  1708. </div>
    1709. 

  1709. 						
    1710. 

  1710. 						<div class="section-method">
    1711. 

  1711. 	<a name="//api/name/moveToRunLoop:" title="moveToRunLoop:"></a>
    1712. 

  1712. 	<h3 class="subsubtitle method-title">moveToRunLoop:</h3>
    1713. 

  1713. 	
    1714. 

  1714. 	
    1715. 

  1715. 	
    1716. 

  1716. 	<div class="method-subsection brief-description">
    1717. 

  1717. 		<p>When you create an AsyncSocket, it is added to the runloop of the current thread.<br/>
    1718. 

  1718. So for manually created sockets, it is easiest to simply create the socket on the thread you intend to use it.</p>
    1719. 

  1719. 	</div>		
    1720. 

  1720. 	
    1721. 

  1721.     
    1722. 

  1722. 

  1723. 	<div class="method-subsection method-declaration"><code>- (BOOL)moveToRunLoop:(NSRunLoop *)<em>runLoop</em></code></div>
    1724. 

  1724. 

  1725.     
    1726. 

  1726. 	
    1727. 

  1727. 	
    1728. 

  1728. 	
    1729. 

  1729. 	
    1730. 

  1730. 	
    1731. 

  1731. 	
    1732. 

  1732. 	
    1733. 

  1733. 	<div class="method-subsection discussion-section">
    1734. 

  1734. 		<h4 class="method-subtitle">Discussion</h4>
    1735. 

  1735. 		<p>When you create an AsyncSocket, it is added to the runloop of the current thread.<br/>
    1736. 

  1736. So for manually created sockets, it is easiest to simply create the socket on the thread you intend to use it.</p>
    1737. 

  1737. 

  1738. <p>If a new socket is accepted, the <a href="#//api/name/delegate">delegate</a> method onSocket:wantsRunLoopForNewSocket: is called to<br/>
    1739. 

  1739. allow you to place the socket on a separate thread. This works best in conjunction with a thread pool design.</p>
    1740. 

  1740. 

  1741. <p>If, however, you need to move the socket to a separate thread at a later time, this<br/>
    1742. 

  1742. method may be used to accomplish the task.</p>
    1743. 

  1743. 

  1744. <p>This method must be called from the thread/runloop the socket is currently running on.</p>
    1745. 

  1745. 

  1746. <p>Note: After calling this method, all further method calls to this object should be done from the given runloop.<br/>
    1747. 

  1747. Also, all <a href="#//api/name/delegate">delegate</a> calls will be sent on the given runloop.</p>
    1748. 

  1748. 	</div>
    1749. 

  1749. 	
    1750. 

  1750. 	
    1751. 

  1751. 	
    1752. 

  1752. 	
    1753. 

  1753. 	
    1754. 

  1754. 	
    1755. 

  1755. 	
    1756. 

  1756. 	<div class="method-subsection declared-in-section">
    1757. 

  1757. 		<h4 class="method-subtitle">Declared In</h4>
    1758. 

  1758. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1759. 

  1759. 	</div>				
    1760. 

  1760. 	
    1761. 

  1761. 	
    1762. 

  1762. </div>
    1763. 

  1763. 						
    1764. 

  1764. 						<div class="section-method">
    1765. 

  1765. 	<a name="//api/name/progressOfReadReturningTag:bytesDone:total:" title="progressOfReadReturningTag:bytesDone:total:"></a>
    1766. 

  1766. 	<h3 class="subsubtitle method-title">progressOfReadReturningTag:bytesDone:total:</h3>
    1767. 

  1767. 	
    1768. 

  1768. 	
    1769. 

  1769. 	
    1770. 

  1770. 	<div class="method-subsection brief-description">
    1771. 

  1771. 		<p>Returns progress of current read or write, from 0.0 to 1.0, or NaN if no read/write (use isnan() to check).<br/>
    1772. 

  1772. &ldquo;tag&rdquo;, &ldquo;done&rdquo; and &ldquo;total&rdquo; will be filled in if they aren&rsquo;t NULL.</p>
    1773. 

  1773. 	</div>		
    1774. 

  1774. 	
    1775. 

  1775.     
    1776. 

  1776. 

  1777. 	<div class="method-subsection method-declaration"><code>- (float)progressOfReadReturningTag:(long *)<em>tag</em> bytesDone:(NSUInteger *)<em>done</em> total:(NSUInteger *)<em>total</em></code></div>
    1778. 

  1778. 

  1779.     
    1780. 

  1780. 	
    1781. 

  1781. 	
    1782. 

  1782. 	
    1783. 

  1783. 	
    1784. 

  1784. 	
    1785. 

  1785. 	
    1786. 

  1786. 	
    1787. 

  1787. 	<div class="method-subsection discussion-section">
    1788. 

  1788. 		<h4 class="method-subtitle">Discussion</h4>
    1789. 

  1789. 		<p>Returns progress of current read or write, from 0.0 to 1.0, or NaN if no read/write (use isnan() to check).<br/>
    1790. 

  1790. &ldquo;tag&rdquo;, &ldquo;done&rdquo; and &ldquo;total&rdquo; will be filled in if they aren&rsquo;t NULL.</p>
    1791. 

  1791. 	</div>
    1792. 

  1792. 	
    1793. 

  1793. 	
    1794. 

  1794. 	
    1795. 

  1795. 	
    1796. 

  1796. 	
    1797. 

  1797. 	
    1798. 

  1798. 	
    1799. 

  1799. 	<div class="method-subsection declared-in-section">
    1800. 

  1800. 		<h4 class="method-subtitle">Declared In</h4>
    1801. 

  1801. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1802. 

  1802. 	</div>				
    1803. 

  1803. 	
    1804. 

  1804. 	
    1805. 

  1805. </div>
    1806. 

  1806. 						
    1807. 

  1807. 						<div class="section-method">
    1808. 

  1808. 	<a name="//api/name/progressOfWriteReturningTag:bytesDone:total:" title="progressOfWriteReturningTag:bytesDone:total:"></a>
    1809. 

  1809. 	<h3 class="subsubtitle method-title">progressOfWriteReturningTag:bytesDone:total:</h3>
    1810. 

  1810. 	
    1811. 

  1811. 	
    1812. 

  1812. 

  1813. 	<div class="method-subsection method-declaration"><code>- (float)progressOfWriteReturningTag:(long *)<em>tag</em> bytesDone:(NSUInteger *)<em>done</em> total:(NSUInteger *)<em>total</em></code></div>
    1814. 

  1814. 

  1815.     
    1816. 

  1816. </div>
    1817. 

  1817. 						
    1818. 

  1818. 						<div class="section-method">
    1819. 

  1819. 	<a name="//api/name/readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:" title="readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:"></a>
    1820. 

  1820. 	<h3 class="subsubtitle method-title">readDataToData:withTimeout:buffer:bufferOffset:maxLength:tag:</h3>
    1821. 

  1821. 	
    1822. 

  1822. 	
    1823. 

  1823. 	
    1824. 

  1824. 	<div class="method-subsection brief-description">
    1825. 

  1825. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    1826. 

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

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

  1828. A maximum of length bytes will be read.</p>
    1829. 

  1829. 	</div>		
    1830. 

  1830. 	
    1831. 

  1831.     
    1832. 

  1832. 

  1833. 	<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>
    1834. 

  1834. 

  1835.     
    1836. 

  1836. 	
    1837. 

  1837. 	
    1838. 

  1838. 	
    1839. 

  1839. 	
    1840. 

  1840. 	
    1841. 

  1841. 	
    1842. 

  1842. 	
    1843. 

  1843. 	<div class="method-subsection discussion-section">
    1844. 

  1844. 		<h4 class="method-subtitle">Discussion</h4>
    1845. 

  1845. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    1846. 

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

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

  1848. A maximum of length bytes will be read.</p>
    1849. 

  1849. 

  1850. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    1851. 

  1851. If the buffer if nil, a buffer will automatically be created for you.</p>
    1852. 

  1852. 

  1853. <p>If maxLength is zero, no length restriction is enforced.<br/>
    1854. 

  1854. Otherwise if maxLength bytes are read without completing the read,<br/>
    1855. 

  1855. it is treated similarly to a timeout - the socket is closed with a AsyncSocketReadMaxedOutError.<br/>
    1856. 

  1856. The read will complete successfully if exactly maxLength bytes are read and the given data is found at the end.</p>
    1857. 

  1857. 

  1858. <p>If you pass a maxLength parameter that is less than the length of the data parameter,<br/>
    1859. 

  1859. the method will do nothing, and the <a href="#//api/name/delegate">delegate</a> will not be called.<br/>
    1860. 

  1860. If the bufferOffset is greater than the length of the given buffer,<br/>
    1861. 

  1861. the method will do nothing, and the <a href="#//api/name/delegate">delegate</a> will not be called.</p>
    1862. 

  1862. 

  1863. <p>If you pass a buffer, you must not alter it in any way while AsyncSocket is using it.<br/>
    1864. 

  1864. After completion, the data returned in onSocket:didReadData:withTag: will be a subset of the given buffer.<br/>
    1865. 

  1865. That is, it will reference the bytes that were appended to the given buffer.</p>
    1866. 

  1866. 

  1867. <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/>
    1868. 

  1868. Note that this method is not character-set aware, so if a separator can occur naturally as part of the encoding for<br/>
    1869. 

  1869. a character, the read will prematurely end.</p>
    1870. 

  1870. 	</div>
    1871. 

  1871. 	
    1872. 

  1872. 	
    1873. 

  1873. 	
    1874. 

  1874. 	
    1875. 

  1875. 	
    1876. 

  1876. 	
    1877. 

  1877. 	
    1878. 

  1878. 	<div class="method-subsection declared-in-section">
    1879. 

  1879. 		<h4 class="method-subtitle">Declared In</h4>
    1880. 

  1880. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1881. 

  1881. 	</div>				
    1882. 

  1882. 	
    1883. 

  1883. 	
    1884. 

  1884. </div>
    1885. 

  1885. 						
    1886. 

  1886. 						<div class="section-method">
    1887. 

  1887. 	<a name="//api/name/readDataToData:withTimeout:buffer:bufferOffset:tag:" title="readDataToData:withTimeout:buffer:bufferOffset:tag:"></a>
    1888. 

  1888. 	<h3 class="subsubtitle method-title">readDataToData:withTimeout:buffer:bufferOffset:tag:</h3>
    1889. 

  1889. 	
    1890. 

  1890. 	
    1891. 

  1891. 	
    1892. 

  1892. 	<div class="method-subsection brief-description">
    1893. 

  1893. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    1894. 

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

  1895. The given buffer will automatically be increased in size if needed.</p>
    1896. 

  1896. 	</div>		
    1897. 

  1897. 	
    1898. 

  1898.     
    1899. 

  1899. 

  1900. 	<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>
    1901. 

  1901. 

  1902.     
    1903. 

  1903. 	
    1904. 

  1904. 	
    1905. 

  1905. 	
    1906. 

  1906. 	
    1907. 

  1907. 	
    1908. 

  1908. 	
    1909. 

  1909. 	
    1910. 

  1910. 	<div class="method-subsection discussion-section">
    1911. 

  1911. 		<h4 class="method-subtitle">Discussion</h4>
    1912. 

  1912. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.<br/>
    1913. 

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

  1914. The given buffer will automatically be increased in size if needed.</p>
    1915. 

  1915. 

  1916. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    1917. 

  1917. If the buffer if nil, a buffer will automatically be created for you.</p>
    1918. 

  1918. 

  1919. <p>If the bufferOffset is greater than the length of the given buffer,<br/>
    1920. 

  1920. the method will do nothing, and the <a href="#//api/name/delegate">delegate</a> will not be called.</p>
    1921. 

  1921. 

  1922. <p>If you pass a buffer, you must not alter it in any way while AsyncSocket is using it.<br/>
    1923. 

  1923. After completion, the data returned in onSocket:didReadData:withTag: will be a subset of the given buffer.<br/>
    1924. 

  1924. That is, it will reference the bytes that were appended to the given buffer.</p>
    1925. 

  1925. 

  1926. <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/>
    1927. 

  1927. Note that this method is not character-set aware, so if a separator can occur naturally as part of the encoding for<br/>
    1928. 

  1928. a character, the read will prematurely end.</p>
    1929. 

  1929. 	</div>
    1930. 

  1930. 	
    1931. 

  1931. 	
    1932. 

  1932. 	
    1933. 

  1933. 	
    1934. 

  1934. 	
    1935. 

  1935. 	
    1936. 

  1936. 	
    1937. 

  1937. 	<div class="method-subsection declared-in-section">
    1938. 

  1938. 		<h4 class="method-subtitle">Declared In</h4>
    1939. 

  1939. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1940. 

  1940. 	</div>				
    1941. 

  1941. 	
    1942. 

  1942. 	
    1943. 

  1943. </div>
    1944. 

  1944. 						
    1945. 

  1945. 						<div class="section-method">
    1946. 

  1946. 	<a name="//api/name/readDataToData:withTimeout:maxLength:tag:" title="readDataToData:withTimeout:maxLength:tag:"></a>
    1947. 

  1947. 	<h3 class="subsubtitle method-title">readDataToData:withTimeout:maxLength:tag:</h3>
    1948. 

  1948. 	
    1949. 

  1949. 	
    1950. 

  1950. 	
    1951. 

  1951. 	<div class="method-subsection brief-description">
    1952. 

  1952. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p>
    1953. 

  1953. 	</div>		
    1954. 

  1954. 	
    1955. 

  1955.     
    1956. 

  1956. 

  1957. 	<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>
    1958. 

  1958. 

  1959.     
    1960. 

  1960. 	
    1961. 

  1961. 	
    1962. 

  1962. 	
    1963. 

  1963. 	
    1964. 

  1964. 	
    1965. 

  1965. 	
    1966. 

  1966. 	
    1967. 

  1967. 	<div class="method-subsection discussion-section">
    1968. 

  1968. 		<h4 class="method-subtitle">Discussion</h4>
    1969. 

  1969. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p>
    1970. 

  1970. 

  1971. <p>If the timeout value is negative, the read operation will not use a timeout.</p>
    1972. 

  1972. 

  1973. <p>If maxLength is zero, no length restriction is enforced.<br/>
    1974. 

  1974. Otherwise if maxLength bytes are read without completing the read,<br/>
    1975. 

  1975. it is treated similarly to a timeout - the socket is closed with a AsyncSocketReadMaxedOutError.<br/>
    1976. 

  1976. The read will complete successfully if exactly maxLength bytes are read and the given data is found at the end.</p>
    1977. 

  1977. 

  1978. <p>If you pass nil or zero-length data as the &ldquo;data&rdquo; parameter,<br/>
    1979. 

  1979. the method will do nothing, and the <a href="#//api/name/delegate">delegate</a> will not be called.<br/>
    1980. 

  1980. If you pass a maxLength parameter that is less than the length of the data parameter,<br/>
    1981. 

  1981. the method will do nothing, and the <a href="#//api/name/delegate">delegate</a> will not be called.</p>
    1982. 

  1982. 

  1983. <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/>
    1984. 

  1984. Note that this method is not character-set aware, so if a separator can occur naturally as part of the encoding for<br/>
    1985. 

  1985. a character, the read will prematurely end.</p>
    1986. 

  1986. 	</div>
    1987. 

  1987. 	
    1988. 

  1988. 	
    1989. 

  1989. 	
    1990. 

  1990. 	
    1991. 

  1991. 	
    1992. 

  1992. 	
    1993. 

  1993. 	
    1994. 

  1994. 	<div class="method-subsection declared-in-section">
    1995. 

  1995. 		<h4 class="method-subtitle">Declared In</h4>
    1996. 

  1996. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    1997. 

  1997. 	</div>				
    1998. 

  1998. 	
    1999. 

  1999. 	
    2000. 

  2000. </div>
    2001. 

  2001. 						
    2002. 

  2002. 						<div class="section-method">
    2003. 

  2003. 	<a name="//api/name/readDataToData:withTimeout:tag:" title="readDataToData:withTimeout:tag:"></a>
    2004. 

  2004. 	<h3 class="subsubtitle method-title">readDataToData:withTimeout:tag:</h3>
    2005. 

  2005. 	
    2006. 

  2006. 	
    2007. 

  2007. 	
    2008. 

  2008. 	<div class="method-subsection brief-description">
    2009. 

  2009. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p>
    2010. 

  2010. 	</div>		
    2011. 

  2011. 	
    2012. 

  2012.     
    2013. 

  2013. 

  2014. 	<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>
    2015. 

  2015. 

  2016.     
    2017. 

  2017. 	
    2018. 

  2018. 	
    2019. 

  2019. 	
    2020. 

  2020. 	
    2021. 

  2021. 	
    2022. 

  2022. 	
    2023. 

  2023. 	
    2024. 

  2024. 	<div class="method-subsection discussion-section">
    2025. 

  2025. 		<h4 class="method-subtitle">Discussion</h4>
    2026. 

  2026. 		<p>Reads bytes until (and including) the passed &ldquo;data&rdquo; parameter, which acts as a separator.</p>
    2027. 

  2027. 

  2028. <p>If the timeout value is negative, the read operation will not use a timeout.</p>
    2029. 

  2029. 

  2030. <p>If you pass nil or zero-length data as the &ldquo;data&rdquo; parameter,<br/>
    2031. 

  2031. the method will do nothing, and the <a href="#//api/name/delegate">delegate</a> will not be called.</p>
    2032. 

  2032. 

  2033. <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/>
    2034. 

  2034. Note that this method is not character-set aware, so if a separator can occur naturally as part of the encoding for<br/>
    2035. 

  2035. a character, the read will prematurely end.</p>
    2036. 

  2036. 	</div>
    2037. 

  2037. 	
    2038. 

  2038. 	
    2039. 

  2039. 	
    2040. 

  2040. 	
    2041. 

  2041. 	
    2042. 

  2042. 	
    2043. 

  2043. 	
    2044. 

  2044. 	<div class="method-subsection declared-in-section">
    2045. 

  2045. 		<h4 class="method-subtitle">Declared In</h4>
    2046. 

  2046. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2047. 

  2047. 	</div>				
    2048. 

  2048. 	
    2049. 

  2049. 	
    2050. 

  2050. </div>
    2051. 

  2051. 						
    2052. 

  2052. 						<div class="section-method">
    2053. 

  2053. 	<a name="//api/name/readDataToLength:withTimeout:buffer:bufferOffset:tag:" title="readDataToLength:withTimeout:buffer:bufferOffset:tag:"></a>
    2054. 

  2054. 	<h3 class="subsubtitle method-title">readDataToLength:withTimeout:buffer:bufferOffset:tag:</h3>
    2055. 

  2055. 	
    2056. 

  2056. 	
    2057. 

  2057. 	
    2058. 

  2058. 	<div class="method-subsection brief-description">
    2059. 

  2059. 		<p>Reads the given number of bytes.<br/>
    2060. 

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

  2061. The given buffer will automatically be increased in size if needed.</p>
    2062. 

  2062. 	</div>		
    2063. 

  2063. 	
    2064. 

  2064.     
    2065. 

  2065. 

  2066. 	<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>
    2067. 

  2067. 

  2068.     
    2069. 

  2069. 	
    2070. 

  2070. 	
    2071. 

  2071. 	
    2072. 

  2072. 	
    2073. 

  2073. 	
    2074. 

  2074. 	
    2075. 

  2075. 	
    2076. 

  2076. 	<div class="method-subsection discussion-section">
    2077. 

  2077. 		<h4 class="method-subtitle">Discussion</h4>
    2078. 

  2078. 		<p>Reads the given number of bytes.<br/>
    2079. 

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

  2080. The given buffer will automatically be increased in size if needed.</p>
    2081. 

  2081. 

  2082. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    2083. 

  2083. If the buffer if nil, a buffer will automatically be created for you.</p>
    2084. 

  2084. 

  2085. <p>If the length is 0, this method does nothing and the <a href="#//api/name/delegate">delegate</a> is not called.<br/>
    2086. 

  2086. If the bufferOffset is greater than the length of the given buffer,<br/>
    2087. 

  2087. the method will do nothing, and the <a href="#//api/name/delegate">delegate</a> will not be called.</p>
    2088. 

  2088. 

  2089. <p>If you pass a buffer, you must not alter it in any way while AsyncSocket is using it.<br/>
    2090. 

  2090. After completion, the data returned in onSocket:didReadData:withTag: will be a subset of the given buffer.<br/>
    2091. 

  2091. That is, it will reference the bytes that were appended to the given buffer.</p>
    2092. 

  2092. 	</div>
    2093. 

  2093. 	
    2094. 

  2094. 	
    2095. 

  2095. 	
    2096. 

  2096. 	
    2097. 

  2097. 	
    2098. 

  2098. 	
    2099. 

  2099. 	
    2100. 

  2100. 	<div class="method-subsection declared-in-section">
    2101. 

  2101. 		<h4 class="method-subtitle">Declared In</h4>
    2102. 

  2102. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2103. 

  2103. 	</div>				
    2104. 

  2104. 	
    2105. 

  2105. 	
    2106. 

  2106. </div>
    2107. 

  2107. 						
    2108. 

  2108. 						<div class="section-method">
    2109. 

  2109. 	<a name="//api/name/readDataToLength:withTimeout:tag:" title="readDataToLength:withTimeout:tag:"></a>
    2110. 

  2110. 	<h3 class="subsubtitle method-title">readDataToLength:withTimeout:tag:</h3>
    2111. 

  2111. 	
    2112. 

  2112. 	
    2113. 

  2113. 	
    2114. 

  2114. 	<div class="method-subsection brief-description">
    2115. 

  2115. 		<p>Reads the given number of bytes.</p>
    2116. 

  2116. 	</div>		
    2117. 

  2117. 	
    2118. 

  2118.     
    2119. 

  2119. 

  2120. 	<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>
    2121. 

  2121. 

  2122.     
    2123. 

  2123. 	
    2124. 

  2124. 	
    2125. 

  2125. 	
    2126. 

  2126. 	
    2127. 

  2127. 	
    2128. 

  2128. 	
    2129. 

  2129. 	
    2130. 

  2130. 	<div class="method-subsection discussion-section">
    2131. 

  2131. 		<h4 class="method-subtitle">Discussion</h4>
    2132. 

  2132. 		<p>Reads the given number of bytes.</p>
    2133. 

  2133. 

  2134. <p>If the timeout value is negative, the read operation will not use a timeout.</p>
    2135. 

  2135. 

  2136. <p>If the length is 0, this method does nothing and the <a href="#//api/name/delegate">delegate</a> is not called.</p>
    2137. 

  2137. 	</div>
    2138. 

  2138. 	
    2139. 

  2139. 	
    2140. 

  2140. 	
    2141. 

  2141. 	
    2142. 

  2142. 	
    2143. 

  2143. 	
    2144. 

  2144. 	
    2145. 

  2145. 	<div class="method-subsection declared-in-section">
    2146. 

  2146. 		<h4 class="method-subtitle">Declared In</h4>
    2147. 

  2147. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2148. 

  2148. 	</div>				
    2149. 

  2149. 	
    2150. 

  2150. 	
    2151. 

  2151. </div>
    2152. 

  2152. 						
    2153. 

  2153. 						<div class="section-method">
    2154. 

  2154. 	<a name="//api/name/readDataWithTimeout:buffer:bufferOffset:maxLength:tag:" title="readDataWithTimeout:buffer:bufferOffset:maxLength:tag:"></a>
    2155. 

  2155. 	<h3 class="subsubtitle method-title">readDataWithTimeout:buffer:bufferOffset:maxLength:tag:</h3>
    2156. 

  2156. 	
    2157. 

  2157. 	
    2158. 

  2158. 	
    2159. 

  2159. 	<div class="method-subsection brief-description">
    2160. 

  2160. 		<p>Reads the first available bytes that become available on the socket.<br/>
    2161. 

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

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

  2163. A maximum of length bytes will be read.</p>
    2164. 

  2164. 	</div>		
    2165. 

  2165. 	
    2166. 

  2166.     
    2167. 

  2167. 

  2168. 	<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>
    2169. 

  2169. 

  2170.     
    2171. 

  2171. 	
    2172. 

  2172. 	
    2173. 

  2173. 	
    2174. 

  2174. 	
    2175. 

  2175. 	
    2176. 

  2176. 	
    2177. 

  2177. 	
    2178. 

  2178. 	<div class="method-subsection discussion-section">
    2179. 

  2179. 		<h4 class="method-subtitle">Discussion</h4>
    2180. 

  2180. 		<p>Reads the first available bytes that become available on the socket.<br/>
    2181. 

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

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

  2183. A maximum of length bytes will be read.</p>
    2184. 

  2184. 

  2185. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    2186. 

  2186. If the buffer if nil, a buffer will automatically be created for you.<br/>
    2187. 

  2187. If maxLength is zero, no length restriction is enforced.</p>
    2188. 

  2188. 

  2189. <p>If the bufferOffset is greater than the length of the given buffer,<br/>
    2190. 

  2190. the method will do nothing, and the <a href="#//api/name/delegate">delegate</a> will not be called.</p>
    2191. 

  2191. 

  2192. <p>If you pass a buffer, you must not alter it in any way while AsyncSocket is using it.<br/>
    2193. 

  2193. After completion, the data returned in onSocket:didReadData:withTag: will be a subset of the given buffer.<br/>
    2194. 

  2194. That is, it will reference the bytes that were appended to the given buffer.</p>
    2195. 

  2195. 	</div>
    2196. 

  2196. 	
    2197. 

  2197. 	
    2198. 

  2198. 	
    2199. 

  2199. 	
    2200. 

  2200. 	
    2201. 

  2201. 	
    2202. 

  2202. 	
    2203. 

  2203. 	<div class="method-subsection declared-in-section">
    2204. 

  2204. 		<h4 class="method-subtitle">Declared In</h4>
    2205. 

  2205. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2206. 

  2206. 	</div>				
    2207. 

  2207. 	
    2208. 

  2208. 	
    2209. 

  2209. </div>
    2210. 

  2210. 						
    2211. 

  2211. 						<div class="section-method">
    2212. 

  2212. 	<a name="//api/name/readDataWithTimeout:buffer:bufferOffset:tag:" title="readDataWithTimeout:buffer:bufferOffset:tag:"></a>
    2213. 

  2213. 	<h3 class="subsubtitle method-title">readDataWithTimeout:buffer:bufferOffset:tag:</h3>
    2214. 

  2214. 	
    2215. 

  2215. 	
    2216. 

  2216. 	
    2217. 

  2217. 	<div class="method-subsection brief-description">
    2218. 

  2218. 		<p>Reads the first available bytes that become available on the socket.<br/>
    2219. 

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

  2220. The given buffer will automatically be increased in size if needed.</p>
    2221. 

  2221. 	</div>		
    2222. 

  2222. 	
    2223. 

  2223.     
    2224. 

  2224. 

  2225. 	<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>
    2226. 

  2226. 

  2227.     
    2228. 

  2228. 	
    2229. 

  2229. 	
    2230. 

  2230. 	
    2231. 

  2231. 	
    2232. 

  2232. 	
    2233. 

  2233. 	
    2234. 

  2234. 	
    2235. 

  2235. 	<div class="method-subsection discussion-section">
    2236. 

  2236. 		<h4 class="method-subtitle">Discussion</h4>
    2237. 

  2237. 		<p>Reads the first available bytes that become available on the socket.<br/>
    2238. 

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

  2239. The given buffer will automatically be increased in size if needed.</p>
    2240. 

  2240. 

  2241. <p>If the timeout value is negative, the read operation will not use a timeout.<br/>
    2242. 

  2242. If the buffer if nil, the socket will create a buffer for you.</p>
    2243. 

  2243. 

  2244. <p>If the bufferOffset is greater than the length of the given buffer,<br/>
    2245. 

  2245. the method will do nothing, and the <a href="#//api/name/delegate">delegate</a> will not be called.</p>
    2246. 

  2246. 

  2247. <p>If you pass a buffer, you must not alter it in any way while AsyncSocket is using it.<br/>
    2248. 

  2248. After completion, the data returned in onSocket:didReadData:withTag: will be a subset of the given buffer.<br/>
    2249. 

  2249. That is, it will reference the bytes that were appended to the given buffer.</p>
    2250. 

  2250. 	</div>
    2251. 

  2251. 	
    2252. 

  2252. 	
    2253. 

  2253. 	
    2254. 

  2254. 	
    2255. 

  2255. 	
    2256. 

  2256. 	
    2257. 

  2257. 	
    2258. 

  2258. 	<div class="method-subsection declared-in-section">
    2259. 

  2259. 		<h4 class="method-subtitle">Declared In</h4>
    2260. 

  2260. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2261. 

  2261. 	</div>				
    2262. 

  2262. 	
    2263. 

  2263. 	
    2264. 

  2264. </div>
    2265. 

  2265. 						
    2266. 

  2266. 						<div class="section-method">
    2267. 

  2267. 	<a name="//api/name/readDataWithTimeout:tag:" title="readDataWithTimeout:tag:"></a>
    2268. 

  2268. 	<h3 class="subsubtitle method-title">readDataWithTimeout:tag:</h3>
    2269. 

  2269. 	
    2270. 

  2270. 	
    2271. 

  2271. 	
    2272. 

  2272. 	<div class="method-subsection brief-description">
    2273. 

  2273. 		<p>Reads the first available bytes that become available on the socket.</p>
    2274. 

  2274. 	</div>		
    2275. 

  2275. 	
    2276. 

  2276.     
    2277. 

  2277. 

  2278. 	<div class="method-subsection method-declaration"><code>- (void)readDataWithTimeout:(NSTimeInterval)<em>timeout</em> tag:(long)<em>tag</em></code></div>
    2279. 

  2279. 

  2280.     
    2281. 

  2281. 	
    2282. 

  2282. 	
    2283. 

  2283. 	
    2284. 

  2284. 	
    2285. 

  2285. 	
    2286. 

  2286. 	
    2287. 

  2287. 	
    2288. 

  2288. 	<div class="method-subsection discussion-section">
    2289. 

  2289. 		<h4 class="method-subtitle">Discussion</h4>
    2290. 

  2290. 		<p>Reads the first available bytes that become available on the socket.</p>
    2291. 

  2291. 

  2292. <p>If the timeout value is negative, the read operation will not use a timeout.</p>
    2293. 

  2293. 	</div>
    2294. 

  2294. 	
    2295. 

  2295. 	
    2296. 

  2296. 	
    2297. 

  2297. 	
    2298. 

  2298. 	
    2299. 

  2299. 	
    2300. 

  2300. 	
    2301. 

  2301. 	<div class="method-subsection declared-in-section">
    2302. 

  2302. 		<h4 class="method-subtitle">Declared In</h4>
    2303. 

  2303. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2304. 

  2304. 	</div>				
    2305. 

  2305. 	
    2306. 

  2306. 	
    2307. 

  2307. </div>
    2308. 

  2308. 						
    2309. 

  2309. 						<div class="section-method">
    2310. 

  2310. 	<a name="//api/name/removeRunLoopMode:" title="removeRunLoopMode:"></a>
    2311. 

  2311. 	<h3 class="subsubtitle method-title">removeRunLoopMode:</h3>
    2312. 

  2312. 	
    2313. 

  2313. 	
    2314. 

  2314. 

  2315. 	<div class="method-subsection method-declaration"><code>- (BOOL)removeRunLoopMode:(NSString *)<em>runLoopMode</em></code></div>
    2316. 

  2316. 

  2317.     
    2318. 

  2318. </div>
    2319. 

  2319. 						
    2320. 

  2320. 						<div class="section-method">
    2321. 

  2321. 	<a name="//api/name/runLoopModes" title="runLoopModes"></a>
    2322. 

  2322. 	<h3 class="subsubtitle method-title">runLoopModes</h3>
    2323. 

  2323. 	
    2324. 

  2324. 	
    2325. 

  2325. 	
    2326. 

  2326. 	<div class="method-subsection brief-description">
    2327. 

  2327. 		<p>Returns the current run loop modes the AsyncSocket instance is operating in.<br/>
    2328. 

  2328. The default set of run loop modes is NSDefaultRunLoopMode.</p>
    2329. 

  2329. 	</div>		
    2330. 

  2330. 	
    2331. 

  2331.     
    2332. 

  2332. 

  2333. 	<div class="method-subsection method-declaration"><code>- (NSArray *)runLoopModes</code></div>
    2334. 

  2334. 

  2335.     
    2336. 

  2336. 	
    2337. 

  2337. 	
    2338. 

  2338. 	
    2339. 

  2339. 	
    2340. 

  2340. 	
    2341. 

  2341. 	
    2342. 

  2342. 	
    2343. 

  2343. 	<div class="method-subsection discussion-section">
    2344. 

  2344. 		<h4 class="method-subtitle">Discussion</h4>
    2345. 

  2345. 		<p>Returns the current run loop modes the AsyncSocket instance is operating in.<br/>
    2346. 

  2346. The default set of run loop modes is NSDefaultRunLoopMode.</p>
    2347. 

  2347. 	</div>
    2348. 

  2348. 	
    2349. 

  2349. 	
    2350. 

  2350. 	
    2351. 

  2351. 	
    2352. 

  2352. 	
    2353. 

  2353. 	
    2354. 

  2354. 	
    2355. 

  2355. 	<div class="method-subsection declared-in-section">
    2356. 

  2356. 		<h4 class="method-subtitle">Declared In</h4>
    2357. 

  2357. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2358. 

  2358. 	</div>				
    2359. 

  2359. 	
    2360. 

  2360. 	
    2361. 

  2361. </div>
    2362. 

  2362. 						
    2363. 

  2363. 						<div class="section-method">
    2364. 

  2364. 	<a name="//api/name/setDelegate:" title="setDelegate:"></a>
    2365. 

  2365. 	<h3 class="subsubtitle method-title">setDelegate:</h3>
    2366. 

  2366. 	
    2367. 

  2367. 	
    2368. 

  2368. 

  2369. 	<div class="method-subsection method-declaration"><code>- (void)setDelegate:(id)<em>delegate</em></code></div>
    2370. 

  2370. 

  2371.     
    2372. 

  2372. </div>
    2373. 

  2373. 						
    2374. 

  2374. 						<div class="section-method">
    2375. 

  2375. 	<a name="//api/name/setRunLoopModes:" title="setRunLoopModes:"></a>
    2376. 

  2376. 	<h3 class="subsubtitle method-title">setRunLoopModes:</h3>
    2377. 

  2377. 	
    2378. 

  2378. 	
    2379. 

  2379. 	
    2380. 

  2380. 	<div class="method-subsection brief-description">
    2381. 

  2381. 		<p>Allows you to configure which run loop modes the socket uses.<br/>
    2382. 

  2382. The default set of run loop modes is NSDefaultRunLoopMode.</p>
    2383. 

  2383. 	</div>		
    2384. 

  2384. 	
    2385. 

  2385.     
    2386. 

  2386. 

  2387. 	<div class="method-subsection method-declaration"><code>- (BOOL)setRunLoopModes:(NSArray *)<em>runLoopModes</em></code></div>
    2388. 

  2388. 

  2389.     
    2390. 

  2390. 	
    2391. 

  2391. 	
    2392. 

  2392. 	
    2393. 

  2393. 	
    2394. 

  2394. 	
    2395. 

  2395. 	
    2396. 

  2396. 	
    2397. 

  2397. 	<div class="method-subsection discussion-section">
    2398. 

  2398. 		<h4 class="method-subtitle">Discussion</h4>
    2399. 

  2399. 		<p>Allows you to configure which run loop modes the socket uses.<br/>
    2400. 

  2400. The default set of run loop modes is NSDefaultRunLoopMode.</p>
    2401. 

  2401. 

  2402. <p>If you&rsquo;d like your socket to continue operation during other modes, you may want to add modes such as<br/>
    2403. 

  2403. NSModalPanelRunLoopMode or NSEventTrackingRunLoopMode. Or you may simply want to use NSRunLoopCommonModes.</p>
    2404. 

  2404. 

  2405. <p>Accepted sockets will automatically inherit the same run loop modes as the listening socket.</p>
    2406. 

  2406. 

  2407. <p>Note: NSRunLoopCommonModes is defined in 10.5. For previous versions one can use kCFRunLoopCommonModes.</p>
    2408. 

  2408. 	</div>
    2409. 

  2409. 	
    2410. 

  2410. 	
    2411. 

  2411. 	
    2412. 

  2412. 	
    2413. 

  2413. 	
    2414. 

  2414. 	
    2415. 

  2415. 	
    2416. 

  2416. 	<div class="method-subsection declared-in-section">
    2417. 

  2417. 		<h4 class="method-subtitle">Declared In</h4>
    2418. 

  2418. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2419. 

  2419. 	</div>				
    2420. 

  2420. 	
    2421. 

  2421. 	
    2422. 

  2422. </div>
    2423. 

  2423. 						
    2424. 

  2424. 						<div class="section-method">
    2425. 

  2425. 	<a name="//api/name/setUserData:" title="setUserData:"></a>
    2426. 

  2426. 	<h3 class="subsubtitle method-title">setUserData:</h3>
    2427. 

  2427. 	
    2428. 

  2428. 	
    2429. 

  2429. 

  2430. 	<div class="method-subsection method-declaration"><code>- (void)setUserData:(long)<em>userData</em></code></div>
    2431. 

  2431. 

  2432.     
    2433. 

  2433. </div>
    2434. 

  2434. 						
    2435. 

  2435. 						<div class="section-method">
    2436. 

  2436. 	<a name="//api/name/startTLS:" title="startTLS:"></a>
    2437. 

  2437. 	<h3 class="subsubtitle method-title">startTLS:</h3>
    2438. 

  2438. 	
    2439. 

  2439. 	
    2440. 

  2440. 	
    2441. 

  2441. 	<div class="method-subsection brief-description">
    2442. 

  2442. 		<p>Secures the connection using SSL/TLS.</p>
    2443. 

  2443. 	</div>		
    2444. 

  2444. 	
    2445. 

  2445.     
    2446. 

  2446. 

  2447. 	<div class="method-subsection method-declaration"><code>- (void)startTLS:(NSDictionary *)<em>tlsSettings</em></code></div>
    2448. 

  2448. 

  2449.     
    2450. 

  2450. 	
    2451. 

  2451. 	
    2452. 

  2452. 	
    2453. 

  2453. 	
    2454. 

  2454. 	
    2455. 

  2455. 	
    2456. 

  2456. 	
    2457. 

  2457. 	<div class="method-subsection discussion-section">
    2458. 

  2458. 		<h4 class="method-subtitle">Discussion</h4>
    2459. 

  2459. 		<p>Secures the connection using SSL/TLS.</p>
    2460. 

  2460. 

  2461. <p>This method may be called at any time, and the TLS handshake will occur after all pending reads and writes<br/>
    2462. 

  2462. are finished. This allows one the option of sending a protocol dependent StartTLS message, and queuing<br/>
    2463. 

  2463. the upgrade to TLS at the same time, without having to wait for the write to finish.<br/>
    2464. 

  2464. Any reads or writes scheduled after this method is called will occur over the secured connection.</p>
    2465. 

  2465. 

  2466. <p>The possible keys and values for the TLS settings are well documented.<br/>
    2467. 

  2467. Some possible keys are:<br/>
    2468. 

  2468. - kCFStreamSSLLevel<br/>
    2469. 

  2469. - kCFStreamSSLAllowsExpiredCertificates<br/>
    2470. 

  2470. - kCFStreamSSLAllowsExpiredRoots<br/>
    2471. 

  2471. - kCFStreamSSLAllowsAnyRoot<br/>
    2472. 

  2472. - kCFStreamSSLValidatesCertificateChain<br/>
    2473. 

  2473. - kCFStreamSSLPeerName<br/>
    2474. 

  2474. - kCFStreamSSLCertificates<br/>
    2475. 

  2475. - kCFStreamSSLIsServer</p>
    2476. 

  2476. 

  2477. <p>Please refer to Apple&rsquo;s documentation for associated values, as well as other possible keys.</p>
    2478. 

  2478. 

  2479. <p>If you pass in nil or an empty dictionary, the default settings will be used.</p>
    2480. 

  2480. 

  2481. <p>The default settings will check to make sure the remote party&rsquo;s certificate is signed by a<br/>
    2482. 

  2482. trusted 3rd party certificate agency (e.g. verisign) and that the certificate is not expired.<br/>
    2483. 

  2483. However it will not verify the name on the certificate unless you<br/>
    2484. 

  2484. give it a name to verify against via the kCFStreamSSLPeerName key.<br/>
    2485. 

  2485. The security implications of this are important to understand.<br/>
    2486. 

  2486. Imagine you are attempting to create a secure connection to MySecureServer.com,<br/>
    2487. 

  2487. but your socket gets directed to MaliciousServer.com because of a hacked DNS server.<br/>
    2488. 

  2488. If you simply use the default settings, and MaliciousServer.com has a valid certificate,<br/>
    2489. 

  2489. the default settings will not detect any problems since the certificate is valid.<br/>
    2490. 

  2490. To properly secure your connection in this particular scenario you<br/>
    2491. 

  2491. should set the kCFStreamSSLPeerName property to &ldquo;MySecureServer.com&rdquo;.<br/>
    2492. 

  2492. If you do not know the peer name of the remote host in advance (for example, you&rsquo;re not sure<br/>
    2493. 

  2493. 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/>
    2494. 

  2494. certificate, and then use the X509Certificate class to verify the issuer after the socket has been secured.<br/>
    2495. 

  2495. The X509Certificate class is part of the CocoaAsyncSocket open source project.</p>
    2496. 

  2496. 	</div>
    2497. 

  2497. 	
    2498. 

  2498. 	
    2499. 

  2499. 	
    2500. 

  2500. 	
    2501. 

  2501. 	
    2502. 

  2502. 	
    2503. 

  2503. 	
    2504. 

  2504. 	<div class="method-subsection declared-in-section">
    2505. 

  2505. 		<h4 class="method-subtitle">Declared In</h4>
    2506. 

  2506. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2507. 

  2507. 	</div>				
    2508. 

  2508. 	
    2509. 

  2509. 	
    2510. 

  2510. </div>
    2511. 

  2511. 						
    2512. 

  2512. 						<div class="section-method">
    2513. 

  2513. 	<a name="//api/name/unreadData" title="unreadData"></a>
    2514. 

  2514. 	<h3 class="subsubtitle method-title">unreadData</h3>
    2515. 

  2515. 	
    2516. 

  2516. 	
    2517. 

  2517. 	
    2518. 

  2518. 	<div class="method-subsection brief-description">
    2519. 

  2519. 		<p>In the event of an error, this method may be called during onSocket:willDisconnectWithError: to read<br/>
    2520. 

  2520. any data that&rsquo;s left on the socket.</p>
    2521. 

  2521. 	</div>		
    2522. 

  2522. 	
    2523. 

  2523.     
    2524. 

  2524. 

  2525. 	<div class="method-subsection method-declaration"><code>- (NSData *)unreadData</code></div>
    2526. 

  2526. 

  2527.     
    2528. 

  2528. 	
    2529. 

  2529. 	
    2530. 

  2530. 	
    2531. 

  2531. 	
    2532. 

  2532. 	
    2533. 

  2533. 	
    2534. 

  2534. 	
    2535. 

  2535. 	<div class="method-subsection discussion-section">
    2536. 

  2536. 		<h4 class="method-subtitle">Discussion</h4>
    2537. 

  2537. 		<p>In the event of an error, this method may be called during onSocket:willDisconnectWithError: to read<br/>
    2538. 

  2538. any data that&rsquo;s left on the socket.</p>
    2539. 

  2539. 	</div>
    2540. 

  2540. 	
    2541. 

  2541. 	
    2542. 

  2542. 	
    2543. 

  2543. 	
    2544. 

  2544. 	
    2545. 

  2545. 	
    2546. 

  2546. 	
    2547. 

  2547. 	<div class="method-subsection declared-in-section">
    2548. 

  2548. 		<h4 class="method-subtitle">Declared In</h4>
    2549. 

  2549. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2550. 

  2550. 	</div>				
    2551. 

  2551. 	
    2552. 

  2552. 	
    2553. 

  2553. </div>
    2554. 

  2554. 						
    2555. 

  2555. 						<div class="section-method">
    2556. 

  2556. 	<a name="//api/name/userData" title="userData"></a>
    2557. 

  2557. 	<h3 class="subsubtitle method-title">userData</h3>
    2558. 

  2558. 	
    2559. 

  2559. 	
    2560. 

  2560. 

  2561. 	<div class="method-subsection method-declaration"><code>- (long)userData</code></div>
    2562. 

  2562. 

  2563.     
    2564. 

  2564. </div>
    2565. 

  2565. 						
    2566. 

  2566. 						<div class="section-method">
    2567. 

  2567. 	<a name="//api/name/writeData:withTimeout:tag:" title="writeData:withTimeout:tag:"></a>
    2568. 

  2568. 	<h3 class="subsubtitle method-title">writeData:withTimeout:tag:</h3>
    2569. 

  2569. 	
    2570. 

  2570. 	
    2571. 

  2571. 	
    2572. 

  2572. 	<div class="method-subsection brief-description">
    2573. 

  2573. 		<p>Writes data to the socket, and calls the <a href="#//api/name/delegate">delegate</a> when finished.</p>
    2574. 

  2574. 	</div>		
    2575. 

  2575. 	
    2576. 

  2576.     
    2577. 

  2577. 

  2578. 	<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>
    2579. 

  2579. 

  2580.     
    2581. 

  2581. 	
    2582. 

  2582. 	
    2583. 

  2583. 	
    2584. 

  2584. 	
    2585. 

  2585. 	
    2586. 

  2586. 	
    2587. 

  2587. 	
    2588. 

  2588. 	<div class="method-subsection discussion-section">
    2589. 

  2589. 		<h4 class="method-subtitle">Discussion</h4>
    2590. 

  2590. 		<p>Writes data to the socket, and calls the <a href="#//api/name/delegate">delegate</a> when finished.</p>
    2591. 

  2591. 

  2592. <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/>
    2593. 

  2593. If the timeout value is negative, the write operation will not use a timeout.</p>
    2594. 

  2594. 	</div>
    2595. 

  2595. 	
    2596. 

  2596. 	
    2597. 

  2597. 	
    2598. 

  2598. 	
    2599. 

  2599. 	
    2600. 

  2600. 	
    2601. 

  2601. 	
    2602. 

  2602. 	<div class="method-subsection declared-in-section">
    2603. 

  2603. 		<h4 class="method-subtitle">Declared In</h4>
    2604. 

  2604. 		<code class="declared-in-ref">AsyncSocket.h</code><br />
    2605. 

  2605. 	</div>				
    2606. 

  2606. 	
    2607. 

  2607. 	
    2608. 

  2608. </div>
    2609. 

  2609. 						
    2610. 

  2610. 					</div>
    2611. 

  2611. 					
    2612. 

  2612. 					
    2613. 

  2613. 				</div>
    2614. 

  2614. 				<div class="main-navigation navigation-bottom">
    2615. 

  2615. 					<ul>
    2616. 

  2616. 	<li><a href="../index.html">Index</a></li>
    2617. 

  2617. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    2618. 

  2618. </ul>
    2619. 

  2619. 				</div>
    2620. 

  2620. 				<div id="footer">
    2621. 

  2621. 					<hr />
    2622. 

  2622. 					<div class="footer-copyright">
    2623. 

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

  2624. 						
    2625. 

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

  2626. 						
    2627. 

  2627. 					</div>
    2628. 

  2628. 				</div>
    2629. 

  2629. 			</div>
    2630. 

  2630. 		</article>
    2631. 

  2631. 		<script type="text/javascript">
    2632. 

  2632. 			function jumpToChange()
    2633. 

  2633. 			{
    2634. 

  2634. 				window.location.hash = this.options[this.selectedIndex].value;
    2635. 

  2635. 			}
    2636. 

  2636. 			
    2637. 

  2637. 			function toggleTOC()
    2638. 

  2638. 			{
    2639. 

  2639. 				var contents = document.getElementById('contents');
    2640. 

  2640. 				var tocContainer = document.getElementById('tocContainer');
    2641. 

  2641. 				
    2642. 

  2642. 				if (this.getAttribute('class') == 'open')
    2643. 

  2643. 				{
    2644. 

  2644. 					this.setAttribute('class', '');
    2645. 

  2645. 					contents.setAttribute('class', '');
    2646. 

  2646. 					tocContainer.setAttribute('class', '');
    2647. 

  2647. 					
    2648. 

  2648. 					window.name = "hideTOC";
    2649. 

  2649. 				}
    2650. 

  2650. 				else
    2651. 

  2651. 				{
    2652. 

  2652. 					this.setAttribute('class', 'open');
    2653. 

  2653. 					contents.setAttribute('class', 'isShowingTOC');
    2654. 

  2654. 					tocContainer.setAttribute('class', 'isShowingTOC');
    2655. 

  2655. 					
    2656. 

  2656. 					window.name = "";
    2657. 

  2657. 				}
    2658. 

  2658. 				return false;
    2659. 

  2659. 			}
    2660. 

  2660. 			
    2661. 

  2661. 			function toggleTOCEntryChildren(e)
    2662. 

  2662. 			{
    2663. 

  2663. 				e.stopPropagation();
    2664. 

  2664. 				var currentClass = this.getAttribute('class');
    2665. 

  2665. 				if (currentClass == 'children') {
    2666. 

  2666. 					this.setAttribute('class', 'children open');
    2667. 

  2667. 				}
    2668. 

  2668. 				else if (currentClass == 'children open') {
    2669. 

  2669. 					this.setAttribute('class', 'children');
    2670. 

  2670. 				}
    2671. 

  2671. 				return false;
    2672. 

  2672. 			}
    2673. 

  2673. 			
    2674. 

  2674. 			function tocEntryClick(e)
    2675. 

  2675. 			{
    2676. 

  2676. 				e.stopPropagation();
    2677. 

  2677. 				return true;
    2678. 

  2678. 			}
    2679. 

  2679. 			
    2680. 

  2680. 			function init()
    2681. 

  2681. 			{
    2682. 

  2682. 				var selectElement = document.getElementById('jumpTo');
    2683. 

  2683. 				selectElement.addEventListener('change', jumpToChange, false);
    2684. 

  2684. 				
    2685. 

  2685. 				var tocButton = document.getElementById('table_of_contents');
    2686. 

  2686. 				tocButton.addEventListener('click', toggleTOC, false);
    2687. 

  2687. 				
    2688. 

  2688. 				var taskTreeItem = document.getElementById('task_treeitem');
    2689. 

  2689. 				if (taskTreeItem.getElementsByTagName('li').length > 0)
    2690. 

  2690. 				{
    2691. 

  2691. 					taskTreeItem.setAttribute('class', 'children');
    2692. 

  2692. 					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
    2693. 

  2693. 				}
    2694. 

  2694. 				
    2695. 

  2695. 				var tocList = document.getElementById('toc');
    2696. 

  2696. 				
    2697. 

  2697. 				var tocEntries = tocList.getElementsByTagName('li');
    2698. 

  2698. 				for (var i = 0; i < tocEntries.length; i++) {
    2699. 

  2699. 					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
    2700. 

  2700. 				}
    2701. 

  2701. 				
    2702. 

  2702. 				var tocLinks = tocList.getElementsByTagName('a');
    2703. 

  2703. 				for (var i = 0; i < tocLinks.length; i++) {
    2704. 

  2704. 					tocLinks[i].addEventListener('click', tocEntryClick, false);
    2705. 

  2705. 				}
    2706. 

  2706. 				
    2707. 

  2707. 				if (window.name == "hideTOC") {
    2708. 

  2708. 					toggleTOC.call(tocButton);
    2709. 

  2709. 				}
    2710. 

  2710. 			}
    2711. 

  2711. 			
    2712. 

  2712. 			window.onload = init;
    2713. 

  2713. 			
    2714. 

  2714. 			// If showing in Xcode, hide the TOC and Header
    2715. 

  2715. 			if (navigator.userAgent.match(/xcode/i)) {
    2716. 

  2716. 				document.getElementById("contents").className = "hideInXcode"
    2717. 

  2717. 				document.getElementById("tocContainer").className = "hideInXcode"
    2718. 

  2718. 				document.getElementById("top_header").className = "hideInXcode"
    2719. 

  2719. 			}
    2720. 

  2720. 			
    2721. 

  2721. 		</script>
    2722. 

  2722. 	</body>
    2723. 

  2723. </html>
    2724.