PageRenderTime 68ms CodeModel.GetById 16ms RepoModel.GetById 1ms app.codeStats 0ms

/Pods/Documentation/CocoaAsyncSocket/html/Classes/GCDAsyncUdpSocket.html

https://gitlab.com/mba811/tokaidoapp
HTML | 3584 lines | 1901 code | 1683 blank | 0 comment | 0 complexity | b3aefa7ecd4161218937f5aed8e5c737 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>GCDAsyncUdpSocket 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">GCDAsyncUdpSocket 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. 	<option value="overview">Overview</option>
    30. 

  30. 	
    31. 

  31. 	
    32. 

  32. 	
    33. 

  33. 	
    34. 

  34. 	<option value="tasks">Tasks</option>
    35. 

  35. 	
    36. 

  36. 	
    37. 

  37. 	
    38. 

  38. 	
    39. 

  39. 	
    40. 

  40. 	
    41. 

  41. 	
    42. 

  42. 	<option value="class_methods">Class Methods</option>
    43. 

  43. 	
    44. 

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

  45. 	
    46. 

  46. 	<option value="//api/name/getHost:port:family:fromAddress:">&nbsp;&nbsp;&nbsp;&nbsp;+ getHost:port:family:fromAddress:</option>
    47. 

  47. 	
    48. 

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

  49. 	
    50. 

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

  51. 	
    52. 

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

  53. 	
    54. 

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

  55. 	
    56. 

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

  57. 	
    58. 

  58. 	
    59. 

  59. 	
    60. 

  60. 	
    61. 

  61. 	<option value="instance_methods">Instance Methods</option>
    62. 

  62. 	
    63. 

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

  64. 	
    65. 

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

  66. 	
    67. 

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

  68. 	
    69. 

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

  70. 	
    71. 

  71. 	<option value="//api/name/close">&nbsp;&nbsp;&nbsp;&nbsp;- close</option>
    72. 

  72. 	
    73. 

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

  74. 	
    75. 

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

  76. 	
    77. 

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

  78. 	
    79. 

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

  80. 	
    81. 

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

  82. 	
    83. 

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

  84. 	
    85. 

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

  86. 	
    87. 

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

  88. 	
    89. 

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

  90. 	
    91. 

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

  92. 	
    93. 

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

  94. 	
    95. 

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

  96. 	
    97. 

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

  98. 	
    99. 

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

  100. 	
    101. 

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

  102. 	
    103. 

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

  104. 	
    105. 

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

  106. 	
    107. 

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

  108. 	
    109. 

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

  110. 	
    111. 

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

  112. 	
    113. 

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

  114. 	
    115. 

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

  116. 	
    117. 

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

  118. 	
    119. 

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

  120. 	
    121. 

  121. 	<option value="//api/name/joinMulticastGroup:onInterface:error:">&nbsp;&nbsp;&nbsp;&nbsp;- joinMulticastGroup:onInterface:error:</option>
    122. 

  122. 	
    123. 

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

  124. 	
    125. 

  125. 	<option value="//api/name/leaveMulticastGroup:onInterface:error:">&nbsp;&nbsp;&nbsp;&nbsp;- leaveMulticastGroup:onInterface:error:</option>
    126. 

  126. 	
    127. 

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

  128. 	
    129. 

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

  130. 	
    131. 

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

  132. 	
    133. 

  133. 	<option value="//api/name/localHost">&nbsp;&nbsp;&nbsp;&nbsp;- localHost</option>
    134. 

  134. 	
    135. 

  135. 	<option value="//api/name/localHost_IPv4">&nbsp;&nbsp;&nbsp;&nbsp;- localHost_IPv4</option>
    136. 

  136. 	
    137. 

  137. 	<option value="//api/name/localHost_IPv6">&nbsp;&nbsp;&nbsp;&nbsp;- localHost_IPv6</option>
    138. 

  138. 	
    139. 

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

  140. 	
    141. 

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

  142. 	
    143. 

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

  144. 	
    145. 

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

  146. 	
    147. 

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

  148. 	
    149. 

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

  150. 	
    151. 

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

  152. 	
    153. 

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

  154. 	
    155. 

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

  156. 	
    157. 

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

  158. 	
    159. 

  159. 	<option value="//api/name/sendData:toHost:port:withTimeout:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- sendData:toHost:port:withTimeout:tag:</option>
    160. 

  160. 	
    161. 

  161. 	<option value="//api/name/sendData:withTimeout:tag:">&nbsp;&nbsp;&nbsp;&nbsp;- sendData:withTimeout:tag:</option>
    162. 

  162. 	
    163. 

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

  164. 	
    165. 

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

  166. 	
    167. 

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

  168. 	
    169. 

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

  170. 	
    171. 

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

  172. 	
    173. 

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

  174. 	
    175. 

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

  176. 	
    177. 

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

  178. 	
    179. 

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

  180. 	
    181. 

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

  182. 	
    183. 

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

  184. 	
    185. 

  185. 	<option value="//api/name/setReceiveFilter:withQueue:isAsynchronous:">&nbsp;&nbsp;&nbsp;&nbsp;- setReceiveFilter:withQueue:isAsynchronous:</option>
    186. 

  186. 	
    187. 

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

  188. 	
    189. 

  189. 	<option value="//api/name/setSendFilter:withQueue:isAsynchronous:">&nbsp;&nbsp;&nbsp;&nbsp;- setSendFilter:withQueue:isAsynchronous:</option>
    190. 

  190. 	
    191. 

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

  192. 	
    193. 

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

  194. 	
    195. 

  195. 	<option value="//api/name/socket6FD">&nbsp;&nbsp;&nbsp;&nbsp;- socket6FD</option>
    196. 

  196. 	
    197. 

  197. 	<option value="//api/name/socketFD">&nbsp;&nbsp;&nbsp;&nbsp;- socketFD</option>
    198. 

  198. 	
    199. 

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

  200. 	
    201. 

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

  202. 	
    203. 

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

  204. 	
    205. 

  205. 	<option value="//api/name/userData">&nbsp;&nbsp;&nbsp;&nbsp;- userData</option>
    206. 

  206. 	
    207. 

  207. 	<option value="//api/name/writeStream">&nbsp;&nbsp;&nbsp;&nbsp;- writeStream</option>
    208. 

  208. 	
    209. 

  209. 	
    210. 

  210. 	
    211. 

  211. </select>
    212. 

  212. 				</li>
    213. 

  213. 			</ul>
    214. 

  214. 		</header>
    215. 

  215. 		<nav id="tocContainer" class="isShowingTOC">
    216. 

  216. 			<ul id="toc" role="tree">
    217. 

  217. 				
    218. 

  218. <li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
    219. 

  219. 

  220. 

  221. 

  222. 

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

  224. 	
    225. 

  225. </ul></li>
    226. 

  226. 

  227. 

  228. 

  229. 

  230. 

  231. 

  232. 

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

  234. 	
    235. 

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

  236. 	
    237. 

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

  238. 	
    239. 

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

  240. 	
    241. 

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

  242. 	
    243. 

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

  244. 	
    245. 

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

  246. 	
    247. 

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

  248. 	
    249. 

  249. </ul></li>
    250. 

  250. 

  251. 

  252. 

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

  254. 	
    255. 

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

  256. 	
    257. 

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

  258. 	
    259. 

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

  260. 	
    261. 

  261. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/bindToPort:interface:error:">bindToPort:interface:error:</a></span></li>
    262. 

  262. 	
    263. 

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

  264. 	
    265. 

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

  266. 	
    267. 

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

  268. 	
    269. 

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

  270. 	
    271. 

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

  272. 	
    273. 

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

  274. 	
    275. 

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

  276. 	
    277. 

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

  278. 	
    279. 

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

  280. 	
    281. 

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

  282. 	
    283. 

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

  284. 	
    285. 

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

  286. 	
    287. 

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

  288. 	
    289. 

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

  290. 	
    291. 

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

  292. 	
    293. 

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

  294. 	
    295. 

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

  296. 	
    297. 

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

  298. 	
    299. 

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

  300. 	
    301. 

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

  302. 	
    303. 

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

  304. 	
    305. 

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

  306. 	
    307. 

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

  308. 	
    309. 

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

  310. 	
    311. 

  311. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/joinMulticastGroup:error:">joinMulticastGroup:error:</a></span></li>
    312. 

  312. 	
    313. 

  313. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/joinMulticastGroup:onInterface:error:">joinMulticastGroup:onInterface:error:</a></span></li>
    314. 

  314. 	
    315. 

  315. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/leaveMulticastGroup:error:">leaveMulticastGroup:error:</a></span></li>
    316. 

  316. 	
    317. 

  317. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/leaveMulticastGroup:onInterface:error:">leaveMulticastGroup:onInterface:error:</a></span></li>
    318. 

  318. 	
    319. 

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

  320. 	
    321. 

  321. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/localAddress_IPv4">localAddress_IPv4</a></span></li>
    322. 

  322. 	
    323. 

  323. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/localAddress_IPv6">localAddress_IPv6</a></span></li>
    324. 

  324. 	
    325. 

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

  326. 	
    327. 

  327. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/localHost_IPv4">localHost_IPv4</a></span></li>
    328. 

  328. 	
    329. 

  329. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/localHost_IPv6">localHost_IPv6</a></span></li>
    330. 

  330. 	
    331. 

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

  332. 	
    333. 

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

  334. 	
    335. 

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

  336. 	
    337. 

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

  338. 	
    339. 

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

  340. 	
    341. 

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

  342. 	
    343. 

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

  344. 	
    345. 

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

  346. 	
    347. 

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

  348. 	
    349. 

  349. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sendData:toAddress:withTimeout:tag:">sendData:toAddress:withTimeout:tag:</a></span></li>
    350. 

  350. 	
    351. 

  351. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sendData:toHost:port:withTimeout:tag:">sendData:toHost:port:withTimeout:tag:</a></span></li>
    352. 

  352. 	
    353. 

  353. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sendData:withTimeout:tag:">sendData:withTimeout:tag:</a></span></li>
    354. 

  354. 	
    355. 

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

  356. 	
    357. 

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

  358. 	
    359. 

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

  360. 	
    361. 

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

  362. 	
    363. 

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

  364. 	
    365. 

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

  366. 	
    367. 

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

  368. 	
    369. 

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

  370. 	
    371. 

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

  372. 	
    373. 

  373. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setPreferIPv6">setPreferIPv6</a></span></li>
    374. 

  374. 	
    375. 

  375. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setReceiveFilter:withQueue:">setReceiveFilter:withQueue:</a></span></li>
    376. 

  376. 	
    377. 

  377. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setReceiveFilter:withQueue:isAsynchronous:">setReceiveFilter:withQueue:isAsynchronous:</a></span></li>
    378. 

  378. 	
    379. 

  379. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setSendFilter:withQueue:">setSendFilter:withQueue:</a></span></li>
    380. 

  380. 	
    381. 

  381. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setSendFilter:withQueue:isAsynchronous:">setSendFilter:withQueue:isAsynchronous:</a></span></li>
    382. 

  382. 	
    383. 

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

  384. 	
    385. 

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

  386. 	
    387. 

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

  388. 	
    389. 

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

  390. 	
    391. 

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

  392. 	
    393. 

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

  394. 	
    395. 

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

  396. 	
    397. 

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

  398. 	
    399. 

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

  400. 	
    401. 

  401. </ul></li>
    402. 

  402. 

  403. 

  404. 			</ul>
    405. 

  405. 		</nav>
    406. 

  406. 		<article>
    407. 

  407. 			<div id="contents" class="isShowingTOC" role="main">
    408. 

  408. 				<a title="GCDAsyncUdpSocket Class Reference" name="top"></a>
    409. 

  409. 				<div class="main-navigation navigation-top">
    410. 

  410. 					<ul>
    411. 

  411. 	<li><a href="../index.html">Index</a></li>
    412. 

  412. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    413. 

  413. </ul>
    414. 

  414. 				</div>
    415. 

  415. 				<div id="header">
    416. 

  416. 					<div class="section-header">
    417. 

  417. 						<h1 class="title title-header">GCDAsyncUdpSocket Class Reference</h1>
    418. 

  418. 					</div>		
    419. 

  419. 				</div>
    420. 

  420. 				<div id="container">	
    421. 

  421. 					
    422. 

  422. 					<div class="section section-specification"><table cellspacing="0"><tbody>
    423. 

  423. 						<tr>
    424. 

  424. 	<td class="specification-title">Inherits from</td>
    425. 

  425. 	<td class="specification-value">NSObject</td>
    426. 

  426. </tr><tr>
    427. 

  427. 	<td class="specification-title">Declared in</td>
    428. 

  428. 	<td class="specification-value">GCDAsyncUdpSocket.h</td>
    429. 

  429. </tr>
    430. 

  430. 						</tbody></table></div>
    431. 

  431. 					
    432. 

  432. 					
    433. 

  433. 					
    434. 

  434. 					
    435. 

  435. 					<div class="section section-overview">
    436. 

  436. 						<a title="Overview" name="overview"></a>
    437. 

  437. 						<h2 class="subtitle subtitle-overview">Overview</h2>
    438. 

  438. 						<p>You may optionally set a send filter for the socket.<br/>
    439. 

  439. A filter can provide several interesting possibilities:</p>
    440. 

  440. 

  441. <ol>
    442. 

  442. <li><p>Optional caching of resolved addresses for domain names.<br/>
    443. 

  443. The cache could later be consulted, resulting in fewer system calls to getaddrinfo.</p></li>
    444. 

  444. <li><p>Reusable modules of code for bandwidth monitoring.</p></li>
    445. 

  445. <li><p>Sometimes traffic shapers are needed to simulate real world environments.<br/>
    446. 

  446. A filter allows you to write custom code to simulate such environments.<br/>
    447. 

  447. The ability to code this yourself is especially helpful when your simulated environment<br/>
    448. 

  448. is more complicated than simple traffic shaping (e.g. simulating a cone port restricted router),<br/>
    449. 

  449. or the system tools to handle this aren&rsquo;t available (e.g. on a mobile device).</p></li>
    450. 

  450. </ol>
    451. 

  451. 

  452. 					</div>
    453. 

  453. 					
    454. 

  454. 					
    455. 

  455. 					
    456. 

  456. 					
    457. 

  457. 					
    458. 

  458. 					<div class="section section-tasks">
    459. 

  459. 						<a title="Tasks" name="tasks"></a>
    460. 

  460. 						<h2 class="subtitle subtitle-tasks">Tasks</h2>
    461. 

  461. 						
    462. 

  462. 						
    463. 

  463. 						
    464. 

  464. 						
    465. 

  465. 

  466. 						<ul class="task-list">
    467. 

  467. 							<li>
    468. 

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

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

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

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

  472. This allows for maximum concurrency, while at the same time providing easy thread safety.</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/initWithSocketQueue:">&ndash;&nbsp;initWithSocketQueue:</a></code>
    479. 

  479. 		
    480. 

  480. 	</span>
    481. 

  481. 	
    482. 

  482. 	
    483. 

  483. </li><li>
    484. 

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

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

  486. 		
    487. 

  487. 	</span>
    488. 

  488. 	
    489. 

  489. 	
    490. 

  490. </li><li>
    491. 

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

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

  493. 		
    494. 

  494. 	</span>
    495. 

  495. 	
    496. 

  496. 	
    497. 

  497. </li><li>
    498. 

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

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

  500. 		
    501. 

  501. 	</span>
    502. 

  502. 	
    503. 

  503. 	
    504. 

  504. </li><li>
    505. 

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

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

  507. 		
    508. 

  508. 	</span>
    509. 

  509. 	
    510. 

  510. 	
    511. 

  511. </li><li>
    512. 

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

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

  514. 		
    515. 

  515. 	</span>
    516. 

  516. 	
    517. 

  517. 	
    518. 

  518. </li><li>
    519. 

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

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

  521. 		
    522. 

  522. 	</span>
    523. 

  523. 	
    524. 

  524. 	
    525. 

  525. </li><li>
    526. 

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

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

  528. 		
    529. 

  529. 	</span>
    530. 

  530. 	
    531. 

  531. 	
    532. 

  532. </li><li>
    533. 

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

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

  535. 		
    536. 

  536. 	</span>
    537. 

  537. 	
    538. 

  538. 	
    539. 

  539. </li><li>
    540. 

  540. 	<span class="tooltip">
    541. 

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

  542. 		
    543. 

  543. 	</span>
    544. 

  544. 	
    545. 

  545. 	
    546. 

  546. </li><li>
    547. 

  547. 	<span class="tooltip">
    548. 

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

  549. 		
    550. 

  550. 	</span>
    551. 

  551. 	
    552. 

  552. 	
    553. 

  553. </li><li>
    554. 

  554. 	<span class="tooltip">
    555. 

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

  556. 		
    557. 

  557. 	</span>
    558. 

  558. 	
    559. 

  559. 	
    560. 

  560. </li><li>
    561. 

  561. 	<span class="tooltip">
    562. 

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

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

  564. 	</span>
    565. 

  565. 	
    566. 

  566. 	
    567. 

  567. </li><li>
    568. 

  568. 	<span class="tooltip">
    569. 

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

  570. 		
    571. 

  571. 	</span>
    572. 

  572. 	
    573. 

  573. 	
    574. 

  574. </li><li>
    575. 

  575. 	<span class="tooltip">
    576. 

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

  577. 		
    578. 

  578. 	</span>
    579. 

  579. 	
    580. 

  580. 	
    581. 

  581. </li><li>
    582. 

  582. 	<span class="tooltip">
    583. 

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

  584. 		
    585. 

  585. 	</span>
    586. 

  586. 	
    587. 

  587. 	
    588. 

  588. </li><li>
    589. 

  589. 	<span class="tooltip">
    590. 

  590. 		<code><a href="#//api/name/isIPv4Preferred">&ndash;&nbsp;isIPv4Preferred</a></code>
    591. 

  591. 		
    592. 

  592. 	</span>
    593. 

  593. 	
    594. 

  594. 	
    595. 

  595. </li><li>
    596. 

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

  597. 		<code><a href="#//api/name/isIPv6Preferred">&ndash;&nbsp;isIPv6Preferred</a></code>
    598. 

  598. 		
    599. 

  599. 	</span>
    600. 

  600. 	
    601. 

  601. 	
    602. 

  602. </li><li>
    603. 

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

  604. 		<code><a href="#//api/name/isIPVersionNeutral">&ndash;&nbsp;isIPVersionNeutral</a></code>
    605. 

  605. 		
    606. 

  606. 	</span>
    607. 

  607. 	
    608. 

  608. 	
    609. 

  609. </li><li>
    610. 

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

  611. 		<code><a href="#//api/name/setPreferIPv4">&ndash;&nbsp;setPreferIPv4</a></code>
    612. 

  612. 		
    613. 

  613. 	</span>
    614. 

  614. 	
    615. 

  615. 	
    616. 

  616. </li><li>
    617. 

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

  618. 		<code><a href="#//api/name/setPreferIPv6">&ndash;&nbsp;setPreferIPv6</a></code>
    619. 

  619. 		
    620. 

  620. 	</span>
    621. 

  621. 	
    622. 

  622. 	
    623. 

  623. </li><li>
    624. 

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

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

  626. 		
    627. 

  627. 	</span>
    628. 

  628. 	
    629. 

  629. 	
    630. 

  630. </li><li>
    631. 

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

  632. 		<code><a href="#//api/name/maxReceiveIPv4BufferSize">&ndash;&nbsp;maxReceiveIPv4BufferSize</a></code>
    633. 

  633. 		<span class="tooltip"><p>Gets/Sets the maximum size of the buffer that will be allocated for receive operations.<br/>
    634. 

  634. The default maximum size is 9216 bytes.</p></span>
    635. 

  635. 	</span>
    636. 

  636. 	
    637. 

  637. 	
    638. 

  638. </li><li>
    639. 

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

  640. 		<code><a href="#//api/name/setMaxReceiveIPv4BufferSize:">&ndash;&nbsp;setMaxReceiveIPv4BufferSize:</a></code>
    641. 

  641. 		
    642. 

  642. 	</span>
    643. 

  643. 	
    644. 

  644. 	
    645. 

  645. </li><li>
    646. 

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

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

  648. 		
    649. 

  649. 	</span>
    650. 

  650. 	
    651. 

  651. 	
    652. 

  652. </li><li>
    653. 

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

  654. 		<code><a href="#//api/name/setMaxReceiveIPv6BufferSize:">&ndash;&nbsp;setMaxReceiveIPv6BufferSize:</a></code>
    655. 

  655. 		
    656. 

  656. 	</span>
    657. 

  657. 	
    658. 

  658. 	
    659. 

  659. </li><li>
    660. 

  660. 	<span class="tooltip">
    661. 

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

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

  663. This data is not used internally in any way.</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/setUserData:">&ndash;&nbsp;setUserData:</a></code>
    670. 

  670. 		
    671. 

  671. 	</span>
    672. 

  672. 	
    673. 

  673. 	
    674. 

  674. </li><li>
    675. 

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

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

  677. 		<span class="tooltip"><p>Returns the local address info for the socket.</p></span>
    678. 

  678. 	</span>
    679. 

  679. 	
    680. 

  680. 	
    681. 

  681. </li><li>
    682. 

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

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

  684. 		
    685. 

  685. 	</span>
    686. 

  686. 	
    687. 

  687. 	
    688. 

  688. </li><li>
    689. 

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

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

  691. 		
    692. 

  692. 	</span>
    693. 

  693. 	
    694. 

  694. 	
    695. 

  695. </li><li>
    696. 

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

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

  698. 		
    699. 

  699. 	</span>
    700. 

  700. 	
    701. 

  701. 	
    702. 

  702. </li><li>
    703. 

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

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

  705. 		
    706. 

  706. 	</span>
    707. 

  707. 	
    708. 

  708. 	
    709. 

  709. </li><li>
    710. 

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

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

  712. 		
    713. 

  713. 	</span>
    714. 

  714. 	
    715. 

  715. 	
    716. 

  716. </li><li>
    717. 

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

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

  719. 		
    720. 

  720. 	</span>
    721. 

  721. 	
    722. 

  722. 	
    723. 

  723. </li><li>
    724. 

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

  725. 		<code><a href="#//api/name/localHost_IPv6">&ndash;&nbsp;localHost_IPv6</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/localPort_IPv6">&ndash;&nbsp;localPort_IPv6</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/connectedAddress">&ndash;&nbsp;connectedAddress</a></code>
    740. 

  740. 		<span class="tooltip"><p>Returns the remote address info for the socket.</p></span>
    741. 

  741. 	</span>
    742. 

  742. 	
    743. 

  743. 	
    744. 

  744. </li><li>
    745. 

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

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

  747. 		
    748. 

  748. 	</span>
    749. 

  749. 	
    750. 

  750. 	
    751. 

  751. </li><li>
    752. 

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

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

  754. 		
    755. 

  755. 	</span>
    756. 

  756. 	
    757. 

  757. 	
    758. 

  758. </li><li>
    759. 

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

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

  761. 		<span class="tooltip"><p>Returns whether or not this socket has been connected to a single host.<br/>
    762. 

  762. By design, UDP is a connectionless protocol, and connecting is not needed.<br/>
    763. 

  763. If connected, the socket will only be able to send/receive data to/from the connected host.</p></span>
    764. 

  764. 	</span>
    765. 

  765. 	
    766. 

  766. 	
    767. 

  767. </li><li>
    768. 

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

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

  770. 		<span class="tooltip"><p>Returns whether or not this socket has been closed.<br/>
    771. 

  771. The only way a socket can be closed is if you explicitly call one of the <a href="#//api/name/close">close</a> methods.</p></span>
    772. 

  772. 	</span>
    773. 

  773. 	
    774. 

  774. 	
    775. 

  775. </li><li>
    776. 

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

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

  778. 		<span class="tooltip"><p>Returns whether or not this socket is IPv4.</p></span>
    779. 

  779. 	</span>
    780. 

  780. 	
    781. 

  781. 	
    782. 

  782. </li><li>
    783. 

  783. 	<span class="tooltip">
    784. 

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

  785. 		<span class="tooltip"><p>Returns whether or not this socket is IPv6.</p></span>
    786. 

  786. 	</span>
    787. 

  787. 	
    788. 

  788. 	
    789. 

  789. </li><li>
    790. 

  790. 	<span class="tooltip">
    791. 

  791. 		<code><a href="#//api/name/bindToPort:error:">&ndash;&nbsp;bindToPort:error:</a></code>
    792. 

  792. 		<span class="tooltip"><p>Binds the UDP socket to the given port.<br/>
    793. 

  793. Binding should be done for server sockets that receive data prior to sending it.<br/>
    794. 

  794. Client sockets can skip binding,<br/>
    795. 

  795. as the OS will automatically assign the socket an available port when it starts sending data.</p></span>
    796. 

  796. 	</span>
    797. 

  797. 	
    798. 

  798. 	
    799. 

  799. </li><li>
    800. 

  800. 	<span class="tooltip">
    801. 

  801. 		<code><a href="#//api/name/bindToPort:interface:error:">&ndash;&nbsp;bindToPort:interface:error:</a></code>
    802. 

  802. 		<span class="tooltip"><p>Binds the UDP socket to the given port and optional interface.<br/>
    803. 

  803. Binding should be done for server sockets that receive data prior to sending it.<br/>
    804. 

  804. Client sockets can skip binding,<br/>
    805. 

  805. as the OS will automatically assign the socket an available port when it starts sending data.</p></span>
    806. 

  806. 	</span>
    807. 

  807. 	
    808. 

  808. 	
    809. 

  809. </li><li>
    810. 

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

  811. 		<code><a href="#//api/name/bindToAddress:error:">&ndash;&nbsp;bindToAddress:error:</a></code>
    812. 

  812. 		<span class="tooltip"><p>Binds the UDP socket to the given address, specified as a sockaddr structure wrapped in a NSData object.</p></span>
    813. 

  813. 	</span>
    814. 

  814. 	
    815. 

  815. 	
    816. 

  816. </li><li>
    817. 

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

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

  819. 		<span class="tooltip"><p>Connects the UDP socket to the given host and port.<br/>
    820. 

  820. By design, UDP is a connectionless protocol, and connecting is not needed.</p></span>
    821. 

  821. 	</span>
    822. 

  822. 	
    823. 

  823. 	
    824. 

  824. </li><li>
    825. 

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

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

  827. 		<span class="tooltip"><p>Connects the UDP socket to the given address, specified as a sockaddr structure wrapped in a NSData object.</p></span>
    828. 

  828. 	</span>
    829. 

  829. 	
    830. 

  830. 	
    831. 

  831. </li><li>
    832. 

  832. 	<span class="tooltip">
    833. 

  833. 		<code><a href="#//api/name/joinMulticastGroup:error:">&ndash;&nbsp;joinMulticastGroup:error:</a></code>
    834. 

  834. 		<span class="tooltip"><p>Join multicast group.<br/>
    835. 

  835. Group should be an IP address (eg @&ldquo;225.228.0.1&rdquo;).</p></span>
    836. 

  836. 	</span>
    837. 

  837. 	
    838. 

  838. 	
    839. 

  839. </li><li>
    840. 

  840. 	<span class="tooltip">
    841. 

  841. 		<code><a href="#//api/name/joinMulticastGroup:onInterface:error:">&ndash;&nbsp;joinMulticastGroup:onInterface:error:</a></code>
    842. 

  842. 		<span class="tooltip"><p>Join multicast group.<br/>
    843. 

  843. Group should be an IP address (eg @&ldquo;225.228.0.1&rdquo;).<br/>
    844. 

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

  845. 	</span>
    846. 

  846. 	
    847. 

  847. 	
    848. 

  848. </li><li>
    849. 

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

  850. 		<code><a href="#//api/name/leaveMulticastGroup:error:">&ndash;&nbsp;leaveMulticastGroup:error:</a></code>
    851. 

  851. 		
    852. 

  852. 	</span>
    853. 

  853. 	
    854. 

  854. 	
    855. 

  855. </li><li>
    856. 

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

  857. 		<code><a href="#//api/name/leaveMulticastGroup:onInterface:error:">&ndash;&nbsp;leaveMulticastGroup:onInterface:error:</a></code>
    858. 

  858. 		
    859. 

  859. 	</span>
    860. 

  860. 	
    861. 

  861. 	
    862. 

  862. </li><li>
    863. 

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

  864. 		<code><a href="#//api/name/enableBroadcast:error:">&ndash;&nbsp;enableBroadcast:error:</a></code>
    865. 

  865. 		<span class="tooltip"><p>By default, the underlying socket in the OS will not allow you to send broadcast messages.<br/>
    866. 

  866. In order to send broadcast messages, you need to enable this functionality in the socket.</p></span>
    867. 

  867. 	</span>
    868. 

  868. 	
    869. 

  869. 	
    870. 

  870. </li><li>
    871. 

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

  872. 		<code><a href="#//api/name/sendData:withTimeout:tag:">&ndash;&nbsp;sendData:withTimeout:tag:</a></code>
    873. 

  873. 		<span class="tooltip"><p>Asynchronously sends the given data, with the given timeout and tag.</p></span>
    874. 

  874. 	</span>
    875. 

  875. 	
    876. 

  876. 	
    877. 

  877. </li><li>
    878. 

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

  879. 		<code><a href="#//api/name/sendData:toHost:port:withTimeout:tag:">&ndash;&nbsp;sendData:toHost:port:withTimeout:tag:</a></code>
    880. 

  880. 		<span class="tooltip"><p>Asynchronously sends the given data, with the given timeout and tag, to the given host and port.</p></span>
    881. 

  881. 	</span>
    882. 

  882. 	
    883. 

  883. 	
    884. 

  884. </li><li>
    885. 

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

  886. 		<code><a href="#//api/name/sendData:toAddress:withTimeout:tag:">&ndash;&nbsp;sendData:toAddress:withTimeout:tag:</a></code>
    887. 

  887. 		<span class="tooltip"><p>Asynchronously sends the given data, with the given timeout and tag, to the given address.</p></span>
    888. 

  888. 	</span>
    889. 

  889. 	
    890. 

  890. 	
    891. 

  891. </li><li>
    892. 

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

  893. 		<code><a href="#//api/name/setSendFilter:withQueue:">&ndash;&nbsp;setSendFilter:withQueue:</a></code>
    894. 

  894. 		<span class="tooltip"><p>You may optionally set a send filter for the socket.<br/>
    895. 

  895. A filter can provide several interesting possibilities:</p></span>
    896. 

  896. 	</span>
    897. 

  897. 	
    898. 

  898. 	
    899. 

  899. </li><li>
    900. 

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

  901. 		<code><a href="#//api/name/setSendFilter:withQueue:isAsynchronous:">&ndash;&nbsp;setSendFilter:withQueue:isAsynchronous:</a></code>
    902. 

  902. 		<span class="tooltip"><p>The receive filter can be run via dispatch_async or dispatch_sync.<br/>
    903. 

  903. Most typical situations call for asynchronous operation.</p></span>
    904. 

  904. 	</span>
    905. 

  905. 	
    906. 

  906. 	
    907. 

  907. </li><li>
    908. 

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

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

  910. 		<span class="tooltip"><p>There are two modes of operation for receiving packets: one-at-a-time &amp; continuous.</p></span>
    911. 

  911. 	</span>
    912. 

  912. 	
    913. 

  913. 	
    914. 

  914. </li><li>
    915. 

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

  916. 		<code><a href="#//api/name/beginReceiving:">&ndash;&nbsp;beginReceiving:</a></code>
    917. 

  917. 		<span class="tooltip"><p>There are two modes of operation for receiving packets: one-at-a-time &amp; continuous.</p></span>
    918. 

  918. 	</span>
    919. 

  919. 	
    920. 

  920. 	
    921. 

  921. </li><li>
    922. 

  922. 	<span class="tooltip">
    923. 

  923. 		<code><a href="#//api/name/pauseReceiving">&ndash;&nbsp;pauseReceiving</a></code>
    924. 

  924. 		<span class="tooltip"><p>If the socket is currently receiving (beginReceiving has been called), this method pauses the receiving.<br/>
    925. 

  925. That is, it won&rsquo;t read any more packets from the underlying OS socket until beginReceiving is called again.</p></span>
    926. 

  926. 	</span>
    927. 

  927. 	
    928. 

  928. 	
    929. 

  929. </li><li>
    930. 

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

  931. 		<code><a href="#//api/name/setReceiveFilter:withQueue:">&ndash;&nbsp;setReceiveFilter:withQueue:</a></code>
    932. 

  932. 		<span class="tooltip"><p>You may optionally set a receive filter for the socket.<br/>
    933. 

  933. This receive filter may be set to run in its own queue (independent of <a href="#//api/name/delegate">delegate</a> queue).</p></span>
    934. 

  934. 	</span>
    935. 

  935. 	
    936. 

  936. 	
    937. 

  937. </li><li>
    938. 

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

  939. 		<code><a href="#//api/name/setReceiveFilter:withQueue:isAsynchronous:">&ndash;&nbsp;setReceiveFilter:withQueue:isAsynchronous:</a></code>
    940. 

  940. 		<span class="tooltip"><p>The receive filter can be run via dispatch_async or dispatch_sync.<br/>
    941. 

  941. Most typical situations call for asynchronous operation.</p></span>
    942. 

  942. 	</span>
    943. 

  943. 	
    944. 

  944. 	
    945. 

  945. </li><li>
    946. 

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

  947. 		<code><a href="#//api/name/close">&ndash;&nbsp;close</a></code>
    948. 

  948. 		<span class="tooltip"><p>Immediately closes the underlying socket.<br/>
    949. 

  949. Any pending send operations are discarded.</p></span>
    950. 

  950. 	</span>
    951. 

  951. 	
    952. 

  952. 	
    953. 

  953. </li><li>
    954. 

  954. 	<span class="tooltip">
    955. 

  955. 		<code><a href="#//api/name/closeAfterSending">&ndash;&nbsp;closeAfterSending</a></code>
    956. 

  956. 		<span class="tooltip"><p>Closes the underlying socket after all pending send operations have been sent.</p></span>
    957. 

  957. 	</span>
    958. 

  958. 	
    959. 

  959. 	
    960. 

  960. </li><li>
    961. 

  961. 	<span class="tooltip">
    962. 

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

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

  964. 	</span>
    965. 

  965. 	
    966. 

  966. 	
    967. 

  967. </li><li>
    968. 

  968. 	<span class="tooltip">
    969. 

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

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

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

  972. 	</span>
    973. 

  973. 	
    974. 

  974. 	
    975. 

  975. </li><li>
    976. 

  976. 	<span class="tooltip">
    977. 

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

  978. 		
    979. 

  979. 	</span>
    980. 

  980. 	
    981. 

  981. 	
    982. 

  982. </li><li>
    983. 

  983. 	<span class="tooltip">
    984. 

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

  985. 		
    986. 

  986. 	</span>
    987. 

  987. 	
    988. 

  988. 	
    989. 

  989. </li><li>
    990. 

  990. 	<span class="tooltip">
    991. 

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

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

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

  994. 	</span>
    995. 

  995. 	
    996. 

  996. 	
    997. 

  997. </li><li>
    998. 

  998. 	<span class="tooltip">
    999. 

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

  1000. 		
    1001. 

  1001. 	</span>
    1002. 

  1002. 	
    1003. 

  1003. 	
    1004. 

  1004. </li><li>
    1005. 

  1005. 	<span class="tooltip">
    1006. 

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

  1007. 		<span class="tooltip"><p>Extracting host/port/family information from raw address data.</p></span>
    1008. 

  1008. 	</span>
    1009. 

  1009. 	
    1010. 

  1010. 	
    1011. 

  1011. </li><li>
    1012. 

  1012. 	<span class="tooltip">
    1013. 

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

  1014. 		
    1015. 

  1015. 	</span>
    1016. 

  1016. 	
    1017. 

  1017. 	
    1018. 

  1018. </li><li>
    1019. 

  1019. 	<span class="tooltip">
    1020. 

  1020. 		<code><a href="#//api/name/familyFromAddress:">+&nbsp;familyFromAddress:</a></code>
    1021. 

  1021. 		
    1022. 

  1022. 	</span>
    1023. 

  1023. 	
    1024. 

  1024. 	
    1025. 

  1025. </li><li>
    1026. 

  1026. 	<span class="tooltip">
    1027. 

  1027. 		<code><a href="#//api/name/isIPv4Address:">+&nbsp;isIPv4Address:</a></code>
    1028. 

  1028. 		
    1029. 

  1029. 	</span>
    1030. 

  1030. 	
    1031. 

  1031. 	
    1032. 

  1032. </li><li>
    1033. 

  1033. 	<span class="tooltip">
    1034. 

  1034. 		<code><a href="#//api/name/isIPv6Address:">+&nbsp;isIPv6Address:</a></code>
    1035. 

  1035. 		
    1036. 

  1036. 	</span>
    1037. 

  1037. 	
    1038. 

  1038. 	
    1039. 

  1039. </li><li>
    1040. 

  1040. 	<span class="tooltip">
    1041. 

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

  1042. 		
    1043. 

  1043. 	</span>
    1044. 

  1044. 	
    1045. 

  1045. 	
    1046. 

  1046. </li><li>
    1047. 

  1047. 	<span class="tooltip">
    1048. 

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

  1049. 		
    1050. 

  1050. 	</span>
    1051. 

  1051. 	
    1052. 

  1052. 	
    1053. 

  1053. </li>
    1054. 

  1054. 						</ul>
    1055. 

  1055. 						
    1056. 

  1056. 					</div>
    1057. 

  1057. 					
    1058. 

  1058. 					
    1059. 

  1059. 					
    1060. 

  1060. 					
    1061. 

  1061. 					
    1062. 

  1062. 					
    1063. 

  1063. 					
    1064. 

  1064. 					<div class="section section-methods">
    1065. 

  1065. 						<a title="Class Methods" name="class_methods"></a>
    1066. 

  1066. 						<h2 class="subtitle subtitle-methods">Class Methods</h2>
    1067. 

  1067. 						
    1068. 

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

  1069. 	<a name="//api/name/familyFromAddress:" title="familyFromAddress:"></a>
    1070. 

  1070. 	<h3 class="subsubtitle method-title">familyFromAddress:</h3>
    1071. 

  1071. 	
    1072. 

  1072. 	
    1073. 

  1073. 

  1074. 	<div class="method-subsection method-declaration"><code>+ (int)familyFromAddress:(NSData *)<em>address</em></code></div>
    1075. 

  1075. 

  1076.     
    1077. 

  1077. </div>
    1078. 

  1078. 						
    1079. 

  1079. 						<div class="section-method">
    1080. 

  1080. 	<a name="//api/name/getHost:port:family:fromAddress:" title="getHost:port:family:fromAddress:"></a>
    1081. 

  1081. 	<h3 class="subsubtitle method-title">getHost:port:family:fromAddress:</h3>
    1082. 

  1082. 	
    1083. 

  1083. 	
    1084. 

  1084. 

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

  1086. 

  1087.     
    1088. 

  1088. </div>
    1089. 

  1089. 						
    1090. 

  1090. 						<div class="section-method">
    1091. 

  1091. 	<a name="//api/name/getHost:port:fromAddress:" title="getHost:port:fromAddress:"></a>
    1092. 

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

  1093. 	
    1094. 

  1094. 	
    1095. 

  1095. 

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

  1097. 

  1098.     
    1099. 

  1099. </div>
    1100. 

  1100. 						
    1101. 

  1101. 						<div class="section-method">
    1102. 

  1102. 	<a name="//api/name/hostFromAddress:" title="hostFromAddress:"></a>
    1103. 

  1103. 	<h3 class="subsubtitle method-title">hostFromAddress:</h3>
    1104. 

  1104. 	
    1105. 

  1105. 	
    1106. 

  1106. 	
    1107. 

  1107. 	<div class="method-subsection brief-description">
    1108. 

  1108. 		<p>Extracting host/port/family information from raw address data.</p>
    1109. 

  1109. 	</div>		
    1110. 

  1110. 	
    1111. 

  1111.     
    1112. 

  1112. 

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

  1114. 

  1115.     
    1116. 

  1116. 	
    1117. 

  1117. 	
    1118. 

  1118. 	
    1119. 

  1119. 	
    1120. 

  1120. 	
    1121. 

  1121. 	
    1122. 

  1122. 	
    1123. 

  1123. 	<div class="method-subsection discussion-section">
    1124. 

  1124. 		<h4 class="method-subtitle">Discussion</h4>
    1125. 

  1125. 		<p>Extracting host/port/family information from raw address data.</p>
    1126. 

  1126. 	</div>
    1127. 

  1127. 	
    1128. 

  1128. 	
    1129. 

  1129. 	
    1130. 

  1130. 	
    1131. 

  1131. 	
    1132. 

  1132. 	
    1133. 

  1133. 	
    1134. 

  1134. 	<div class="method-subsection declared-in-section">
    1135. 

  1135. 		<h4 class="method-subtitle">Declared In</h4>
    1136. 

  1136. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1137. 

  1137. 	</div>				
    1138. 

  1138. 	
    1139. 

  1139. 	
    1140. 

  1140. </div>
    1141. 

  1141. 						
    1142. 

  1142. 						<div class="section-method">
    1143. 

  1143. 	<a name="//api/name/isIPv4Address:" title="isIPv4Address:"></a>
    1144. 

  1144. 	<h3 class="subsubtitle method-title">isIPv4Address:</h3>
    1145. 

  1145. 	
    1146. 

  1146. 	
    1147. 

  1147. 

  1148. 	<div class="method-subsection method-declaration"><code>+ (BOOL)isIPv4Address:(NSData *)<em>address</em></code></div>
    1149. 

  1149. 

  1150.     
    1151. 

  1151. </div>
    1152. 

  1152. 						
    1153. 

  1153. 						<div class="section-method">
    1154. 

  1154. 	<a name="//api/name/isIPv6Address:" title="isIPv6Address:"></a>
    1155. 

  1155. 	<h3 class="subsubtitle method-title">isIPv6Address:</h3>
    1156. 

  1156. 	
    1157. 

  1157. 	
    1158. 

  1158. 

  1159. 	<div class="method-subsection method-declaration"><code>+ (BOOL)isIPv6Address:(NSData *)<em>address</em></code></div>
    1160. 

  1160. 

  1161.     
    1162. 

  1162. </div>
    1163. 

  1163. 						
    1164. 

  1164. 						<div class="section-method">
    1165. 

  1165. 	<a name="//api/name/portFromAddress:" title="portFromAddress:"></a>
    1166. 

  1166. 	<h3 class="subsubtitle method-title">portFromAddress:</h3>
    1167. 

  1167. 	
    1168. 

  1168. 	
    1169. 

  1169. 

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

  1171. 

  1172.     
    1173. 

  1173. </div>
    1174. 

  1174. 						
    1175. 

  1175. 					</div>
    1176. 

  1176. 					
    1177. 

  1177. 					
    1178. 

  1178. 					
    1179. 

  1179. 					<div class="section section-methods">
    1180. 

  1180. 						<a title="Instance Methods" name="instance_methods"></a>
    1181. 

  1181. 						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
    1182. 

  1182. 						
    1183. 

  1183. 						<div class="section-method">
    1184. 

  1184. 	<a name="//api/name/beginReceiving:" title="beginReceiving:"></a>
    1185. 

  1185. 	<h3 class="subsubtitle method-title">beginReceiving:</h3>
    1186. 

  1186. 	
    1187. 

  1187. 	
    1188. 

  1188. 	
    1189. 

  1189. 	<div class="method-subsection brief-description">
    1190. 

  1190. 		<p>There are two modes of operation for receiving packets: one-at-a-time &amp; continuous.</p>
    1191. 

  1191. 	</div>		
    1192. 

  1192. 	
    1193. 

  1193.     
    1194. 

  1194. 

  1195. 	<div class="method-subsection method-declaration"><code>- (BOOL)beginReceiving:(NSError **)<em>errPtr</em></code></div>
    1196. 

  1196. 

  1197.     
    1198. 

  1198. 	
    1199. 

  1199. 	
    1200. 

  1200. 	
    1201. 

  1201. 	
    1202. 

  1202. 	
    1203. 

  1203. 	
    1204. 

  1204. 	
    1205. 

  1205. 	<div class="method-subsection discussion-section">
    1206. 

  1206. 		<h4 class="method-subtitle">Discussion</h4>
    1207. 

  1207. 		<p>There are two modes of operation for receiving packets: one-at-a-time &amp; continuous.</p>
    1208. 

  1208. 

  1209. <p>In one-at-a-time mode, you call receiveOnce everytime your <a href="#//api/name/delegate">delegate</a> is ready to process an incoming udp packet.<br/>
    1210. 

  1210. Receiving packets one-at-a-time may be better suited for implementing certain state machine code,<br/>
    1211. 

  1211. where your state machine may not always be ready to process incoming packets.</p>
    1212. 

  1212. 

  1213. <p>In continuous mode, the <a href="#//api/name/delegate">delegate</a> is invoked immediately everytime incoming udp packets are received.<br/>
    1214. 

  1214. Receiving packets continuously is better suited to real-time streaming applications.</p>
    1215. 

  1215. 

  1216. <p>You may switch back and forth between one-at-a-time mode and continuous mode.<br/>
    1217. 

  1217. If the socket is currently in one-at-a-time mode, calling this method will switch it to continuous mode.</p>
    1218. 

  1218. 

  1219. <p>For every received packet (not filtered by the optional receive filter),<br/>
    1220. 

  1220. the <a href="#//api/name/delegate">delegate</a> method (udpSocket:didReceiveData:fromAddress:withFilterContext:) is invoked.</p>
    1221. 

  1221. 

  1222. <p>If the socket is able to begin receiving packets, this method returns YES.<br/>
    1223. 

  1223. Otherwise it returns NO, and sets the errPtr with appropriate error information.</p>
    1224. 

  1224. 

  1225. <p>An example error:<br/>
    1226. 

  1226. You created a udp socket to act as a server, and immediately called receive.<br/>
    1227. 

  1227. You forgot to first bind the socket to a port number, and received a error with a message like:<br/>
    1228. 

  1228. &ldquo;Must bind socket before you can receive data.&rdquo;</p>
    1229. 

  1229. 	</div>
    1230. 

  1230. 	
    1231. 

  1231. 	
    1232. 

  1232. 	
    1233. 

  1233. 	
    1234. 

  1234. 	
    1235. 

  1235. 	
    1236. 

  1236. 	
    1237. 

  1237. 	<div class="method-subsection declared-in-section">
    1238. 

  1238. 		<h4 class="method-subtitle">Declared In</h4>
    1239. 

  1239. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1240. 

  1240. 	</div>				
    1241. 

  1241. 	
    1242. 

  1242. 	
    1243. 

  1243. </div>
    1244. 

  1244. 						
    1245. 

  1245. 						<div class="section-method">
    1246. 

  1246. 	<a name="//api/name/bindToAddress:error:" title="bindToAddress:error:"></a>
    1247. 

  1247. 	<h3 class="subsubtitle method-title">bindToAddress:error:</h3>
    1248. 

  1248. 	
    1249. 

  1249. 	
    1250. 

  1250. 	
    1251. 

  1251. 	<div class="method-subsection brief-description">
    1252. 

  1252. 		<p>Binds the UDP socket to the given address, specified as a sockaddr structure wrapped in a NSData object.</p>
    1253. 

  1253. 	</div>		
    1254. 

  1254. 	
    1255. 

  1255.     
    1256. 

  1256. 

  1257. 	<div class="method-subsection method-declaration"><code>- (BOOL)bindToAddress:(NSData *)<em>localAddr</em> error:(NSError **)<em>errPtr</em></code></div>
    1258. 

  1258. 

  1259.     
    1260. 

  1260. 	
    1261. 

  1261. 	
    1262. 

  1262. 	
    1263. 

  1263. 	
    1264. 

  1264. 	
    1265. 

  1265. 	
    1266. 

  1266. 	
    1267. 

  1267. 	<div class="method-subsection discussion-section">
    1268. 

  1268. 		<h4 class="method-subtitle">Discussion</h4>
    1269. 

  1269. 		<p>Binds the UDP socket to the given address, specified as a sockaddr structure wrapped in a NSData object.</p>
    1270. 

  1270. 

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

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

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

  1274. 

  1275. <p>Binding should be done for server sockets that receive data prior to sending it.<br/>
    1276. 

  1276. Client sockets can skip binding,<br/>
    1277. 

  1277. as the OS will automatically assign the socket an available port when it starts sending data.</p>
    1278. 

  1278. 

  1279. <p>You cannot bind a socket after its been connected.<br/>
    1280. 

  1280. You can only bind a socket once.<br/>
    1281. 

  1281. You can still connect a socket (if desired) after binding.</p>
    1282. 

  1282. 

  1283. <p>On success, returns YES.<br/>
    1284. 

  1284. Otherwise returns NO, and sets errPtr. If you don&rsquo;t care about the error, you can pass NULL for errPtr.</p>
    1285. 

  1285. 	</div>
    1286. 

  1286. 	
    1287. 

  1287. 	
    1288. 

  1288. 	
    1289. 

  1289. 	
    1290. 

  1290. 	
    1291. 

  1291. 	
    1292. 

  1292. 	
    1293. 

  1293. 	<div class="method-subsection declared-in-section">
    1294. 

  1294. 		<h4 class="method-subtitle">Declared In</h4>
    1295. 

  1295. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1296. 

  1296. 	</div>				
    1297. 

  1297. 	
    1298. 

  1298. 	
    1299. 

  1299. </div>
    1300. 

  1300. 						
    1301. 

  1301. 						<div class="section-method">
    1302. 

  1302. 	<a name="//api/name/bindToPort:error:" title="bindToPort:error:"></a>
    1303. 

  1303. 	<h3 class="subsubtitle method-title">bindToPort:error:</h3>
    1304. 

  1304. 	
    1305. 

  1305. 	
    1306. 

  1306. 	
    1307. 

  1307. 	<div class="method-subsection brief-description">
    1308. 

  1308. 		<p>Binds the UDP socket to the given port.<br/>
    1309. 

  1309. Binding should be done for server sockets that receive data prior to sending it.<br/>
    1310. 

  1310. Client sockets can skip binding,<br/>
    1311. 

  1311. as the OS will automatically assign the socket an available port when it starts sending data.</p>
    1312. 

  1312. 	</div>		
    1313. 

  1313. 	
    1314. 

  1314.     
    1315. 

  1315. 

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

  1317. 

  1318.     
    1319. 

  1319. 	
    1320. 

  1320. 	
    1321. 

  1321. 	
    1322. 

  1322. 	
    1323. 

  1323. 	
    1324. 

  1324. 	
    1325. 

  1325. 	
    1326. 

  1326. 	<div class="method-subsection discussion-section">
    1327. 

  1327. 		<h4 class="method-subtitle">Discussion</h4>
    1328. 

  1328. 		<p>Binds the UDP socket to the given port.<br/>
    1329. 

  1329. Binding should be done for server sockets that receive data prior to sending it.<br/>
    1330. 

  1330. Client sockets can skip binding,<br/>
    1331. 

  1331. as the OS will automatically assign the socket an available port when it starts sending data.</p>
    1332. 

  1332. 

  1333. <p>You may optionally pass a port number of zero to immediately bind the socket,<br/>
    1334. 

  1334. yet still allow the OS to automatically assign an available port.</p>
    1335. 

  1335. 

  1336. <p>You cannot bind a socket after its been connected.<br/>
    1337. 

  1337. You can only bind a socket once.<br/>
    1338. 

  1338. You can still connect a socket (if desired) after binding.</p>
    1339. 

  1339. 

  1340. <p>On success, returns YES.<br/>
    1341. 

  1341. Otherwise returns NO, and sets errPtr. If you don&rsquo;t care about the error, you can pass NULL for errPtr.</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">GCDAsyncUdpSocket.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/bindToPort:interface:error:" title="bindToPort:interface:error:"></a>
    1360. 

  1360. 	<h3 class="subsubtitle method-title">bindToPort:interface:error:</h3>
    1361. 

  1361. 	
    1362. 

  1362. 	
    1363. 

  1363. 	
    1364. 

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

  1365. 		<p>Binds the UDP socket to the given port and optional interface.<br/>
    1366. 

  1366. Binding should be done for server sockets that receive data prior to sending it.<br/>
    1367. 

  1367. Client sockets can skip binding,<br/>
    1368. 

  1368. as the OS will automatically assign the socket an available port when it starts sending data.</p>
    1369. 

  1369. 	</div>		
    1370. 

  1370. 	
    1371. 

  1371.     
    1372. 

  1372. 

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

  1374. 

  1375.     
    1376. 

  1376. 	
    1377. 

  1377. 	
    1378. 

  1378. 	
    1379. 

  1379. 	
    1380. 

  1380. 	
    1381. 

  1381. 	
    1382. 

  1382. 	
    1383. 

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

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

  1385. 		<p>Binds the UDP socket to the given port and optional interface.<br/>
    1386. 

  1386. Binding should be done for server sockets that receive data prior to sending it.<br/>
    1387. 

  1387. Client sockets can skip binding,<br/>
    1388. 

  1388. as the OS will automatically assign the socket an available port when it starts sending data.</p>
    1389. 

  1389. 

  1390. <p>You may optionally pass a port number of zero to immediately bind the socket,<br/>
    1391. 

  1391. yet still allow the OS to automatically assign an available port.</p>
    1392. 

  1392. 

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

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

  1395. the socket only accept packets from the local machine.</p>
    1396. 

  1396. 

  1397. <p>You cannot bind a socket after its been connected.<br/>
    1398. 

  1398. You can only bind a socket once.<br/>
    1399. 

  1399. You can still connect a socket (if desired) after binding.</p>
    1400. 

  1400. 

  1401. <p>On success, returns YES.<br/>
    1402. 

  1402. Otherwise returns NO, and sets errPtr. If you don&rsquo;t care about the error, you can pass NULL for errPtr.</p>
    1403. 

  1403. 	</div>
    1404. 

  1404. 	
    1405. 

  1405. 	
    1406. 

  1406. 	
    1407. 

  1407. 	
    1408. 

  1408. 	
    1409. 

  1409. 	
    1410. 

  1410. 	
    1411. 

  1411. 	<div class="method-subsection declared-in-section">
    1412. 

  1412. 		<h4 class="method-subtitle">Declared In</h4>
    1413. 

  1413. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1414. 

  1414. 	</div>				
    1415. 

  1415. 	
    1416. 

  1416. 	
    1417. 

  1417. </div>
    1418. 

  1418. 						
    1419. 

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

  1420. 	<a name="//api/name/close" title="close"></a>
    1421. 

  1421. 	<h3 class="subsubtitle method-title">close</h3>
    1422. 

  1422. 	
    1423. 

  1423. 	
    1424. 

  1424. 	
    1425. 

  1425. 	<div class="method-subsection brief-description">
    1426. 

  1426. 		<p>Immediately closes the underlying socket.<br/>
    1427. 

  1427. Any pending send operations are discarded.</p>
    1428. 

  1428. 	</div>		
    1429. 

  1429. 	
    1430. 

  1430.     
    1431. 

  1431. 

  1432. 	<div class="method-subsection method-declaration"><code>- (void)close</code></div>
    1433. 

  1433. 

  1434.     
    1435. 

  1435. 	
    1436. 

  1436. 	
    1437. 

  1437. 	
    1438. 

  1438. 	
    1439. 

  1439. 	
    1440. 

  1440. 	
    1441. 

  1441. 	
    1442. 

  1442. 	<div class="method-subsection discussion-section">
    1443. 

  1443. 		<h4 class="method-subtitle">Discussion</h4>
    1444. 

  1444. 		<p>Immediately closes the underlying socket.<br/>
    1445. 

  1445. Any pending send operations are discarded.</p>
    1446. 

  1446. 

  1447. <p>The GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> instance may optionally be used again.<br/>
    1448. 

  1448. (it will setup/configure/use another unnderlying BSD socket).</p>
    1449. 

  1449. 	</div>
    1450. 

  1450. 	
    1451. 

  1451. 	
    1452. 

  1452. 	
    1453. 

  1453. 	
    1454. 

  1454. 	
    1455. 

  1455. 	
    1456. 

  1456. 	
    1457. 

  1457. 	<div class="method-subsection declared-in-section">
    1458. 

  1458. 		<h4 class="method-subtitle">Declared In</h4>
    1459. 

  1459. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1460. 

  1460. 	</div>				
    1461. 

  1461. 	
    1462. 

  1462. 	
    1463. 

  1463. </div>
    1464. 

  1464. 						
    1465. 

  1465. 						<div class="section-method">
    1466. 

  1466. 	<a name="//api/name/closeAfterSending" title="closeAfterSending"></a>
    1467. 

  1467. 	<h3 class="subsubtitle method-title">closeAfterSending</h3>
    1468. 

  1468. 	
    1469. 

  1469. 	
    1470. 

  1470. 	
    1471. 

  1471. 	<div class="method-subsection brief-description">
    1472. 

  1472. 		<p>Closes the underlying socket after all pending send operations have been sent.</p>
    1473. 

  1473. 	</div>		
    1474. 

  1474. 	
    1475. 

  1475.     
    1476. 

  1476. 

  1477. 	<div class="method-subsection method-declaration"><code>- (void)closeAfterSending</code></div>
    1478. 

  1478. 

  1479.     
    1480. 

  1480. 	
    1481. 

  1481. 	
    1482. 

  1482. 	
    1483. 

  1483. 	
    1484. 

  1484. 	
    1485. 

  1485. 	
    1486. 

  1486. 	
    1487. 

  1487. 	<div class="method-subsection discussion-section">
    1488. 

  1488. 		<h4 class="method-subtitle">Discussion</h4>
    1489. 

  1489. 		<p>Closes the underlying socket after all pending send operations have been sent.</p>
    1490. 

  1490. 

  1491. <p>The GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> instance may optionally be used again.<br/>
    1492. 

  1492. (it will setup/configure/use another unnderlying BSD socket).</p>
    1493. 

  1493. 	</div>
    1494. 

  1494. 	
    1495. 

  1495. 	
    1496. 

  1496. 	
    1497. 

  1497. 	
    1498. 

  1498. 	
    1499. 

  1499. 	
    1500. 

  1500. 	
    1501. 

  1501. 	<div class="method-subsection declared-in-section">
    1502. 

  1502. 		<h4 class="method-subtitle">Declared In</h4>
    1503. 

  1503. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1504. 

  1504. 	</div>				
    1505. 

  1505. 	
    1506. 

  1506. 	
    1507. 

  1507. </div>
    1508. 

  1508. 						
    1509. 

  1509. 						<div class="section-method">
    1510. 

  1510. 	<a name="//api/name/connectToAddress:error:" title="connectToAddress:error:"></a>
    1511. 

  1511. 	<h3 class="subsubtitle method-title">connectToAddress:error:</h3>
    1512. 

  1512. 	
    1513. 

  1513. 	
    1514. 

  1514. 	
    1515. 

  1515. 	<div class="method-subsection brief-description">
    1516. 

  1516. 		<p>Connects the UDP socket to the given address, specified as a sockaddr structure wrapped in a NSData object.</p>
    1517. 

  1517. 	</div>		
    1518. 

  1518. 	
    1519. 

  1519.     
    1520. 

  1520. 

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

  1522. 

  1523.     
    1524. 

  1524. 	
    1525. 

  1525. 	
    1526. 

  1526. 	
    1527. 

  1527. 	
    1528. 

  1528. 	
    1529. 

  1529. 	
    1530. 

  1530. 	
    1531. 

  1531. 	<div class="method-subsection discussion-section">
    1532. 

  1532. 		<h4 class="method-subtitle">Discussion</h4>
    1533. 

  1533. 		<p>Connects the UDP socket to the given address, specified as a sockaddr structure wrapped in a NSData object.</p>
    1534. 

  1534. 

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

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

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

  1538. 

  1539. <p>By design, UDP is a connectionless protocol, and connecting is not needed.</p>
    1540. 

  1540. 

  1541. <p>Choosing to connect to a specific address has the following effect:<br/>
    1542. 

  1542. - You will only be able to send data to the connected address.<br/>
    1543. 

  1543. - You will only be able to receive data from the connected address.<br/>
    1544. 

  1544. - You will receive ICMP messages that come from the connected address, such as &ldquo;connection refused&rdquo;.</p>
    1545. 

  1545. 

  1546. <p>Connecting a UDP socket does not result in any communication on the socket.<br/>
    1547. 

  1547. It simply changes the internal state of the socket.</p>
    1548. 

  1548. 

  1549. <p>You cannot bind a socket after its been connected.<br/>
    1550. 

  1550. You can only connect a socket once.</p>
    1551. 

  1551. 

  1552. <p>On success, returns YES.<br/>
    1553. 

  1553. Otherwise returns NO, and sets errPtr. If you don&rsquo;t care about the error, you can pass nil for errPtr.</p>
    1554. 

  1554. 

  1555. <p>Note: Unlike the <a href="#//api/name/connectToHost:onPort:error:">connectToHost:onPort:error:</a> method, this method does not require a DNS lookup.<br/>
    1556. 

  1556. Thus when this method returns, the connection has either failed or fully completed.<br/>
    1557. 

  1557. In other words, this method is synchronous, unlike the asynchronous connectToHost::: method.<br/>
    1558. 

  1558. However, for compatibility and simplification of <a href="#//api/name/delegate">delegate</a> code, if this method returns YES<br/>
    1559. 

  1559. then the corresponding <a href="#//api/name/delegate">delegate</a> method (udpSocket:didConnectToHost:port:) is still invoked.</p>
    1560. 

  1560. 	</div>
    1561. 

  1561. 	
    1562. 

  1562. 	
    1563. 

  1563. 	
    1564. 

  1564. 	
    1565. 

  1565. 	
    1566. 

  1566. 	
    1567. 

  1567. 	
    1568. 

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

  1569. 		<h4 class="method-subtitle">Declared In</h4>
    1570. 

  1570. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1571. 

  1571. 	</div>				
    1572. 

  1572. 	
    1573. 

  1573. 	
    1574. 

  1574. </div>
    1575. 

  1575. 						
    1576. 

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

  1577. 	<a name="//api/name/connectToHost:onPort:error:" title="connectToHost:onPort:error:"></a>
    1578. 

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

  1579. 	
    1580. 

  1580. 	
    1581. 

  1581. 	
    1582. 

  1582. 	<div class="method-subsection brief-description">
    1583. 

  1583. 		<p>Connects the UDP socket to the given host and port.<br/>
    1584. 

  1584. By design, UDP is a connectionless protocol, and connecting is not needed.</p>
    1585. 

  1585. 	</div>		
    1586. 

  1586. 	
    1587. 

  1587.     
    1588. 

  1588. 

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

  1590. 

  1591.     
    1592. 

  1592. 	
    1593. 

  1593. 	
    1594. 

  1594. 	
    1595. 

  1595. 	
    1596. 

  1596. 	
    1597. 

  1597. 	
    1598. 

  1598. 	
    1599. 

  1599. 	<div class="method-subsection discussion-section">
    1600. 

  1600. 		<h4 class="method-subtitle">Discussion</h4>
    1601. 

  1601. 		<p>Connects the UDP socket to the given host and port.<br/>
    1602. 

  1602. By design, UDP is a connectionless protocol, and connecting is not needed.</p>
    1603. 

  1603. 

  1604. <p>Choosing to connect to a specific host/port has the following effect:<br/>
    1605. 

  1605. - You will only be able to send data to the connected host/port.<br/>
    1606. 

  1606. - You will only be able to receive data from the connected host/port.<br/>
    1607. 

  1607. - You will receive ICMP messages that come from the connected host/port, such as &ldquo;connection refused&rdquo;.</p>
    1608. 

  1608. 

  1609. <p>The actual process of connecting a UDP socket does not result in any communication on the socket.<br/>
    1610. 

  1610. It simply changes the internal state of the socket.</p>
    1611. 

  1611. 

  1612. <p>You cannot bind a socket after it has been connected.<br/>
    1613. 

  1613. You can only connect a socket once.</p>
    1614. 

  1614. 

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

  1616. 

  1617. <p>This method is asynchronous as it requires a DNS lookup to resolve the given host name.<br/>
    1618. 

  1618. If an obvious error is detected, this method immediately returns NO and sets errPtr.<br/>
    1619. 

  1619. If you don&rsquo;t care about the error, you can pass nil for errPtr.<br/>
    1620. 

  1620. Otherwise, this method returns YES and begins the asynchronous connection process.<br/>
    1621. 

  1621. The result of the asynchronous connection process will be reported via the <a href="#//api/name/delegate">delegate</a> methods.</p>
    1622. 

  1622. 	</div>
    1623. 

  1623. 	
    1624. 

  1624. 	
    1625. 

  1625. 	
    1626. 

  1626. 	
    1627. 

  1627. 	
    1628. 

  1628. 	
    1629. 

  1629. 	
    1630. 

  1630. 	<div class="method-subsection declared-in-section">
    1631. 

  1631. 		<h4 class="method-subtitle">Declared In</h4>
    1632. 

  1632. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1633. 

  1633. 	</div>				
    1634. 

  1634. 	
    1635. 

  1635. 	
    1636. 

  1636. </div>
    1637. 

  1637. 						
    1638. 

  1638. 						<div class="section-method">
    1639. 

  1639. 	<a name="//api/name/connectedAddress" title="connectedAddress"></a>
    1640. 

  1640. 	<h3 class="subsubtitle method-title">connectedAddress</h3>
    1641. 

  1641. 	
    1642. 

  1642. 	
    1643. 

  1643. 	
    1644. 

  1644. 	<div class="method-subsection brief-description">
    1645. 

  1645. 		<p>Returns the remote address info for the socket.</p>
    1646. 

  1646. 	</div>		
    1647. 

  1647. 	
    1648. 

  1648.     
    1649. 

  1649. 

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

  1651. 

  1652.     
    1653. 

  1653. 	
    1654. 

  1654. 	
    1655. 

  1655. 	
    1656. 

  1656. 	
    1657. 

  1657. 	
    1658. 

  1658. 	
    1659. 

  1659. 	
    1660. 

  1660. 	<div class="method-subsection discussion-section">
    1661. 

  1661. 		<h4 class="method-subtitle">Discussion</h4>
    1662. 

  1662. 		<p>Returns the remote address info for the socket.</p>
    1663. 

  1663. 

  1664. <p>The connectedAddress method returns a sockaddr structure wrapped in a NSData object.<br/>
    1665. 

  1665. The <a href="#//api/name/connectedHost">connectedHost</a> method returns the human readable IP address as a string.</p>
    1666. 

  1666. 

  1667. <p>Note: Since UDP is connectionless by design, connected address info<br/>
    1668. 

  1668. will not be available unless the socket is explicitly connected to a remote host/port.<br/>
    1669. 

  1669. If the socket is not connected, these methods will return nil / 0.</p>
    1670. 

  1670. 	</div>
    1671. 

  1671. 	
    1672. 

  1672. 	
    1673. 

  1673. 	
    1674. 

  1674. 	
    1675. 

  1675. 	
    1676. 

  1676. 	
    1677. 

  1677. 	
    1678. 

  1678. 	<div class="method-subsection declared-in-section">
    1679. 

  1679. 		<h4 class="method-subtitle">Declared In</h4>
    1680. 

  1680. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1681. 

  1681. 	</div>				
    1682. 

  1682. 	
    1683. 

  1683. 	
    1684. 

  1684. </div>
    1685. 

  1685. 						
    1686. 

  1686. 						<div class="section-method">
    1687. 

  1687. 	<a name="//api/name/connectedHost" title="connectedHost"></a>
    1688. 

  1688. 	<h3 class="subsubtitle method-title">connectedHost</h3>
    1689. 

  1689. 	
    1690. 

  1690. 	
    1691. 

  1691. 

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

  1693. 

  1694.     
    1695. 

  1695. </div>
    1696. 

  1696. 						
    1697. 

  1697. 						<div class="section-method">
    1698. 

  1698. 	<a name="//api/name/connectedPort" title="connectedPort"></a>
    1699. 

  1699. 	<h3 class="subsubtitle method-title">connectedPort</h3>
    1700. 

  1700. 	
    1701. 

  1701. 	
    1702. 

  1702. 

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

  1704. 

  1705.     
    1706. 

  1706. </div>
    1707. 

  1707. 						
    1708. 

  1708. 						<div class="section-method">
    1709. 

  1709. 	<a name="//api/name/delegate" title="delegate"></a>
    1710. 

  1710. 	<h3 class="subsubtitle method-title">delegate</h3>
    1711. 

  1711. 	
    1712. 

  1712. 	
    1713. 

  1713. 

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

  1715. 

  1716.     
    1717. 

  1717. </div>
    1718. 

  1718. 						
    1719. 

  1719. 						<div class="section-method">
    1720. 

  1720. 	<a name="//api/name/delegateQueue" title="delegateQueue"></a>
    1721. 

  1721. 	<h3 class="subsubtitle method-title">delegateQueue</h3>
    1722. 

  1722. 	
    1723. 

  1723. 	
    1724. 

  1724. 

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

  1726. 

  1727.     
    1728. 

  1728. </div>
    1729. 

  1729. 						
    1730. 

  1730. 						<div class="section-method">
    1731. 

  1731. 	<a name="//api/name/enableBroadcast:error:" title="enableBroadcast:error:"></a>
    1732. 

  1732. 	<h3 class="subsubtitle method-title">enableBroadcast:error:</h3>
    1733. 

  1733. 	
    1734. 

  1734. 	
    1735. 

  1735. 	
    1736. 

  1736. 	<div class="method-subsection brief-description">
    1737. 

  1737. 		<p>By default, the underlying socket in the OS will not allow you to send broadcast messages.<br/>
    1738. 

  1738. In order to send broadcast messages, you need to enable this functionality in the socket.</p>
    1739. 

  1739. 	</div>		
    1740. 

  1740. 	
    1741. 

  1741.     
    1742. 

  1742. 

  1743. 	<div class="method-subsection method-declaration"><code>- (BOOL)enableBroadcast:(BOOL)<em>flag</em> error:(NSError **)<em>errPtr</em></code></div>
    1744. 

  1744. 

  1745.     
    1746. 

  1746. 	
    1747. 

  1747. 	
    1748. 

  1748. 	
    1749. 

  1749. 	
    1750. 

  1750. 	
    1751. 

  1751. 	
    1752. 

  1752. 	
    1753. 

  1753. 	<div class="method-subsection discussion-section">
    1754. 

  1754. 		<h4 class="method-subtitle">Discussion</h4>
    1755. 

  1755. 		<p>By default, the underlying socket in the OS will not allow you to send broadcast messages.<br/>
    1756. 

  1756. In order to send broadcast messages, you need to enable this functionality in the socket.</p>
    1757. 

  1757. 

  1758. <p>A broadcast is a UDP message to addresses like &ldquo;192.168.255.255&rdquo; or &ldquo;255.255.255.255&rdquo; that is<br/>
    1759. 

  1759. delivered to every host on the network.<br/>
    1760. 

  1760. The reason this is generally disabled by default (by the OS) is to prevent<br/>
    1761. 

  1761. accidental broadcast messages from flooding the network.</p>
    1762. 

  1762. 	</div>
    1763. 

  1763. 	
    1764. 

  1764. 	
    1765. 

  1765. 	
    1766. 

  1766. 	
    1767. 

  1767. 	
    1768. 

  1768. 	
    1769. 

  1769. 	
    1770. 

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

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

  1772. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1773. 

  1773. 	</div>				
    1774. 

  1774. 	
    1775. 

  1775. 	
    1776. 

  1776. </div>
    1777. 

  1777. 						
    1778. 

  1778. 						<div class="section-method">
    1779. 

  1779. 	<a name="//api/name/getDelegate:delegateQueue:" title="getDelegate:delegateQueue:"></a>
    1780. 

  1780. 	<h3 class="subsubtitle method-title">getDelegate:delegateQueue:</h3>
    1781. 

  1781. 	
    1782. 

  1782. 	
    1783. 

  1783. 

  1784. 	<div class="method-subsection method-declaration"><code>- (void)getDelegate:(id *)<em>delegatePtr</em> delegateQueue:(dispatch_queue_t *)<em>delegateQueuePtr</em></code></div>
    1785. 

  1785. 

  1786.     
    1787. 

  1787. </div>
    1788. 

  1788. 						
    1789. 

  1789. 						<div class="section-method">
    1790. 

  1790. 	<a name="//api/name/init" title="init"></a>
    1791. 

  1791. 	<h3 class="subsubtitle method-title">init</h3>
    1792. 

  1792. 	
    1793. 

  1793. 	
    1794. 

  1794. 	
    1795. 

  1795. 	<div class="method-subsection brief-description">
    1796. 

  1796. 		<p>GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> uses the standard <a href="#//api/name/delegate">delegate</a> paradigm,<br/>
    1797. 

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

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

  1799. 	</div>		
    1800. 

  1800. 	
    1801. 

  1801.     
    1802. 

  1802. 

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

  1804. 

  1805.     
    1806. 

  1806. 	
    1807. 

  1807. 	
    1808. 

  1808. 	
    1809. 

  1809. 	
    1810. 

  1810. 	
    1811. 

  1811. 	
    1812. 

  1812. 	
    1813. 

  1813. 	<div class="method-subsection discussion-section">
    1814. 

  1814. 		<h4 class="method-subtitle">Discussion</h4>
    1815. 

  1815. 		<p>GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> uses the standard <a href="#//api/name/delegate">delegate</a> paradigm,<br/>
    1816. 

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

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

  1818. 

  1819. <p>You MUST set a <a href="#//api/name/delegate">delegate</a> AND <a href="#//api/name/delegate">delegate</a> dispatch queue before attempting to<br/>
    1820. 

  1820. use the socket, or you will get an error.</p>
    1821. 

  1821. 

  1822. <p>The socket queue is optional.<br/>
    1823. 

  1823. If you pass NULL, <a href="../Classes/GCDAsyncSocket.html">GCDAsyncSocket</a> will automatically create its own socket queue.<br/>
    1824. 

  1824. If you choose to provide a socket queue, the socket queue must not be a concurrent queue.</p>
    1825. 

  1825. 

  1826. <p>The <a href="#//api/name/delegate">delegate</a> queue and socket queue can optionally be the same.</p>
    1827. 

  1827. 	</div>
    1828. 

  1828. 	
    1829. 

  1829. 	
    1830. 

  1830. 	
    1831. 

  1831. 	
    1832. 

  1832. 	
    1833. 

  1833. 	
    1834. 

  1834. 	
    1835. 

  1835. 	<div class="method-subsection declared-in-section">
    1836. 

  1836. 		<h4 class="method-subtitle">Declared In</h4>
    1837. 

  1837. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1838. 

  1838. 	</div>				
    1839. 

  1839. 	
    1840. 

  1840. 	
    1841. 

  1841. </div>
    1842. 

  1842. 						
    1843. 

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

  1844. 	<a name="//api/name/initWithDelegate:delegateQueue:" title="initWithDelegate:delegateQueue:"></a>
    1845. 

  1845. 	<h3 class="subsubtitle method-title">initWithDelegate:delegateQueue:</h3>
    1846. 

  1846. 	
    1847. 

  1847. 	
    1848. 

  1848. 

  1849. 	<div class="method-subsection method-declaration"><code>- (id)initWithDelegate:(id)<em>aDelegate</em> delegateQueue:(dispatch_queue_t)<em>dq</em></code></div>
    1850. 

  1850. 

  1851.     
    1852. 

  1852. </div>
    1853. 

  1853. 						
    1854. 

  1854. 						<div class="section-method">
    1855. 

  1855. 	<a name="//api/name/initWithDelegate:delegateQueue:socketQueue:" title="initWithDelegate:delegateQueue:socketQueue:"></a>
    1856. 

  1856. 	<h3 class="subsubtitle method-title">initWithDelegate:delegateQueue:socketQueue:</h3>
    1857. 

  1857. 	
    1858. 

  1858. 	
    1859. 

  1859. 

  1860. 	<div class="method-subsection method-declaration"><code>- (id)initWithDelegate:(id)<em>aDelegate</em> delegateQueue:(dispatch_queue_t)<em>dq</em> socketQueue:(dispatch_queue_t)<em>sq</em></code></div>
    1861. 

  1861. 

  1862.     
    1863. 

  1863. </div>
    1864. 

  1864. 						
    1865. 

  1865. 						<div class="section-method">
    1866. 

  1866. 	<a name="//api/name/initWithSocketQueue:" title="initWithSocketQueue:"></a>
    1867. 

  1867. 	<h3 class="subsubtitle method-title">initWithSocketQueue:</h3>
    1868. 

  1868. 	
    1869. 

  1869. 	
    1870. 

  1870. 

  1871. 	<div class="method-subsection method-declaration"><code>- (id)initWithSocketQueue:(dispatch_queue_t)<em>sq</em></code></div>
    1872. 

  1872. 

  1873.     
    1874. 

  1874. </div>
    1875. 

  1875. 						
    1876. 

  1876. 						<div class="section-method">
    1877. 

  1877. 	<a name="//api/name/isClosed" title="isClosed"></a>
    1878. 

  1878. 	<h3 class="subsubtitle method-title">isClosed</h3>
    1879. 

  1879. 	
    1880. 

  1880. 	
    1881. 

  1881. 	
    1882. 

  1882. 	<div class="method-subsection brief-description">
    1883. 

  1883. 		<p>Returns whether or not this socket has been closed.<br/>
    1884. 

  1884. The only way a socket can be closed is if you explicitly call one of the <a href="#//api/name/close">close</a> methods.</p>
    1885. 

  1885. 	</div>		
    1886. 

  1886. 	
    1887. 

  1887.     
    1888. 

  1888. 

  1889. 	<div class="method-subsection method-declaration"><code>- (BOOL)isClosed</code></div>
    1890. 

  1890. 

  1891.     
    1892. 

  1892. 	
    1893. 

  1893. 	
    1894. 

  1894. 	
    1895. 

  1895. 	
    1896. 

  1896. 	
    1897. 

  1897. 	
    1898. 

  1898. 	
    1899. 

  1899. 	<div class="method-subsection discussion-section">
    1900. 

  1900. 		<h4 class="method-subtitle">Discussion</h4>
    1901. 

  1901. 		<p>Returns whether or not this socket has been closed.<br/>
    1902. 

  1902. The only way a socket can be closed is if you explicitly call one of the <a href="#//api/name/close">close</a> methods.</p>
    1903. 

  1903. 	</div>
    1904. 

  1904. 	
    1905. 

  1905. 	
    1906. 

  1906. 	
    1907. 

  1907. 	
    1908. 

  1908. 	
    1909. 

  1909. 	
    1910. 

  1910. 	
    1911. 

  1911. 	<div class="method-subsection declared-in-section">
    1912. 

  1912. 		<h4 class="method-subtitle">Declared In</h4>
    1913. 

  1913. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1914. 

  1914. 	</div>				
    1915. 

  1915. 	
    1916. 

  1916. 	
    1917. 

  1917. </div>
    1918. 

  1918. 						
    1919. 

  1919. 						<div class="section-method">
    1920. 

  1920. 	<a name="//api/name/isConnected" title="isConnected"></a>
    1921. 

  1921. 	<h3 class="subsubtitle method-title">isConnected</h3>
    1922. 

  1922. 	
    1923. 

  1923. 	
    1924. 

  1924. 	
    1925. 

  1925. 	<div class="method-subsection brief-description">
    1926. 

  1926. 		<p>Returns whether or not this socket has been connected to a single host.<br/>
    1927. 

  1927. By design, UDP is a connectionless protocol, and connecting is not needed.<br/>
    1928. 

  1928. If connected, the socket will only be able to send/receive data to/from the connected host.</p>
    1929. 

  1929. 	</div>		
    1930. 

  1930. 	
    1931. 

  1931.     
    1932. 

  1932. 

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

  1934. 

  1935.     
    1936. 

  1936. 	
    1937. 

  1937. 	
    1938. 

  1938. 	
    1939. 

  1939. 	
    1940. 

  1940. 	
    1941. 

  1941. 	
    1942. 

  1942. 	
    1943. 

  1943. 	<div class="method-subsection discussion-section">
    1944. 

  1944. 		<h4 class="method-subtitle">Discussion</h4>
    1945. 

  1945. 		<p>Returns whether or not this socket has been connected to a single host.<br/>
    1946. 

  1946. By design, UDP is a connectionless protocol, and connecting is not needed.<br/>
    1947. 

  1947. If connected, the socket will only be able to send/receive data to/from the connected host.</p>
    1948. 

  1948. 	</div>
    1949. 

  1949. 	
    1950. 

  1950. 	
    1951. 

  1951. 	
    1952. 

  1952. 	
    1953. 

  1953. 	
    1954. 

  1954. 	
    1955. 

  1955. 	
    1956. 

  1956. 	<div class="method-subsection declared-in-section">
    1957. 

  1957. 		<h4 class="method-subtitle">Declared In</h4>
    1958. 

  1958. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    1959. 

  1959. 	</div>				
    1960. 

  1960. 	
    1961. 

  1961. 	
    1962. 

  1962. </div>
    1963. 

  1963. 						
    1964. 

  1964. 						<div class="section-method">
    1965. 

  1965. 	<a name="//api/name/isIPVersionNeutral" title="isIPVersionNeutral"></a>
    1966. 

  1966. 	<h3 class="subsubtitle method-title">isIPVersionNeutral</h3>
    1967. 

  1967. 	
    1968. 

  1968. 	
    1969. 

  1969. 

  1970. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPVersionNeutral</code></div>
    1971. 

  1971. 

  1972.     
    1973. 

  1973. </div>
    1974. 

  1974. 						
    1975. 

  1975. 						<div class="section-method">
    1976. 

  1976. 	<a name="//api/name/isIPv4" title="isIPv4"></a>
    1977. 

  1977. 	<h3 class="subsubtitle method-title">isIPv4</h3>
    1978. 

  1978. 	
    1979. 

  1979. 	
    1980. 

  1980. 	
    1981. 

  1981. 	<div class="method-subsection brief-description">
    1982. 

  1982. 		<p>Returns whether or not this socket is IPv4.</p>
    1983. 

  1983. 	</div>		
    1984. 

  1984. 	
    1985. 

  1985.     
    1986. 

  1986. 

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

  1988. 

  1989.     
    1990. 

  1990. 	
    1991. 

  1991. 	
    1992. 

  1992. 	
    1993. 

  1993. 	
    1994. 

  1994. 	
    1995. 

  1995. 	
    1996. 

  1996. 	
    1997. 

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

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

  1999. 		<p>Returns whether or not this socket is IPv4.</p>
    2000. 

  2000. 

  2001. <p>By default this will be true, unless:<br/>
    2002. 

  2002. - IPv4 is disabled (via <a href="#//api/name/setIPv4Enabled:">setIPv4Enabled:</a>)<br/>
    2003. 

  2003. - The socket is explicitly bound to an IPv6 address<br/>
    2004. 

  2004. - The socket is connected to an IPv6 address</p>
    2005. 

  2005. 	</div>
    2006. 

  2006. 	
    2007. 

  2007. 	
    2008. 

  2008. 	
    2009. 

  2009. 	
    2010. 

  2010. 	
    2011. 

  2011. 	
    2012. 

  2012. 	
    2013. 

  2013. 	<div class="method-subsection declared-in-section">
    2014. 

  2014. 		<h4 class="method-subtitle">Declared In</h4>
    2015. 

  2015. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2016. 

  2016. 	</div>				
    2017. 

  2017. 	
    2018. 

  2018. 	
    2019. 

  2019. </div>
    2020. 

  2020. 						
    2021. 

  2021. 						<div class="section-method">
    2022. 

  2022. 	<a name="//api/name/isIPv4Enabled" title="isIPv4Enabled"></a>
    2023. 

  2023. 	<h3 class="subsubtitle method-title">isIPv4Enabled</h3>
    2024. 

  2024. 	
    2025. 

  2025. 	
    2026. 

  2026. 	
    2027. 

  2027. 	<div class="method-subsection brief-description">
    2028. 

  2028. 		<p>By default, both IPv4 and IPv6 are enabled.</p>
    2029. 

  2029. 	</div>		
    2030. 

  2030. 	
    2031. 

  2031.     
    2032. 

  2032. 

  2033. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv4Enabled</code></div>
    2034. 

  2034. 

  2035.     
    2036. 

  2036. 	
    2037. 

  2037. 	
    2038. 

  2038. 	
    2039. 

  2039. 	
    2040. 

  2040. 	
    2041. 

  2041. 	
    2042. 

  2042. 	
    2043. 

  2043. 	<div class="method-subsection discussion-section">
    2044. 

  2044. 		<h4 class="method-subtitle">Discussion</h4>
    2045. 

  2045. 		<p>By default, both IPv4 and IPv6 are enabled.</p>
    2046. 

  2046. 

  2047. <p>This means GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> automatically supports both protocols,<br/>
    2048. 

  2048. and can send to IPv4 or IPv6 addresses,<br/>
    2049. 

  2049. as well as receive over IPv4 and IPv6.</p>
    2050. 

  2050. 

  2051. <p>For operations that require DNS resolution, GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> supports both IPv4 and IPv6.<br/>
    2052. 

  2052. If a DNS lookup returns only IPv4 results, GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> will automatically use IPv4.<br/>
    2053. 

  2053. If a DNS lookup returns only IPv6 results, GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> will automatically use IPv6.<br/>
    2054. 

  2054. If a DNS lookup returns both IPv4 and IPv6 results, then the protocol used depends on the configured preference.<br/>
    2055. 

  2055. If IPv4 is preferred, then IPv4 is used.<br/>
    2056. 

  2056. If IPv6 is preferred, then IPv6 is used.<br/>
    2057. 

  2057. If neutral, then the first IP version in the resolved array will be used.</p>
    2058. 

  2058. 

  2059. <p>Starting with Mac OS X 10.7 Lion and iOS 5, the default IP preference is neutral.<br/>
    2060. 

  2060. On prior systems the default IP preference is IPv4.</p>
    2061. 

  2061. 	</div>
    2062. 

  2062. 	
    2063. 

  2063. 	
    2064. 

  2064. 	
    2065. 

  2065. 	
    2066. 

  2066. 	
    2067. 

  2067. 	
    2068. 

  2068. 	
    2069. 

  2069. 	<div class="method-subsection declared-in-section">
    2070. 

  2070. 		<h4 class="method-subtitle">Declared In</h4>
    2071. 

  2071. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2072. 

  2072. 	</div>				
    2073. 

  2073. 	
    2074. 

  2074. 	
    2075. 

  2075. </div>
    2076. 

  2076. 						
    2077. 

  2077. 						<div class="section-method">
    2078. 

  2078. 	<a name="//api/name/isIPv4Preferred" title="isIPv4Preferred"></a>
    2079. 

  2079. 	<h3 class="subsubtitle method-title">isIPv4Preferred</h3>
    2080. 

  2080. 	
    2081. 

  2081. 	
    2082. 

  2082. 

  2083. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv4Preferred</code></div>
    2084. 

  2084. 

  2085.     
    2086. 

  2086. </div>
    2087. 

  2087. 						
    2088. 

  2088. 						<div class="section-method">
    2089. 

  2089. 	<a name="//api/name/isIPv6" title="isIPv6"></a>
    2090. 

  2090. 	<h3 class="subsubtitle method-title">isIPv6</h3>
    2091. 

  2091. 	
    2092. 

  2092. 	
    2093. 

  2093. 	
    2094. 

  2094. 	<div class="method-subsection brief-description">
    2095. 

  2095. 		<p>Returns whether or not this socket is IPv6.</p>
    2096. 

  2096. 	</div>		
    2097. 

  2097. 	
    2098. 

  2098.     
    2099. 

  2099. 

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

  2101. 

  2102.     
    2103. 

  2103. 	
    2104. 

  2104. 	
    2105. 

  2105. 	
    2106. 

  2106. 	
    2107. 

  2107. 	
    2108. 

  2108. 	
    2109. 

  2109. 	
    2110. 

  2110. 	<div class="method-subsection discussion-section">
    2111. 

  2111. 		<h4 class="method-subtitle">Discussion</h4>
    2112. 

  2112. 		<p>Returns whether or not this socket is IPv6.</p>
    2113. 

  2113. 

  2114. <p>By default this will be true, unless:<br/>
    2115. 

  2115. - IPv6 is disabled (via <a href="#//api/name/setIPv6Enabled:">setIPv6Enabled:</a>)<br/>
    2116. 

  2116. - The socket is explicitly bound to an IPv4 address<br/>
    2117. 

  2117. _ The socket is connected to an IPv4 address</p>
    2118. 

  2118. 

  2119. <p>This method will also return false on platforms that do not support IPv6.<br/>
    2120. 

  2120. Note: The iPhone does not currently support IPv6.</p>
    2121. 

  2121. 	</div>
    2122. 

  2122. 	
    2123. 

  2123. 	
    2124. 

  2124. 	
    2125. 

  2125. 	
    2126. 

  2126. 	
    2127. 

  2127. 	
    2128. 

  2128. 	
    2129. 

  2129. 	<div class="method-subsection declared-in-section">
    2130. 

  2130. 		<h4 class="method-subtitle">Declared In</h4>
    2131. 

  2131. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2132. 

  2132. 	</div>				
    2133. 

  2133. 	
    2134. 

  2134. 	
    2135. 

  2135. </div>
    2136. 

  2136. 						
    2137. 

  2137. 						<div class="section-method">
    2138. 

  2138. 	<a name="//api/name/isIPv6Enabled" title="isIPv6Enabled"></a>
    2139. 

  2139. 	<h3 class="subsubtitle method-title">isIPv6Enabled</h3>
    2140. 

  2140. 	
    2141. 

  2141. 	
    2142. 

  2142. 

  2143. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv6Enabled</code></div>
    2144. 

  2144. 

  2145.     
    2146. 

  2146. </div>
    2147. 

  2147. 						
    2148. 

  2148. 						<div class="section-method">
    2149. 

  2149. 	<a name="//api/name/isIPv6Preferred" title="isIPv6Preferred"></a>
    2150. 

  2150. 	<h3 class="subsubtitle method-title">isIPv6Preferred</h3>
    2151. 

  2151. 	
    2152. 

  2152. 	
    2153. 

  2153. 

  2154. 	<div class="method-subsection method-declaration"><code>- (BOOL)isIPv6Preferred</code></div>
    2155. 

  2155. 

  2156.     
    2157. 

  2157. </div>
    2158. 

  2158. 						
    2159. 

  2159. 						<div class="section-method">
    2160. 

  2160. 	<a name="//api/name/joinMulticastGroup:error:" title="joinMulticastGroup:error:"></a>
    2161. 

  2161. 	<h3 class="subsubtitle method-title">joinMulticastGroup:error:</h3>
    2162. 

  2162. 	
    2163. 

  2163. 	
    2164. 

  2164. 	
    2165. 

  2165. 	<div class="method-subsection brief-description">
    2166. 

  2166. 		<p>Join multicast group.<br/>
    2167. 

  2167. Group should be an IP address (eg @&ldquo;225.228.0.1&rdquo;).</p>
    2168. 

  2168. 	</div>		
    2169. 

  2169. 	
    2170. 

  2170.     
    2171. 

  2171. 

  2172. 	<div class="method-subsection method-declaration"><code>- (BOOL)joinMulticastGroup:(NSString *)<em>group</em> error:(NSError **)<em>errPtr</em></code></div>
    2173. 

  2173. 

  2174.     
    2175. 

  2175. 	
    2176. 

  2176. 	
    2177. 

  2177. 	
    2178. 

  2178. 	
    2179. 

  2179. 	
    2180. 

  2180. 	
    2181. 

  2181. 	
    2182. 

  2182. 	<div class="method-subsection discussion-section">
    2183. 

  2183. 		<h4 class="method-subtitle">Discussion</h4>
    2184. 

  2184. 		<p>Join multicast group.<br/>
    2185. 

  2185. Group should be an IP address (eg @&ldquo;225.228.0.1&rdquo;).</p>
    2186. 

  2186. 

  2187. <p>On success, returns YES.<br/>
    2188. 

  2188. Otherwise returns NO, and sets errPtr. If you don&rsquo;t care about the error, you can pass nil for errPtr.</p>
    2189. 

  2189. 	</div>
    2190. 

  2190. 	
    2191. 

  2191. 	
    2192. 

  2192. 	
    2193. 

  2193. 	
    2194. 

  2194. 	
    2195. 

  2195. 	
    2196. 

  2196. 	
    2197. 

  2197. 	<div class="method-subsection declared-in-section">
    2198. 

  2198. 		<h4 class="method-subtitle">Declared In</h4>
    2199. 

  2199. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2200. 

  2200. 	</div>				
    2201. 

  2201. 	
    2202. 

  2202. 	
    2203. 

  2203. </div>
    2204. 

  2204. 						
    2205. 

  2205. 						<div class="section-method">
    2206. 

  2206. 	<a name="//api/name/joinMulticastGroup:onInterface:error:" title="joinMulticastGroup:onInterface:error:"></a>
    2207. 

  2207. 	<h3 class="subsubtitle method-title">joinMulticastGroup:onInterface:error:</h3>
    2208. 

  2208. 	
    2209. 

  2209. 	
    2210. 

  2210. 	
    2211. 

  2211. 	<div class="method-subsection brief-description">
    2212. 

  2212. 		<p>Join multicast group.<br/>
    2213. 

  2213. Group should be an IP address (eg @&ldquo;225.228.0.1&rdquo;).<br/>
    2214. 

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

  2215. 	</div>		
    2216. 

  2216. 	
    2217. 

  2217.     
    2218. 

  2218. 

  2219. 	<div class="method-subsection method-declaration"><code>- (BOOL)joinMulticastGroup:(NSString *)<em>group</em> onInterface:(NSString *)<em>interface</em> error:(NSError **)<em>errPtr</em></code></div>
    2220. 

  2220. 

  2221.     
    2222. 

  2222. 	
    2223. 

  2223. 	
    2224. 

  2224. 	
    2225. 

  2225. 	
    2226. 

  2226. 	
    2227. 

  2227. 	
    2228. 

  2228. 	
    2229. 

  2229. 	<div class="method-subsection discussion-section">
    2230. 

  2230. 		<h4 class="method-subtitle">Discussion</h4>
    2231. 

  2231. 		<p>Join multicast group.<br/>
    2232. 

  2232. Group should be an IP address (eg @&ldquo;225.228.0.1&rdquo;).<br/>
    2233. 

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

  2234. 

  2235. <p>On success, returns YES.<br/>
    2236. 

  2236. Otherwise returns NO, and sets errPtr. If you don&rsquo;t care about the error, you can pass nil for errPtr.</p>
    2237. 

  2237. 	</div>
    2238. 

  2238. 	
    2239. 

  2239. 	
    2240. 

  2240. 	
    2241. 

  2241. 	
    2242. 

  2242. 	
    2243. 

  2243. 	
    2244. 

  2244. 	
    2245. 

  2245. 	<div class="method-subsection declared-in-section">
    2246. 

  2246. 		<h4 class="method-subtitle">Declared In</h4>
    2247. 

  2247. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2248. 

  2248. 	</div>				
    2249. 

  2249. 	
    2250. 

  2250. 	
    2251. 

  2251. </div>
    2252. 

  2252. 						
    2253. 

  2253. 						<div class="section-method">
    2254. 

  2254. 	<a name="//api/name/leaveMulticastGroup:error:" title="leaveMulticastGroup:error:"></a>
    2255. 

  2255. 	<h3 class="subsubtitle method-title">leaveMulticastGroup:error:</h3>
    2256. 

  2256. 	
    2257. 

  2257. 	
    2258. 

  2258. 

  2259. 	<div class="method-subsection method-declaration"><code>- (BOOL)leaveMulticastGroup:(NSString *)<em>group</em> error:(NSError **)<em>errPtr</em></code></div>
    2260. 

  2260. 

  2261.     
    2262. 

  2262. </div>
    2263. 

  2263. 						
    2264. 

  2264. 						<div class="section-method">
    2265. 

  2265. 	<a name="//api/name/leaveMulticastGroup:onInterface:error:" title="leaveMulticastGroup:onInterface:error:"></a>
    2266. 

  2266. 	<h3 class="subsubtitle method-title">leaveMulticastGroup:onInterface:error:</h3>
    2267. 

  2267. 	
    2268. 

  2268. 	
    2269. 

  2269. 

  2270. 	<div class="method-subsection method-declaration"><code>- (BOOL)leaveMulticastGroup:(NSString *)<em>group</em> onInterface:(NSString *)<em>interface</em> error:(NSError **)<em>errPtr</em></code></div>
    2271. 

  2271. 

  2272.     
    2273. 

  2273. </div>
    2274. 

  2274. 						
    2275. 

  2275. 						<div class="section-method">
    2276. 

  2276. 	<a name="//api/name/localAddress" title="localAddress"></a>
    2277. 

  2277. 	<h3 class="subsubtitle method-title">localAddress</h3>
    2278. 

  2278. 	
    2279. 

  2279. 	
    2280. 

  2280. 	
    2281. 

  2281. 	<div class="method-subsection brief-description">
    2282. 

  2282. 		<p>Returns the local address info for the socket.</p>
    2283. 

  2283. 	</div>		
    2284. 

  2284. 	
    2285. 

  2285.     
    2286. 

  2286. 

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

  2288. 

  2289.     
    2290. 

  2290. 	
    2291. 

  2291. 	
    2292. 

  2292. 	
    2293. 

  2293. 	
    2294. 

  2294. 	
    2295. 

  2295. 	
    2296. 

  2296. 	
    2297. 

  2297. 	<div class="method-subsection discussion-section">
    2298. 

  2298. 		<h4 class="method-subtitle">Discussion</h4>
    2299. 

  2299. 		<p>Returns the local address info for the socket.</p>
    2300. 

  2300. 

  2301. <p>The localAddress method returns a sockaddr structure wrapped in a NSData object.<br/>
    2302. 

  2302. The <a href="#//api/name/localHost">localHost</a> method returns the human readable IP address as a string.</p>
    2303. 

  2303. 

  2304. <p>Note: Address info may not be available until after the socket has been binded, connected<br/>
    2305. 

  2305. or until after data has been sent.</p>
    2306. 

  2306. 	</div>
    2307. 

  2307. 	
    2308. 

  2308. 	
    2309. 

  2309. 	
    2310. 

  2310. 	
    2311. 

  2311. 	
    2312. 

  2312. 	
    2313. 

  2313. 	
    2314. 

  2314. 	<div class="method-subsection declared-in-section">
    2315. 

  2315. 		<h4 class="method-subtitle">Declared In</h4>
    2316. 

  2316. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2317. 

  2317. 	</div>				
    2318. 

  2318. 	
    2319. 

  2319. 	
    2320. 

  2320. </div>
    2321. 

  2321. 						
    2322. 

  2322. 						<div class="section-method">
    2323. 

  2323. 	<a name="//api/name/localAddress_IPv4" title="localAddress_IPv4"></a>
    2324. 

  2324. 	<h3 class="subsubtitle method-title">localAddress_IPv4</h3>
    2325. 

  2325. 	
    2326. 

  2326. 	
    2327. 

  2327. 

  2328. 	<div class="method-subsection method-declaration"><code>- (NSData *)localAddress_IPv4</code></div>
    2329. 

  2329. 

  2330.     
    2331. 

  2331. </div>
    2332. 

  2332. 						
    2333. 

  2333. 						<div class="section-method">
    2334. 

  2334. 	<a name="//api/name/localAddress_IPv6" title="localAddress_IPv6"></a>
    2335. 

  2335. 	<h3 class="subsubtitle method-title">localAddress_IPv6</h3>
    2336. 

  2336. 	
    2337. 

  2337. 	
    2338. 

  2338. 

  2339. 	<div class="method-subsection method-declaration"><code>- (NSData *)localAddress_IPv6</code></div>
    2340. 

  2340. 

  2341.     
    2342. 

  2342. </div>
    2343. 

  2343. 						
    2344. 

  2344. 						<div class="section-method">
    2345. 

  2345. 	<a name="//api/name/localHost" title="localHost"></a>
    2346. 

  2346. 	<h3 class="subsubtitle method-title">localHost</h3>
    2347. 

  2347. 	
    2348. 

  2348. 	
    2349. 

  2349. 

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

  2351. 

  2352.     
    2353. 

  2353. </div>
    2354. 

  2354. 						
    2355. 

  2355. 						<div class="section-method">
    2356. 

  2356. 	<a name="//api/name/localHost_IPv4" title="localHost_IPv4"></a>
    2357. 

  2357. 	<h3 class="subsubtitle method-title">localHost_IPv4</h3>
    2358. 

  2358. 	
    2359. 

  2359. 	
    2360. 

  2360. 

  2361. 	<div class="method-subsection method-declaration"><code>- (NSString *)localHost_IPv4</code></div>
    2362. 

  2362. 

  2363.     
    2364. 

  2364. </div>
    2365. 

  2365. 						
    2366. 

  2366. 						<div class="section-method">
    2367. 

  2367. 	<a name="//api/name/localHost_IPv6" title="localHost_IPv6"></a>
    2368. 

  2368. 	<h3 class="subsubtitle method-title">localHost_IPv6</h3>
    2369. 

  2369. 	
    2370. 

  2370. 	
    2371. 

  2371. 

  2372. 	<div class="method-subsection method-declaration"><code>- (NSString *)localHost_IPv6</code></div>
    2373. 

  2373. 

  2374.     
    2375. 

  2375. </div>
    2376. 

  2376. 						
    2377. 

  2377. 						<div class="section-method">
    2378. 

  2378. 	<a name="//api/name/localPort" title="localPort"></a>
    2379. 

  2379. 	<h3 class="subsubtitle method-title">localPort</h3>
    2380. 

  2380. 	
    2381. 

  2381. 	
    2382. 

  2382. 

  2383. 	<div class="method-subsection method-declaration"><code>- (uint16_t)localPort</code></div>
    2384. 

  2384. 

  2385.     
    2386. 

  2386. </div>
    2387. 

  2387. 						
    2388. 

  2388. 						<div class="section-method">
    2389. 

  2389. 	<a name="//api/name/localPort_IPv4" title="localPort_IPv4"></a>
    2390. 

  2390. 	<h3 class="subsubtitle method-title">localPort_IPv4</h3>
    2391. 

  2391. 	
    2392. 

  2392. 	
    2393. 

  2393. 

  2394. 	<div class="method-subsection method-declaration"><code>- (uint16_t)localPort_IPv4</code></div>
    2395. 

  2395. 

  2396.     
    2397. 

  2397. </div>
    2398. 

  2398. 						
    2399. 

  2399. 						<div class="section-method">
    2400. 

  2400. 	<a name="//api/name/localPort_IPv6" title="localPort_IPv6"></a>
    2401. 

  2401. 	<h3 class="subsubtitle method-title">localPort_IPv6</h3>
    2402. 

  2402. 	
    2403. 

  2403. 	
    2404. 

  2404. 

  2405. 	<div class="method-subsection method-declaration"><code>- (uint16_t)localPort_IPv6</code></div>
    2406. 

  2406. 

  2407.     
    2408. 

  2408. </div>
    2409. 

  2409. 						
    2410. 

  2410. 						<div class="section-method">
    2411. 

  2411. 	<a name="//api/name/maxReceiveIPv4BufferSize" title="maxReceiveIPv4BufferSize"></a>
    2412. 

  2412. 	<h3 class="subsubtitle method-title">maxReceiveIPv4BufferSize</h3>
    2413. 

  2413. 	
    2414. 

  2414. 	
    2415. 

  2415. 	
    2416. 

  2416. 	<div class="method-subsection brief-description">
    2417. 

  2417. 		<p>Gets/Sets the maximum size of the buffer that will be allocated for receive operations.<br/>
    2418. 

  2418. The default maximum size is 9216 bytes.</p>
    2419. 

  2419. 	</div>		
    2420. 

  2420. 	
    2421. 

  2421.     
    2422. 

  2422. 

  2423. 	<div class="method-subsection method-declaration"><code>- (uint16_t)maxReceiveIPv4BufferSize</code></div>
    2424. 

  2424. 

  2425.     
    2426. 

  2426. 	
    2427. 

  2427. 	
    2428. 

  2428. 	
    2429. 

  2429. 	
    2430. 

  2430. 	
    2431. 

  2431. 	
    2432. 

  2432. 	
    2433. 

  2433. 	<div class="method-subsection discussion-section">
    2434. 

  2434. 		<h4 class="method-subtitle">Discussion</h4>
    2435. 

  2435. 		<p>Gets/Sets the maximum size of the buffer that will be allocated for receive operations.<br/>
    2436. 

  2436. The default maximum size is 9216 bytes.</p>
    2437. 

  2437. 

  2438. <p>The theoretical maximum size of any IPv4 UDP packet is UINT16_MAX = 65535.<br/>
    2439. 

  2439. The theoretical maximum size of any IPv6 UDP packet is UINT32_MAX = 4294967295.</p>
    2440. 

  2440. 

  2441. <p>Since the OS/GCD notifies us of the size of each received UDP packet,<br/>
    2442. 

  2442. the actual allocated buffer size for each packet is exact.<br/>
    2443. 

  2443. And in practice the size of UDP packets is generally much smaller than the max.<br/>
    2444. 

  2444. Indeed most protocols will send and receive packets of only a few bytes,<br/>
    2445. 

  2445. or will set a limit on the size of packets to prevent fragmentation in the IP layer.</p>
    2446. 

  2446. 

  2447. <p>If you set the buffer size too small, the sockets API in the OS will silently discard<br/>
    2448. 

  2448. any extra data, and you will not be notified of the error.</p>
    2449. 

  2449. 	</div>
    2450. 

  2450. 	
    2451. 

  2451. 	
    2452. 

  2452. 	
    2453. 

  2453. 	
    2454. 

  2454. 	
    2455. 

  2455. 	
    2456. 

  2456. 	
    2457. 

  2457. 	<div class="method-subsection declared-in-section">
    2458. 

  2458. 		<h4 class="method-subtitle">Declared In</h4>
    2459. 

  2459. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2460. 

  2460. 	</div>				
    2461. 

  2461. 	
    2462. 

  2462. 	
    2463. 

  2463. </div>
    2464. 

  2464. 						
    2465. 

  2465. 						<div class="section-method">
    2466. 

  2466. 	<a name="//api/name/maxReceiveIPv6BufferSize" title="maxReceiveIPv6BufferSize"></a>
    2467. 

  2467. 	<h3 class="subsubtitle method-title">maxReceiveIPv6BufferSize</h3>
    2468. 

  2468. 	
    2469. 

  2469. 	
    2470. 

  2470. 

  2471. 	<div class="method-subsection method-declaration"><code>- (uint32_t)maxReceiveIPv6BufferSize</code></div>
    2472. 

  2472. 

  2473.     
    2474. 

  2474. </div>
    2475. 

  2475. 						
    2476. 

  2476. 						<div class="section-method">
    2477. 

  2477. 	<a name="//api/name/pauseReceiving" title="pauseReceiving"></a>
    2478. 

  2478. 	<h3 class="subsubtitle method-title">pauseReceiving</h3>
    2479. 

  2479. 	
    2480. 

  2480. 	
    2481. 

  2481. 	
    2482. 

  2482. 	<div class="method-subsection brief-description">
    2483. 

  2483. 		<p>If the socket is currently receiving (beginReceiving has been called), this method pauses the receiving.<br/>
    2484. 

  2484. That is, it won&rsquo;t read any more packets from the underlying OS socket until beginReceiving is called again.</p>
    2485. 

  2485. 	</div>		
    2486. 

  2486. 	
    2487. 

  2487.     
    2488. 

  2488. 

  2489. 	<div class="method-subsection method-declaration"><code>- (void)pauseReceiving</code></div>
    2490. 

  2490. 

  2491.     
    2492. 

  2492. 	
    2493. 

  2493. 	
    2494. 

  2494. 	
    2495. 

  2495. 	
    2496. 

  2496. 	
    2497. 

  2497. 	
    2498. 

  2498. 	
    2499. 

  2499. 	<div class="method-subsection discussion-section">
    2500. 

  2500. 		<h4 class="method-subtitle">Discussion</h4>
    2501. 

  2501. 		<p>If the socket is currently receiving (beginReceiving has been called), this method pauses the receiving.<br/>
    2502. 

  2502. That is, it won&rsquo;t read any more packets from the underlying OS socket until beginReceiving is called again.</p>
    2503. 

  2503. 

  2504. <p>Important Note:<br/>
    2505. 

  2505. GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> may be running in parallel with your code.<br/>
    2506. 

  2506. That is, your <a href="#//api/name/delegate">delegate</a> is likely running on a separate thread/dispatch_queue.<br/>
    2507. 

  2507. When you invoke this method, GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> may have already dispatched <a href="#//api/name/delegate">delegate</a> methods to be invoked.<br/>
    2508. 

  2508. Thus, if those <a href="#//api/name/delegate">delegate</a> methods have already been dispatch_async&rsquo;d,<br/>
    2509. 

  2509. your didReceive <a href="#//api/name/delegate">delegate</a> method may still be invoked after this method has been called.<br/>
    2510. 

  2510. You should be aware of this, and program defensively.</p>
    2511. 

  2511. 	</div>
    2512. 

  2512. 	
    2513. 

  2513. 	
    2514. 

  2514. 	
    2515. 

  2515. 	
    2516. 

  2516. 	
    2517. 

  2517. 	
    2518. 

  2518. 	
    2519. 

  2519. 	<div class="method-subsection declared-in-section">
    2520. 

  2520. 		<h4 class="method-subtitle">Declared In</h4>
    2521. 

  2521. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2522. 

  2522. 	</div>				
    2523. 

  2523. 	
    2524. 

  2524. 	
    2525. 

  2525. </div>
    2526. 

  2526. 						
    2527. 

  2527. 						<div class="section-method">
    2528. 

  2528. 	<a name="//api/name/performBlock:" title="performBlock:"></a>
    2529. 

  2529. 	<h3 class="subsubtitle method-title">performBlock:</h3>
    2530. 

  2530. 	
    2531. 

  2531. 	
    2532. 

  2532. 	
    2533. 

  2533. 	<div class="method-subsection brief-description">
    2534. 

  2534. 		<p>It&rsquo;s not thread-safe to access certain variables from outside the socket&rsquo;s internal queue.</p>
    2535. 

  2535. 	</div>		
    2536. 

  2536. 	
    2537. 

  2537.     
    2538. 

  2538. 

  2539. 	<div class="method-subsection method-declaration"><code>- (void)performBlock:(dispatch_block_t)<em>block</em></code></div>
    2540. 

  2540. 

  2541.     
    2542. 

  2542. 	
    2543. 

  2543. 	
    2544. 

  2544. 	
    2545. 

  2545. 	
    2546. 

  2546. 	
    2547. 

  2547. 	
    2548. 

  2548. 	
    2549. 

  2549. 	<div class="method-subsection discussion-section">
    2550. 

  2550. 		<h4 class="method-subtitle">Discussion</h4>
    2551. 

  2551. 		<p>It&rsquo;s not thread-safe to access certain variables from outside the socket&rsquo;s internal queue.</p>
    2552. 

  2552. 

  2553. <p>For example, the socket file descriptor.<br/>
    2554. 

  2554. File descriptors are simply integers which reference an index in the per-process file table.<br/>
    2555. 

  2555. However, when one requests a new file descriptor (by opening a file or socket),<br/>
    2556. 

  2556. the file descriptor returned is guaranteed to be the lowest numbered unused descriptor.<br/>
    2557. 

  2557. So if we&rsquo;re not careful, the following could be possible:</p>
    2558. 

  2558. 

  2559. <ul>
    2560. 

  2560. <li>Thread A invokes a method which returns the socket&rsquo;s file descriptor.</li>
    2561. 

  2561. <li>The socket is closed via the socket&rsquo;s internal queue on thread B.</li>
    2562. 

  2562. <li>Thread C opens a file, and subsequently receives the file descriptor that was previously the socket&rsquo;s FD.</li>
    2563. 

  2563. <li>Thread A is now accessing/altering the file instead of the socket.</li>
    2564. 

  2564. </ul>
    2565. 

  2565. 

  2566. 

  2567. <p>In addition to this, other variables are not actually objects,<br/>
    2568. 

  2568. and thus cannot be retained/released or even autoreleased.<br/>
    2569. 

  2569. An example is the sslContext, of type SSLContextRef, which is actually a malloc&rsquo;d struct.</p>
    2570. 

  2570. 

  2571. <p>Although there are internal variables that make it difficult to maintain thread-safety,<br/>
    2572. 

  2572. it is important to provide access to these variables<br/>
    2573. 

  2573. to ensure this class can be used in a wide array of environments.<br/>
    2574. 

  2574. This method helps to accomplish this by invoking the current block on the socket&rsquo;s internal queue.<br/>
    2575. 

  2575. The methods below can be invoked from within the block to access<br/>
    2576. 

  2576. those generally thread-unsafe internal variables in a thread-safe manner.<br/>
    2577. 

  2577. The given block will be invoked synchronously on the socket&rsquo;s internal queue.</p>
    2578. 

  2578. 

  2579. <p>If you save references to any protected variables and use them outside the block, you do so at your own peril.</p>
    2580. 

  2580. 	</div>
    2581. 

  2581. 	
    2582. 

  2582. 	
    2583. 

  2583. 	
    2584. 

  2584. 	
    2585. 

  2585. 	
    2586. 

  2586. 	
    2587. 

  2587. 	
    2588. 

  2588. 	<div class="method-subsection declared-in-section">
    2589. 

  2589. 		<h4 class="method-subtitle">Declared In</h4>
    2590. 

  2590. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2591. 

  2591. 	</div>				
    2592. 

  2592. 	
    2593. 

  2593. 	
    2594. 

  2594. </div>
    2595. 

  2595. 						
    2596. 

  2596. 						<div class="section-method">
    2597. 

  2597. 	<a name="//api/name/readStream" title="readStream"></a>
    2598. 

  2598. 	<h3 class="subsubtitle method-title">readStream</h3>
    2599. 

  2599. 	
    2600. 

  2600. 	
    2601. 

  2601. 	
    2602. 

  2602. 	<div class="method-subsection brief-description">
    2603. 

  2603. 		<p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    2604. 

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

  2605. 	</div>		
    2606. 

  2606. 	
    2607. 

  2607.     
    2608. 

  2608. 

  2609. 	<div class="method-subsection method-declaration"><code>- (CFReadStreamRef)readStream</code></div>
    2610. 

  2610. 

  2611.     
    2612. 

  2612. 	
    2613. 

  2613. 	
    2614. 

  2614. 	
    2615. 

  2615. 	
    2616. 

  2616. 	
    2617. 

  2617. 	
    2618. 

  2618. 	
    2619. 

  2619. 	<div class="method-subsection discussion-section">
    2620. 

  2620. 		<h4 class="method-subtitle">Discussion</h4>
    2621. 

  2621. 		<p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    2622. 

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

  2623. 

  2624. <p>Returns (creating if necessary) a CFReadStream/CFWriteStream for the internal socket.</p>
    2625. 

  2625. 

  2626. <p>Generally GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> doesn&rsquo;t use CFStream. (It uses the faster GCD API&rsquo;s.)<br/>
    2627. 

  2627. However, if you need one for any reason,<br/>
    2628. 

  2628. these methods are a convenient way to get access to a safe instance of one.</p>
    2629. 

  2629. 	</div>
    2630. 

  2630. 	
    2631. 

  2631. 	
    2632. 

  2632. 	
    2633. 

  2633. 	
    2634. 

  2634. 	
    2635. 

  2635. 	
    2636. 

  2636. 	
    2637. 

  2637. 	<div class="method-subsection declared-in-section">
    2638. 

  2638. 		<h4 class="method-subtitle">Declared In</h4>
    2639. 

  2639. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2640. 

  2640. 	</div>				
    2641. 

  2641. 	
    2642. 

  2642. 	
    2643. 

  2643. </div>
    2644. 

  2644. 						
    2645. 

  2645. 						<div class="section-method">
    2646. 

  2646. 	<a name="//api/name/receiveOnce:" title="receiveOnce:"></a>
    2647. 

  2647. 	<h3 class="subsubtitle method-title">receiveOnce:</h3>
    2648. 

  2648. 	
    2649. 

  2649. 	
    2650. 

  2650. 	
    2651. 

  2651. 	<div class="method-subsection brief-description">
    2652. 

  2652. 		<p>There are two modes of operation for receiving packets: one-at-a-time &amp; continuous.</p>
    2653. 

  2653. 	</div>		
    2654. 

  2654. 	
    2655. 

  2655.     
    2656. 

  2656. 

  2657. 	<div class="method-subsection method-declaration"><code>- (BOOL)receiveOnce:(NSError **)<em>errPtr</em></code></div>
    2658. 

  2658. 

  2659.     
    2660. 

  2660. 	
    2661. 

  2661. 	
    2662. 

  2662. 	
    2663. 

  2663. 	
    2664. 

  2664. 	
    2665. 

  2665. 	
    2666. 

  2666. 	
    2667. 

  2667. 	<div class="method-subsection discussion-section">
    2668. 

  2668. 		<h4 class="method-subtitle">Discussion</h4>
    2669. 

  2669. 		<p>There are two modes of operation for receiving packets: one-at-a-time &amp; continuous.</p>
    2670. 

  2670. 

  2671. <p>In one-at-a-time mode, you call receiveOnce everytime your <a href="#//api/name/delegate">delegate</a> is ready to process an incoming udp packet.<br/>
    2672. 

  2672. Receiving packets one-at-a-time may be better suited for implementing certain state machine code,<br/>
    2673. 

  2673. where your state machine may not always be ready to process incoming packets.</p>
    2674. 

  2674. 

  2675. <p>In continuous mode, the <a href="#//api/name/delegate">delegate</a> is invoked immediately everytime incoming udp packets are received.<br/>
    2676. 

  2676. Receiving packets continuously is better suited to real-time streaming applications.</p>
    2677. 

  2677. 

  2678. <p>You may switch back and forth between one-at-a-time mode and continuous mode.<br/>
    2679. 

  2679. If the socket is currently in continuous mode, calling this method will switch it to one-at-a-time mode.</p>
    2680. 

  2680. 

  2681. <p>When a packet is received (and not filtered by the optional receive filter),<br/>
    2682. 

  2682. the <a href="#//api/name/delegate">delegate</a> method (udpSocket:didReceiveData:fromAddress:withFilterContext:) is invoked.</p>
    2683. 

  2683. 

  2684. <p>If the socket is able to begin receiving packets, this method returns YES.<br/>
    2685. 

  2685. Otherwise it returns NO, and sets the errPtr with appropriate error information.</p>
    2686. 

  2686. 

  2687. <p>An example error:<br/>
    2688. 

  2688. You created a udp socket to act as a server, and immediately called receive.<br/>
    2689. 

  2689. You forgot to first bind the socket to a port number, and received a error with a message like:<br/>
    2690. 

  2690. &ldquo;Must bind socket before you can receive data.&rdquo;</p>
    2691. 

  2691. 	</div>
    2692. 

  2692. 	
    2693. 

  2693. 	
    2694. 

  2694. 	
    2695. 

  2695. 	
    2696. 

  2696. 	
    2697. 

  2697. 	
    2698. 

  2698. 	
    2699. 

  2699. 	<div class="method-subsection declared-in-section">
    2700. 

  2700. 		<h4 class="method-subtitle">Declared In</h4>
    2701. 

  2701. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2702. 

  2702. 	</div>				
    2703. 

  2703. 	
    2704. 

  2704. 	
    2705. 

  2705. </div>
    2706. 

  2706. 						
    2707. 

  2707. 						<div class="section-method">
    2708. 

  2708. 	<a name="//api/name/sendData:toAddress:withTimeout:tag:" title="sendData:toAddress:withTimeout:tag:"></a>
    2709. 

  2709. 	<h3 class="subsubtitle method-title">sendData:toAddress:withTimeout:tag:</h3>
    2710. 

  2710. 	
    2711. 

  2711. 	
    2712. 

  2712. 	
    2713. 

  2713. 	<div class="method-subsection brief-description">
    2714. 

  2714. 		<p>Asynchronously sends the given data, with the given timeout and tag, to the given address.</p>
    2715. 

  2715. 	</div>		
    2716. 

  2716. 	
    2717. 

  2717.     
    2718. 

  2718. 

  2719. 	<div class="method-subsection method-declaration"><code>- (void)sendData:(NSData *)<em>data</em> toAddress:(NSData *)<em>remoteAddr</em> withTimeout:(NSTimeInterval)<em>timeout</em> tag:(long)<em>tag</em></code></div>
    2720. 

  2720. 

  2721.     
    2722. 

  2722. 	
    2723. 

  2723. 	
    2724. 

  2724. 	
    2725. 

  2725. 	
    2726. 

  2726. 	
    2727. 

  2727. 	
    2728. 

  2728. 	
    2729. 

  2729. 	<div class="method-subsection discussion-section">
    2730. 

  2730. 		<h4 class="method-subtitle">Discussion</h4>
    2731. 

  2731. 		<p>Asynchronously sends the given data, with the given timeout and tag, to the given address.</p>
    2732. 

  2732. 

  2733. <p>This method cannot be used with a connected socket.<br/>
    2734. 

  2734. Recall that connecting is optional for a UDP socket.<br/>
    2735. 

  2735. For connected sockets, data can only be sent to the connected address.<br/>
    2736. 

  2736. For non-connected sockets, the remote destination is specified for each packet.<br/>
    2737. 

  2737. For more information about optionally connecting udp sockets, see the documentation for the connect methods above.</p>
    2738. 

  2738. 

  2739. <p>@param data<br/>
    2740. 

  2740. The data to send.<br/>
    2741. 

  2741. If data is nil or zero-length, this method does nothing.<br/>
    2742. 

  2742. If passing NSMutableData, please read the thread-safety notice below.</p>
    2743. 

  2743. 

  2744. <p>@param address<br/>
    2745. 

  2745. The address to send the data to (specified as a sockaddr structure wrapped in a NSData object).</p>
    2746. 

  2746. 

  2747. <p>@param timeout<br/>
    2748. 

  2748. The timeout for the send opeartion.<br/>
    2749. 

  2749. If the timeout value is negative, the send operation will not use a timeout.</p>
    2750. 

  2750. 

  2751. <p>@param tag<br/>
    2752. 

  2752. The tag is for your convenience.<br/>
    2753. 

  2753. It is not sent or received over the socket in any manner what-so-ever.<br/>
    2754. 

  2754. It is reported back as a parameter in the udpSocket:didSendDataWithTag:<br/>
    2755. 

  2755. or udpSocket:didNotSendDataWithTag:dueToError: methods.<br/>
    2756. 

  2756. You can use it as an array index, state id, type constant, etc.</p>
    2757. 

  2757. 

  2758. <p>Thread-Safety Note:<br/>
    2759. 

  2759. If the given data parameter is mutable (NSMutableData) then you MUST NOT alter the data while<br/>
    2760. 

  2760. the socket is sending it. In other words, it&rsquo;s not safe to alter the data until after the <a href="#//api/name/delegate">delegate</a> method<br/>
    2761. 

  2761. udpSocket:didSendDataWithTag: or udpSocket:didNotSendDataWithTag:dueToError: is invoked signifying<br/>
    2762. 

  2762. that this particular send operation has completed.<br/>
    2763. 

  2763. This is due to the fact that GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> does NOT copy the data.<br/>
    2764. 

  2764. It simply retains it for performance reasons.<br/>
    2765. 

  2765. Often times, if NSMutableData is passed, it is because a request/response was built up in memory.<br/>
    2766. 

  2766. Copying this data adds an unwanted/unneeded overhead.<br/>
    2767. 

  2767. If you need to write data from an immutable buffer, and you need to alter the buffer before the socket<br/>
    2768. 

  2768. completes sending the bytes (which is NOT immediately after this method returns, but rather at a later time<br/>
    2769. 

  2769. when the <a href="#//api/name/delegate">delegate</a> method notifies you), then you should first copy the bytes, and pass the copy to this method.</p>
    2770. 

  2770. 	</div>
    2771. 

  2771. 	
    2772. 

  2772. 	
    2773. 

  2773. 	
    2774. 

  2774. 	
    2775. 

  2775. 	
    2776. 

  2776. 	
    2777. 

  2777. 	
    2778. 

  2778. 	<div class="method-subsection declared-in-section">
    2779. 

  2779. 		<h4 class="method-subtitle">Declared In</h4>
    2780. 

  2780. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2781. 

  2781. 	</div>				
    2782. 

  2782. 	
    2783. 

  2783. 	
    2784. 

  2784. </div>
    2785. 

  2785. 						
    2786. 

  2786. 						<div class="section-method">
    2787. 

  2787. 	<a name="//api/name/sendData:toHost:port:withTimeout:tag:" title="sendData:toHost:port:withTimeout:tag:"></a>
    2788. 

  2788. 	<h3 class="subsubtitle method-title">sendData:toHost:port:withTimeout:tag:</h3>
    2789. 

  2789. 	
    2790. 

  2790. 	
    2791. 

  2791. 	
    2792. 

  2792. 	<div class="method-subsection brief-description">
    2793. 

  2793. 		<p>Asynchronously sends the given data, with the given timeout and tag, to the given host and port.</p>
    2794. 

  2794. 	</div>		
    2795. 

  2795. 	
    2796. 

  2796.     
    2797. 

  2797. 

  2798. 	<div class="method-subsection method-declaration"><code>- (void)sendData:(NSData *)<em>data</em> toHost:(NSString *)<em>host</em> port:(uint16_t)<em>port</em> withTimeout:(NSTimeInterval)<em>timeout</em> tag:(long)<em>tag</em></code></div>
    2799. 

  2799. 

  2800.     
    2801. 

  2801. 	
    2802. 

  2802. 	
    2803. 

  2803. 	
    2804. 

  2804. 	
    2805. 

  2805. 	
    2806. 

  2806. 	
    2807. 

  2807. 	
    2808. 

  2808. 	<div class="method-subsection discussion-section">
    2809. 

  2809. 		<h4 class="method-subtitle">Discussion</h4>
    2810. 

  2810. 		<p>Asynchronously sends the given data, with the given timeout and tag, to the given host and port.</p>
    2811. 

  2811. 

  2812. <p>This method cannot be used with a connected socket.<br/>
    2813. 

  2813. Recall that connecting is optional for a UDP socket.<br/>
    2814. 

  2814. For connected sockets, data can only be sent to the connected address.<br/>
    2815. 

  2815. For non-connected sockets, the remote destination is specified for each packet.<br/>
    2816. 

  2816. For more information about optionally connecting udp sockets, see the documentation for the connect methods above.</p>
    2817. 

  2817. 

  2818. <p>@param data<br/>
    2819. 

  2819. The data to send.<br/>
    2820. 

  2820. If data is nil or zero-length, this method does nothing.<br/>
    2821. 

  2821. If passing NSMutableData, please read the thread-safety notice below.</p>
    2822. 

  2822. 

  2823. <p>@param host<br/>
    2824. 

  2824. The destination to send the udp packet to.<br/>
    2825. 

  2825. May be specified as a domain name (e.g. &ldquo;deusty.com&rdquo;) or an IP address string (e.g. &ldquo;192.168.0.2&rdquo;).<br/>
    2826. 

  2826. You may also use the convenience strings of &ldquo;loopback&rdquo; or &ldquo;localhost&rdquo;.</p>
    2827. 

  2827. 

  2828. <p>@param port<br/>
    2829. 

  2829. The port of the host to send to.</p>
    2830. 

  2830. 

  2831. <p>@param timeout<br/>
    2832. 

  2832. The timeout for the send opeartion.<br/>
    2833. 

  2833. If the timeout value is negative, the send operation will not use a timeout.</p>
    2834. 

  2834. 

  2835. <p>@param tag<br/>
    2836. 

  2836. The tag is for your convenience.<br/>
    2837. 

  2837. It is not sent or received over the socket in any manner what-so-ever.<br/>
    2838. 

  2838. It is reported back as a parameter in the udpSocket:didSendDataWithTag:<br/>
    2839. 

  2839. or udpSocket:didNotSendDataWithTag:dueToError: methods.<br/>
    2840. 

  2840. You can use it as an array index, state id, type constant, etc.</p>
    2841. 

  2841. 

  2842. <p>Thread-Safety Note:<br/>
    2843. 

  2843. If the given data parameter is mutable (NSMutableData) then you MUST NOT alter the data while<br/>
    2844. 

  2844. the socket is sending it. In other words, it&rsquo;s not safe to alter the data until after the <a href="#//api/name/delegate">delegate</a> method<br/>
    2845. 

  2845. udpSocket:didSendDataWithTag: or udpSocket:didNotSendDataWithTag:dueToError: is invoked signifying<br/>
    2846. 

  2846. that this particular send operation has completed.<br/>
    2847. 

  2847. This is due to the fact that GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> does NOT copy the data.<br/>
    2848. 

  2848. It simply retains it for performance reasons.<br/>
    2849. 

  2849. Often times, if NSMutableData is passed, it is because a request/response was built up in memory.<br/>
    2850. 

  2850. Copying this data adds an unwanted/unneeded overhead.<br/>
    2851. 

  2851. If you need to write data from an immutable buffer, and you need to alter the buffer before the socket<br/>
    2852. 

  2852. completes sending the bytes (which is NOT immediately after this method returns, but rather at a later time<br/>
    2853. 

  2853. when the <a href="#//api/name/delegate">delegate</a> method notifies you), then you should first copy the bytes, and pass the copy to this method.</p>
    2854. 

  2854. 	</div>
    2855. 

  2855. 	
    2856. 

  2856. 	
    2857. 

  2857. 	
    2858. 

  2858. 	
    2859. 

  2859. 	
    2860. 

  2860. 	
    2861. 

  2861. 	
    2862. 

  2862. 	<div class="method-subsection declared-in-section">
    2863. 

  2863. 		<h4 class="method-subtitle">Declared In</h4>
    2864. 

  2864. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2865. 

  2865. 	</div>				
    2866. 

  2866. 	
    2867. 

  2867. 	
    2868. 

  2868. </div>
    2869. 

  2869. 						
    2870. 

  2870. 						<div class="section-method">
    2871. 

  2871. 	<a name="//api/name/sendData:withTimeout:tag:" title="sendData:withTimeout:tag:"></a>
    2872. 

  2872. 	<h3 class="subsubtitle method-title">sendData:withTimeout:tag:</h3>
    2873. 

  2873. 	
    2874. 

  2874. 	
    2875. 

  2875. 	
    2876. 

  2876. 	<div class="method-subsection brief-description">
    2877. 

  2877. 		<p>Asynchronously sends the given data, with the given timeout and tag.</p>
    2878. 

  2878. 	</div>		
    2879. 

  2879. 	
    2880. 

  2880.     
    2881. 

  2881. 

  2882. 	<div class="method-subsection method-declaration"><code>- (void)sendData:(NSData *)<em>data</em> withTimeout:(NSTimeInterval)<em>timeout</em> tag:(long)<em>tag</em></code></div>
    2883. 

  2883. 

  2884.     
    2885. 

  2885. 	
    2886. 

  2886. 	
    2887. 

  2887. 	
    2888. 

  2888. 	
    2889. 

  2889. 	
    2890. 

  2890. 	
    2891. 

  2891. 	
    2892. 

  2892. 	<div class="method-subsection discussion-section">
    2893. 

  2893. 		<h4 class="method-subtitle">Discussion</h4>
    2894. 

  2894. 		<p>Asynchronously sends the given data, with the given timeout and tag.</p>
    2895. 

  2895. 

  2896. <p>This method may only be used with a connected socket.<br/>
    2897. 

  2897. Recall that connecting is optional for a UDP socket.<br/>
    2898. 

  2898. For connected sockets, data can only be sent to the connected address.<br/>
    2899. 

  2899. For non-connected sockets, the remote destination is specified for each packet.<br/>
    2900. 

  2900. For more information about optionally connecting udp sockets, see the documentation for the connect methods above.</p>
    2901. 

  2901. 

  2902. <p>@param data<br/>
    2903. 

  2903. The data to send.<br/>
    2904. 

  2904. If data is nil or zero-length, this method does nothing.<br/>
    2905. 

  2905. If passing NSMutableData, please read the thread-safety notice below.</p>
    2906. 

  2906. 

  2907. <p>@param timeout<br/>
    2908. 

  2908. The timeout for the send opeartion.<br/>
    2909. 

  2909. If the timeout value is negative, the send operation will not use a timeout.</p>
    2910. 

  2910. 

  2911. <p>@param tag<br/>
    2912. 

  2912. The tag is for your convenience.<br/>
    2913. 

  2913. It is not sent or received over the socket in any manner what-so-ever.<br/>
    2914. 

  2914. It is reported back as a parameter in the udpSocket:didSendDataWithTag:<br/>
    2915. 

  2915. or udpSocket:didNotSendDataWithTag:dueToError: methods.<br/>
    2916. 

  2916. You can use it as an array index, state id, type constant, etc.</p>
    2917. 

  2917. 

  2918. <p>Thread-Safety Note:<br/>
    2919. 

  2919. If the given data parameter is mutable (NSMutableData) then you MUST NOT alter the data while<br/>
    2920. 

  2920. the socket is sending it. In other words, it&rsquo;s not safe to alter the data until after the <a href="#//api/name/delegate">delegate</a> method<br/>
    2921. 

  2921. udpSocket:didSendDataWithTag: or udpSocket:didNotSendDataWithTag:dueToError: is invoked signifying<br/>
    2922. 

  2922. that this particular send operation has completed.<br/>
    2923. 

  2923. This is due to the fact that GCD<a href="../Classes/AsyncUdpSocket.html">AsyncUdpSocket</a> does NOT copy the data.<br/>
    2924. 

  2924. It simply retains it for performance reasons.<br/>
    2925. 

  2925. Often times, if NSMutableData is passed, it is because a request/response was built up in memory.<br/>
    2926. 

  2926. Copying this data adds an unwanted/unneeded overhead.<br/>
    2927. 

  2927. If you need to write data from an immutable buffer, and you need to alter the buffer before the socket<br/>
    2928. 

  2928. completes sending the bytes (which is NOT immediately after this method returns, but rather at a later time<br/>
    2929. 

  2929. when the <a href="#//api/name/delegate">delegate</a> method notifies you), then you should first copy the bytes, and pass the copy to this method.</p>
    2930. 

  2930. 	</div>
    2931. 

  2931. 	
    2932. 

  2932. 	
    2933. 

  2933. 	
    2934. 

  2934. 	
    2935. 

  2935. 	
    2936. 

  2936. 	
    2937. 

  2937. 	
    2938. 

  2938. 	<div class="method-subsection declared-in-section">
    2939. 

  2939. 		<h4 class="method-subtitle">Declared In</h4>
    2940. 

  2940. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    2941. 

  2941. 	</div>				
    2942. 

  2942. 	
    2943. 

  2943. 	
    2944. 

  2944. </div>
    2945. 

  2945. 						
    2946. 

  2946. 						<div class="section-method">
    2947. 

  2947. 	<a name="//api/name/setDelegate:" title="setDelegate:"></a>
    2948. 

  2948. 	<h3 class="subsubtitle method-title">setDelegate:</h3>
    2949. 

  2949. 	
    2950. 

  2950. 	
    2951. 

  2951. 

  2952. 	<div class="method-subsection method-declaration"><code>- (void)setDelegate:(id)<em>delegate</em></code></div>
    2953. 

  2953. 

  2954.     
    2955. 

  2955. </div>
    2956. 

  2956. 						
    2957. 

  2957. 						<div class="section-method">
    2958. 

  2958. 	<a name="//api/name/setDelegate:delegateQueue:" title="setDelegate:delegateQueue:"></a>
    2959. 

  2959. 	<h3 class="subsubtitle method-title">setDelegate:delegateQueue:</h3>
    2960. 

  2960. 	
    2961. 

  2961. 	
    2962. 

  2962. 

  2963. 	<div class="method-subsection method-declaration"><code>- (void)setDelegate:(id)<em>delegate</em> delegateQueue:(dispatch_queue_t)<em>delegateQueue</em></code></div>
    2964. 

  2964. 

  2965.     
    2966. 

  2966. </div>
    2967. 

  2967. 						
    2968. 

  2968. 						<div class="section-method">
    2969. 

  2969. 	<a name="//api/name/setDelegateQueue:" title="setDelegateQueue:"></a>
    2970. 

  2970. 	<h3 class="subsubtitle method-title">setDelegateQueue:</h3>
    2971. 

  2971. 	
    2972. 

  2972. 	
    2973. 

  2973. 

  2974. 	<div class="method-subsection method-declaration"><code>- (void)setDelegateQueue:(dispatch_queue_t)<em>delegateQueue</em></code></div>
    2975. 

  2975. 

  2976.     
    2977. 

  2977. </div>
    2978. 

  2978. 						
    2979. 

  2979. 						<div class="section-method">
    2980. 

  2980. 	<a name="//api/name/setIPVersionNeutral" title="setIPVersionNeutral"></a>
    2981. 

  2981. 	<h3 class="subsubtitle method-title">setIPVersionNeutral</h3>
    2982. 

  2982. 	
    2983. 

  2983. 	
    2984. 

  2984. 

  2985. 	<div class="method-subsection method-declaration"><code>- (void)setIPVersionNeutral</code></div>
    2986. 

  2986. 

  2987.     
    2988. 

  2988. </div>
    2989. 

  2989. 						
    2990. 

  2990. 						<div class="section-method">
    2991. 

  2991. 	<a name="//api/name/setIPv4Enabled:" title="setIPv4Enabled:"></a>
    2992. 

  2992. 	<h3 class="subsubtitle method-title">setIPv4Enabled:</h3>
    2993. 

  2993. 	
    2994. 

  2994. 	
    2995. 

  2995. 

  2996. 	<div class="method-subsection method-declaration"><code>- (void)setIPv4Enabled:(BOOL)<em>flag</em></code></div>
    2997. 

  2997. 

  2998.     
    2999. 

  2999. </div>
    3000. 

  3000. 						
    3001. 

  3001. 						<div class="section-method">
    3002. 

  3002. 	<a name="//api/name/setIPv6Enabled:" title="setIPv6Enabled:"></a>
    3003. 

  3003. 	<h3 class="subsubtitle method-title">setIPv6Enabled:</h3>
    3004. 

  3004. 	
    3005. 

  3005. 	
    3006. 

  3006. 

  3007. 	<div class="method-subsection method-declaration"><code>- (void)setIPv6Enabled:(BOOL)<em>flag</em></code></div>
    3008. 

  3008. 

  3009.     
    3010. 

  3010. </div>
    3011. 

  3011. 						
    3012. 

  3012. 						<div class="section-method">
    3013. 

  3013. 	<a name="//api/name/setMaxReceiveIPv4BufferSize:" title="setMaxReceiveIPv4BufferSize:"></a>
    3014. 

  3014. 	<h3 class="subsubtitle method-title">setMaxReceiveIPv4BufferSize:</h3>
    3015. 

  3015. 	
    3016. 

  3016. 	
    3017. 

  3017. 

  3018. 	<div class="method-subsection method-declaration"><code>- (void)setMaxReceiveIPv4BufferSize:(uint16_t)<em>max</em></code></div>
    3019. 

  3019. 

  3020.     
    3021. 

  3021. </div>
    3022. 

  3022. 						
    3023. 

  3023. 						<div class="section-method">
    3024. 

  3024. 	<a name="//api/name/setMaxReceiveIPv6BufferSize:" title="setMaxReceiveIPv6BufferSize:"></a>
    3025. 

  3025. 	<h3 class="subsubtitle method-title">setMaxReceiveIPv6BufferSize:</h3>
    3026. 

  3026. 	
    3027. 

  3027. 	
    3028. 

  3028. 

  3029. 	<div class="method-subsection method-declaration"><code>- (void)setMaxReceiveIPv6BufferSize:(uint32_t)<em>max</em></code></div>
    3030. 

  3030. 

  3031.     
    3032. 

  3032. </div>
    3033. 

  3033. 						
    3034. 

  3034. 						<div class="section-method">
    3035. 

  3035. 	<a name="//api/name/setPreferIPv4" title="setPreferIPv4"></a>
    3036. 

  3036. 	<h3 class="subsubtitle method-title">setPreferIPv4</h3>
    3037. 

  3037. 	
    3038. 

  3038. 	
    3039. 

  3039. 

  3040. 	<div class="method-subsection method-declaration"><code>- (void)setPreferIPv4</code></div>
    3041. 

  3041. 

  3042.     
    3043. 

  3043. </div>
    3044. 

  3044. 						
    3045. 

  3045. 						<div class="section-method">
    3046. 

  3046. 	<a name="//api/name/setPreferIPv6" title="setPreferIPv6"></a>
    3047. 

  3047. 	<h3 class="subsubtitle method-title">setPreferIPv6</h3>
    3048. 

  3048. 	
    3049. 

  3049. 	
    3050. 

  3050. 

  3051. 	<div class="method-subsection method-declaration"><code>- (void)setPreferIPv6</code></div>
    3052. 

  3052. 

  3053.     
    3054. 

  3054. </div>
    3055. 

  3055. 						
    3056. 

  3056. 						<div class="section-method">
    3057. 

  3057. 	<a name="//api/name/setReceiveFilter:withQueue:" title="setReceiveFilter:withQueue:"></a>
    3058. 

  3058. 	<h3 class="subsubtitle method-title">setReceiveFilter:withQueue:</h3>
    3059. 

  3059. 	
    3060. 

  3060. 	
    3061. 

  3061. 	
    3062. 

  3062. 	<div class="method-subsection brief-description">
    3063. 

  3063. 		<p>You may optionally set a receive filter for the socket.<br/>
    3064. 

  3064. This receive filter may be set to run in its own queue (independent of <a href="#//api/name/delegate">delegate</a> queue).</p>
    3065. 

  3065. 	</div>		
    3066. 

  3066. 	
    3067. 

  3067.     
    3068. 

  3068. 

  3069. 	<div class="method-subsection method-declaration"><code>- (void)setReceiveFilter:(GCDAsyncUdpSocketReceiveFilterBlock)<em>filterBlock</em> withQueue:(dispatch_queue_t)<em>filterQueue</em></code></div>
    3070. 

  3070. 

  3071.     
    3072. 

  3072. 	
    3073. 

  3073. 	
    3074. 

  3074. 	
    3075. 

  3075. 	
    3076. 

  3076. 	
    3077. 

  3077. 	
    3078. 

  3078. 	
    3079. 

  3079. 	<div class="method-subsection discussion-section">
    3080. 

  3080. 		<h4 class="method-subtitle">Discussion</h4>
    3081. 

  3081. 		<p>You may optionally set a receive filter for the socket.<br/>
    3082. 

  3082. This receive filter may be set to run in its own queue (independent of <a href="#//api/name/delegate">delegate</a> queue).</p>
    3083. 

  3083. 

  3084. <p>A filter can provide several useful features.</p>
    3085. 

  3085. 

  3086. <ol>
    3087. 

  3087. <li><p>Many times udp packets need to be parsed.<br/>
    3088. 

  3088. Since the filter can run in its own independent queue, you can parallelize this parsing quite easily.<br/>
    3089. 

  3089. The end result is a parallel socket io, datagram parsing, and packet processing.</p></li>
    3090. 

  3090. <li><p>Many times udp packets are discarded because they are duplicate/unneeded/unsolicited.<br/>
    3091. 

  3091. The filter can prevent such packets from arriving at the <a href="#//api/name/delegate">delegate</a>.<br/>
    3092. 

  3092. And because the filter can run in its own independent queue, this doesn&rsquo;t slow down the <a href="#//api/name/delegate">delegate</a>.</p></li>
    3093. 

  3093. <li><p>Since the udp protocol does not guarantee delivery, udp packets may be lost.<br/>
    3094. 

  3094. Many protocols built atop udp thus provide various resend/re-request algorithms.<br/>
    3095. 

  3095. This sometimes results in duplicate packets arriving.<br/>
    3096. 

  3096. A filter may allow you to architect the duplicate detection code to run in parallel to normal processing.</p></li>
    3097. 

  3097. <li><p>Since the udp socket may be connectionless, its possible for unsolicited packets to arrive.<br/>
    3098. 

  3098. Such packets need to be ignored.</p></li>
    3099. 

  3099. <li><p>Sometimes traffic shapers are needed to simulate real world environments.<br/>
    3100. 

  3100. A filter allows you to write custom code to simulate such environments.<br/>
    3101. 

  3101. The ability to code this yourself is especially helpful when your simulated environment<br/>
    3102. 

  3102. is more complicated than simple traffic shaping (e.g. simulating a cone port restricted router),<br/>
    3103. 

  3103. or the system tools to handle this aren&rsquo;t available (e.g. on a mobile device).</p></li>
    3104. 

  3104. </ol>
    3105. 

  3105. 

  3106. 

  3107. <p>Example:</p>
    3108. 

  3108. 

  3109. <p>GCDAsyncUdpSocketReceiveFilterBlock filter = ^BOOL (NSData <em>data, NSData </em>address, id *context) {</p>
    3110. 

  3110. 

  3111. <p>MyProtocolMessage *msg = [MyProtocol parseMessage:data];</p>
    3112. 

  3112. 

  3113. <p>*context = response;<br/>
    3114. 

  3114. return (response != nil);<br/>
    3115. 

  3115. };<br/>
    3116. 

  3116. [udpSocket setReceiveFilter:filter withQueue:myParsingQueue];</p>
    3117. 

  3117. 

  3118. <p>For more information about GCDAsyncUdpSocketReceiveFilterBlock, see the documentation for its typedef.<br/>
    3119. 

  3119. To remove a previously set filter, invoke this method and pass a nil filterBlock and NULL filterQueue.</p>
    3120. 

  3120. 

  3121. <p>Note: This method invokes <a href="#//api/name/setReceiveFilter:withQueue:isAsynchronous:">setReceiveFilter:withQueue:isAsynchronous:</a> (documented below),<br/>
    3122. 

  3122. passing YES for the isAsynchronous parameter.</p>
    3123. 

  3123. 	</div>
    3124. 

  3124. 	
    3125. 

  3125. 	
    3126. 

  3126. 	
    3127. 

  3127. 	
    3128. 

  3128. 	
    3129. 

  3129. 	
    3130. 

  3130. 	
    3131. 

  3131. 	<div class="method-subsection declared-in-section">
    3132. 

  3132. 		<h4 class="method-subtitle">Declared In</h4>
    3133. 

  3133. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    3134. 

  3134. 	</div>				
    3135. 

  3135. 	
    3136. 

  3136. 	
    3137. 

  3137. </div>
    3138. 

  3138. 						
    3139. 

  3139. 						<div class="section-method">
    3140. 

  3140. 	<a name="//api/name/setReceiveFilter:withQueue:isAsynchronous:" title="setReceiveFilter:withQueue:isAsynchronous:"></a>
    3141. 

  3141. 	<h3 class="subsubtitle method-title">setReceiveFilter:withQueue:isAsynchronous:</h3>
    3142. 

  3142. 	
    3143. 

  3143. 	
    3144. 

  3144. 	
    3145. 

  3145. 	<div class="method-subsection brief-description">
    3146. 

  3146. 		<p>The receive filter can be run via dispatch_async or dispatch_sync.<br/>
    3147. 

  3147. Most typical situations call for asynchronous operation.</p>
    3148. 

  3148. 	</div>		
    3149. 

  3149. 	
    3150. 

  3150.     
    3151. 

  3151. 

  3152. 	<div class="method-subsection method-declaration"><code>- (void)setReceiveFilter:(GCDAsyncUdpSocketReceiveFilterBlock)<em>filterBlock</em> withQueue:(dispatch_queue_t)<em>filterQueue</em> isAsynchronous:(BOOL)<em>isAsynchronous</em></code></div>
    3153. 

  3153. 

  3154.     
    3155. 

  3155. 	
    3156. 

  3156. 	
    3157. 

  3157. 	
    3158. 

  3158. 	
    3159. 

  3159. 	
    3160. 

  3160. 	
    3161. 

  3161. 	
    3162. 

  3162. 	<div class="method-subsection discussion-section">
    3163. 

  3163. 		<h4 class="method-subtitle">Discussion</h4>
    3164. 

  3164. 		<p>The receive filter can be run via dispatch_async or dispatch_sync.<br/>
    3165. 

  3165. Most typical situations call for asynchronous operation.</p>
    3166. 

  3166. 

  3167. <p>However, there are a few situations in which synchronous operation is preferred.<br/>
    3168. 

  3168. Such is the case when the filter is extremely minimal and fast.<br/>
    3169. 

  3169. This is because dispatch_sync is faster than dispatch_async.</p>
    3170. 

  3170. 

  3171. <p>If you choose synchronous operation, be aware of possible deadlock conditions.<br/>
    3172. 

  3172. Since the socket queue is executing your block via dispatch_sync,<br/>
    3173. 

  3173. then you cannot perform any tasks which may invoke dispatch_sync on the socket queue.<br/>
    3174. 

  3174. For example, you can&rsquo;t query properties on the socket.</p>
    3175. 

  3175. 	</div>
    3176. 

  3176. 	
    3177. 

  3177. 	
    3178. 

  3178. 	
    3179. 

  3179. 	
    3180. 

  3180. 	
    3181. 

  3181. 	
    3182. 

  3182. 	
    3183. 

  3183. 	<div class="method-subsection declared-in-section">
    3184. 

  3184. 		<h4 class="method-subtitle">Declared In</h4>
    3185. 

  3185. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    3186. 

  3186. 	</div>				
    3187. 

  3187. 	
    3188. 

  3188. 	
    3189. 

  3189. </div>
    3190. 

  3190. 						
    3191. 

  3191. 						<div class="section-method">
    3192. 

  3192. 	<a name="//api/name/setSendFilter:withQueue:" title="setSendFilter:withQueue:"></a>
    3193. 

  3193. 	<h3 class="subsubtitle method-title">setSendFilter:withQueue:</h3>
    3194. 

  3194. 	
    3195. 

  3195. 	
    3196. 

  3196. 	
    3197. 

  3197. 	<div class="method-subsection brief-description">
    3198. 

  3198. 		<p>You may optionally set a send filter for the socket.<br/>
    3199. 

  3199. A filter can provide several interesting possibilities:</p>
    3200. 

  3200. 	</div>		
    3201. 

  3201. 	
    3202. 

  3202.     
    3203. 

  3203. 

  3204. 	<div class="method-subsection method-declaration"><code>- (void)setSendFilter:(GCDAsyncUdpSocketSendFilterBlock)<em>filterBlock</em> withQueue:(dispatch_queue_t)<em>filterQueue</em></code></div>
    3205. 

  3205. 

  3206.     
    3207. 

  3207. 	
    3208. 

  3208. 	
    3209. 

  3209. 	
    3210. 

  3210. 	
    3211. 

  3211. 	
    3212. 

  3212. 	
    3213. 

  3213. 	
    3214. 

  3214. 	<div class="method-subsection discussion-section">
    3215. 

  3215. 		<h4 class="method-subtitle">Discussion</h4>
    3216. 

  3216. 		<p>You may optionally set a send filter for the socket.<br/>
    3217. 

  3217. A filter can provide several interesting possibilities:</p>
    3218. 

  3218. 

  3219. <ol>
    3220. 

  3220. <li><p>Optional caching of resolved addresses for domain names.<br/>
    3221. 

  3221. The cache could later be consulted, resulting in fewer system calls to getaddrinfo.</p></li>
    3222. 

  3222. <li><p>Reusable modules of code for bandwidth monitoring.</p></li>
    3223. 

  3223. <li><p>Sometimes traffic shapers are needed to simulate real world environments.<br/>
    3224. 

  3224. A filter allows you to write custom code to simulate such environments.<br/>
    3225. 

  3225. The ability to code this yourself is especially helpful when your simulated environment<br/>
    3226. 

  3226. is more complicated than simple traffic shaping (e.g. simulating a cone port restricted router),<br/>
    3227. 

  3227. or the system tools to handle this aren&rsquo;t available (e.g. on a mobile device).</p></li>
    3228. 

  3228. </ol>
    3229. 

  3229. 

  3230. 

  3231. <p>For more information about GCDAsyncUdpSocketSendFilterBlock, see the documentation for its typedef.<br/>
    3232. 

  3232. To remove a previously set filter, invoke this method and pass a nil filterBlock and NULL filterQueue.</p>
    3233. 

  3233. 

  3234. <p>Note: This method invokes <a href="#//api/name/setSendFilter:withQueue:isAsynchronous:">setSendFilter:withQueue:isAsynchronous:</a> (documented below),<br/>
    3235. 

  3235. passing YES for the isAsynchronous parameter.</p>
    3236. 

  3236. 	</div>
    3237. 

  3237. 	
    3238. 

  3238. 	
    3239. 

  3239. 	
    3240. 

  3240. 	
    3241. 

  3241. 	
    3242. 

  3242. 	
    3243. 

  3243. 	
    3244. 

  3244. 	<div class="method-subsection declared-in-section">
    3245. 

  3245. 		<h4 class="method-subtitle">Declared In</h4>
    3246. 

  3246. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    3247. 

  3247. 	</div>				
    3248. 

  3248. 	
    3249. 

  3249. 	
    3250. 

  3250. </div>
    3251. 

  3251. 						
    3252. 

  3252. 						<div class="section-method">
    3253. 

  3253. 	<a name="//api/name/setSendFilter:withQueue:isAsynchronous:" title="setSendFilter:withQueue:isAsynchronous:"></a>
    3254. 

  3254. 	<h3 class="subsubtitle method-title">setSendFilter:withQueue:isAsynchronous:</h3>
    3255. 

  3255. 	
    3256. 

  3256. 	
    3257. 

  3257. 	
    3258. 

  3258. 	<div class="method-subsection brief-description">
    3259. 

  3259. 		<p>The receive filter can be run via dispatch_async or dispatch_sync.<br/>
    3260. 

  3260. Most typical situations call for asynchronous operation.</p>
    3261. 

  3261. 	</div>		
    3262. 

  3262. 	
    3263. 

  3263.     
    3264. 

  3264. 

  3265. 	<div class="method-subsection method-declaration"><code>- (void)setSendFilter:(GCDAsyncUdpSocketSendFilterBlock)<em>filterBlock</em> withQueue:(dispatch_queue_t)<em>filterQueue</em> isAsynchronous:(BOOL)<em>isAsynchronous</em></code></div>
    3266. 

  3266. 

  3267.     
    3268. 

  3268. 	
    3269. 

  3269. 	
    3270. 

  3270. 	
    3271. 

  3271. 	
    3272. 

  3272. 	
    3273. 

  3273. 	
    3274. 

  3274. 	
    3275. 

  3275. 	<div class="method-subsection discussion-section">
    3276. 

  3276. 		<h4 class="method-subtitle">Discussion</h4>
    3277. 

  3277. 		<p>The receive filter can be run via dispatch_async or dispatch_sync.<br/>
    3278. 

  3278. Most typical situations call for asynchronous operation.</p>
    3279. 

  3279. 

  3280. <p>However, there are a few situations in which synchronous operation is preferred.<br/>
    3281. 

  3281. Such is the case when the filter is extremely minimal and fast.<br/>
    3282. 

  3282. This is because dispatch_sync is faster than dispatch_async.</p>
    3283. 

  3283. 

  3284. <p>If you choose synchronous operation, be aware of possible deadlock conditions.<br/>
    3285. 

  3285. Since the socket queue is executing your block via dispatch_sync,<br/>
    3286. 

  3286. then you cannot perform any tasks which may invoke dispatch_sync on the socket queue.<br/>
    3287. 

  3287. For example, you can&rsquo;t query properties on the socket.</p>
    3288. 

  3288. 	</div>
    3289. 

  3289. 	
    3290. 

  3290. 	
    3291. 

  3291. 	
    3292. 

  3292. 	
    3293. 

  3293. 	
    3294. 

  3294. 	
    3295. 

  3295. 	
    3296. 

  3296. 	<div class="method-subsection declared-in-section">
    3297. 

  3297. 		<h4 class="method-subtitle">Declared In</h4>
    3298. 

  3298. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    3299. 

  3299. 	</div>				
    3300. 

  3300. 	
    3301. 

  3301. 	
    3302. 

  3302. </div>
    3303. 

  3303. 						
    3304. 

  3304. 						<div class="section-method">
    3305. 

  3305. 	<a name="//api/name/setUserData:" title="setUserData:"></a>
    3306. 

  3306. 	<h3 class="subsubtitle method-title">setUserData:</h3>
    3307. 

  3307. 	
    3308. 

  3308. 	
    3309. 

  3309. 

  3310. 	<div class="method-subsection method-declaration"><code>- (void)setUserData:(id)<em>arbitraryUserData</em></code></div>
    3311. 

  3311. 

  3312.     
    3313. 

  3313. </div>
    3314. 

  3314. 						
    3315. 

  3315. 						<div class="section-method">
    3316. 

  3316. 	<a name="//api/name/socket4FD" title="socket4FD"></a>
    3317. 

  3317. 	<h3 class="subsubtitle method-title">socket4FD</h3>
    3318. 

  3318. 	
    3319. 

  3319. 	
    3320. 

  3320. 

  3321. 	<div class="method-subsection method-declaration"><code>- (int)socket4FD</code></div>
    3322. 

  3322. 

  3323.     
    3324. 

  3324. </div>
    3325. 

  3325. 						
    3326. 

  3326. 						<div class="section-method">
    3327. 

  3327. 	<a name="//api/name/socket6FD" title="socket6FD"></a>
    3328. 

  3328. 	<h3 class="subsubtitle method-title">socket6FD</h3>
    3329. 

  3329. 	
    3330. 

  3330. 	
    3331. 

  3331. 

  3332. 	<div class="method-subsection method-declaration"><code>- (int)socket6FD</code></div>
    3333. 

  3333. 

  3334.     
    3335. 

  3335. </div>
    3336. 

  3336. 						
    3337. 

  3337. 						<div class="section-method">
    3338. 

  3338. 	<a name="//api/name/socketFD" title="socketFD"></a>
    3339. 

  3339. 	<h3 class="subsubtitle method-title">socketFD</h3>
    3340. 

  3340. 	
    3341. 

  3341. 	
    3342. 

  3342. 	
    3343. 

  3343. 	<div class="method-subsection brief-description">
    3344. 

  3344. 		<p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    3345. 

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

  3346. 	</div>		
    3347. 

  3347. 	
    3348. 

  3348.     
    3349. 

  3349. 

  3350. 	<div class="method-subsection method-declaration"><code>- (int)socketFD</code></div>
    3351. 

  3351. 

  3352.     
    3353. 

  3353. 	
    3354. 

  3354. 	
    3355. 

  3355. 	
    3356. 

  3356. 	
    3357. 

  3357. 	
    3358. 

  3358. 	
    3359. 

  3359. 	
    3360. 

  3360. 	<div class="method-subsection discussion-section">
    3361. 

  3361. 		<h4 class="method-subtitle">Discussion</h4>
    3362. 

  3362. 		<p>These methods are only available from within the context of a <a href="#//api/name/performBlock:">performBlock:</a> invocation.<br/>
    3363. 

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

  3364. 

  3365. <p>Provides access to the socket&rsquo;s file descriptor(s).<br/>
    3366. 

  3366. If the socket isn&rsquo;t connected, or explicity bound to a particular interface,<br/>
    3367. 

  3367. it might actually have multiple internal socket file descriptors - one for IPv4 and one for IPv6.</p>
    3368. 

  3368. 	</div>
    3369. 

  3369. 	
    3370. 

  3370. 	
    3371. 

  3371. 	
    3372. 

  3372. 	
    3373. 

  3373. 	
    3374. 

  3374. 	
    3375. 

  3375. 	
    3376. 

  3376. 	<div class="method-subsection declared-in-section">
    3377. 

  3377. 		<h4 class="method-subtitle">Declared In</h4>
    3378. 

  3378. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    3379. 

  3379. 	</div>				
    3380. 

  3380. 	
    3381. 

  3381. 	
    3382. 

  3382. </div>
    3383. 

  3383. 						
    3384. 

  3384. 						<div class="section-method">
    3385. 

  3385. 	<a name="//api/name/synchronouslySetDelegate:" title="synchronouslySetDelegate:"></a>
    3386. 

  3386. 	<h3 class="subsubtitle method-title">synchronouslySetDelegate:</h3>
    3387. 

  3387. 	
    3388. 

  3388. 	
    3389. 

  3389. 

  3390. 	<div class="method-subsection method-declaration"><code>- (void)synchronouslySetDelegate:(id)<em>delegate</em></code></div>
    3391. 

  3391. 

  3392.     
    3393. 

  3393. </div>
    3394. 

  3394. 						
    3395. 

  3395. 						<div class="section-method">
    3396. 

  3396. 	<a name="//api/name/synchronouslySetDelegate:delegateQueue:" title="synchronouslySetDelegate:delegateQueue:"></a>
    3397. 

  3397. 	<h3 class="subsubtitle method-title">synchronouslySetDelegate:delegateQueue:</h3>
    3398. 

  3398. 	
    3399. 

  3399. 	
    3400. 

  3400. 

  3401. 	<div class="method-subsection method-declaration"><code>- (void)synchronouslySetDelegate:(id)<em>delegate</em> delegateQueue:(dispatch_queue_t)<em>delegateQueue</em></code></div>
    3402. 

  3402. 

  3403.     
    3404. 

  3404. </div>
    3405. 

  3405. 						
    3406. 

  3406. 						<div class="section-method">
    3407. 

  3407. 	<a name="//api/name/synchronouslySetDelegateQueue:" title="synchronouslySetDelegateQueue:"></a>
    3408. 

  3408. 	<h3 class="subsubtitle method-title">synchronouslySetDelegateQueue:</h3>
    3409. 

  3409. 	
    3410. 

  3410. 	
    3411. 

  3411. 

  3412. 	<div class="method-subsection method-declaration"><code>- (void)synchronouslySetDelegateQueue:(dispatch_queue_t)<em>delegateQueue</em></code></div>
    3413. 

  3413. 

  3414.     
    3415. 

  3415. </div>
    3416. 

  3416. 						
    3417. 

  3417. 						<div class="section-method">
    3418. 

  3418. 	<a name="//api/name/userData" title="userData"></a>
    3419. 

  3419. 	<h3 class="subsubtitle method-title">userData</h3>
    3420. 

  3420. 	
    3421. 

  3421. 	
    3422. 

  3422. 	
    3423. 

  3423. 	<div class="method-subsection brief-description">
    3424. 

  3424. 		<p>User data allows you to associate arbitrary information with the socket.<br/>
    3425. 

  3425. This data is not used internally in any way.</p>
    3426. 

  3426. 	</div>		
    3427. 

  3427. 	
    3428. 

  3428.     
    3429. 

  3429. 

  3430. 	<div class="method-subsection method-declaration"><code>- (id)userData</code></div>
    3431. 

  3431. 

  3432.     
    3433. 

  3433. 	
    3434. 

  3434. 	
    3435. 

  3435. 	
    3436. 

  3436. 	
    3437. 

  3437. 	
    3438. 

  3438. 	
    3439. 

  3439. 	
    3440. 

  3440. 	<div class="method-subsection discussion-section">
    3441. 

  3441. 		<h4 class="method-subtitle">Discussion</h4>
    3442. 

  3442. 		<p>User data allows you to associate arbitrary information with the socket.<br/>
    3443. 

  3443. This data is not used internally in any way.</p>
    3444. 

  3444. 	</div>
    3445. 

  3445. 	
    3446. 

  3446. 	
    3447. 

  3447. 	
    3448. 

  3448. 	
    3449. 

  3449. 	
    3450. 

  3450. 	
    3451. 

  3451. 	
    3452. 

  3452. 	<div class="method-subsection declared-in-section">
    3453. 

  3453. 		<h4 class="method-subtitle">Declared In</h4>
    3454. 

  3454. 		<code class="declared-in-ref">GCDAsyncUdpSocket.h</code><br />
    3455. 

  3455. 	</div>				
    3456. 

  3456. 	
    3457. 

  3457. 	
    3458. 

  3458. </div>
    3459. 

  3459. 						
    3460. 

  3460. 						<div class="section-method">
    3461. 

  3461. 	<a name="//api/name/writeStream" title="writeStream"></a>
    3462. 

  3462. 	<h3 class="subsubtitle method-title">writeStream</h3>
    3463. 

  3463. 	
    3464. 

  3464. 	
    3465. 

  3465. 

  3466. 	<div class="method-subsection method-declaration"><code>- (CFWriteStreamRef)writeStream</code></div>
    3467. 

  3467. 

  3468.     
    3469. 

  3469. </div>
    3470. 

  3470. 						
    3471. 

  3471. 					</div>
    3472. 

  3472. 					
    3473. 

  3473. 					
    3474. 

  3474. 				</div>
    3475. 

  3475. 				<div class="main-navigation navigation-bottom">
    3476. 

  3476. 					<ul>
    3477. 

  3477. 	<li><a href="../index.html">Index</a></li>
    3478. 

  3478. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    3479. 

  3479. </ul>
    3480. 

  3480. 				</div>
    3481. 

  3481. 				<div id="footer">
    3482. 

  3482. 					<hr />
    3483. 

  3483. 					<div class="footer-copyright">
    3484. 

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

  3485. 						
    3486. 

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

  3487. 						
    3488. 

  3488. 					</div>
    3489. 

  3489. 				</div>
    3490. 

  3490. 			</div>
    3491. 

  3491. 		</article>
    3492. 

  3492. 		<script type="text/javascript">
    3493. 

  3493. 			function jumpToChange()
    3494. 

  3494. 			{
    3495. 

  3495. 				window.location.hash = this.options[this.selectedIndex].value;
    3496. 

  3496. 			}
    3497. 

  3497. 			
    3498. 

  3498. 			function toggleTOC()
    3499. 

  3499. 			{
    3500. 

  3500. 				var contents = document.getElementById('contents');
    3501. 

  3501. 				var tocContainer = document.getElementById('tocContainer');
    3502. 

  3502. 				
    3503. 

  3503. 				if (this.getAttribute('class') == 'open')
    3504. 

  3504. 				{
    3505. 

  3505. 					this.setAttribute('class', '');
    3506. 

  3506. 					contents.setAttribute('class', '');
    3507. 

  3507. 					tocContainer.setAttribute('class', '');
    3508. 

  3508. 					
    3509. 

  3509. 					window.name = "hideTOC";
    3510. 

  3510. 				}
    3511. 

  3511. 				else
    3512. 

  3512. 				{
    3513. 

  3513. 					this.setAttribute('class', 'open');
    3514. 

  3514. 					contents.setAttribute('class', 'isShowingTOC');
    3515. 

  3515. 					tocContainer.setAttribute('class', 'isShowingTOC');
    3516. 

  3516. 					
    3517. 

  3517. 					window.name = "";
    3518. 

  3518. 				}
    3519. 

  3519. 				return false;
    3520. 

  3520. 			}
    3521. 

  3521. 			
    3522. 

  3522. 			function toggleTOCEntryChildren(e)
    3523. 

  3523. 			{
    3524. 

  3524. 				e.stopPropagation();
    3525. 

  3525. 				var currentClass = this.getAttribute('class');
    3526. 

  3526. 				if (currentClass == 'children') {
    3527. 

  3527. 					this.setAttribute('class', 'children open');
    3528. 

  3528. 				}
    3529. 

  3529. 				else if (currentClass == 'children open') {
    3530. 

  3530. 					this.setAttribute('class', 'children');
    3531. 

  3531. 				}
    3532. 

  3532. 				return false;
    3533. 

  3533. 			}
    3534. 

  3534. 			
    3535. 

  3535. 			function tocEntryClick(e)
    3536. 

  3536. 			{
    3537. 

  3537. 				e.stopPropagation();
    3538. 

  3538. 				return true;
    3539. 

  3539. 			}
    3540. 

  3540. 			
    3541. 

  3541. 			function init()
    3542. 

  3542. 			{
    3543. 

  3543. 				var selectElement = document.getElementById('jumpTo');
    3544. 

  3544. 				selectElement.addEventListener('change', jumpToChange, false);
    3545. 

  3545. 				
    3546. 

  3546. 				var tocButton = document.getElementById('table_of_contents');
    3547. 

  3547. 				tocButton.addEventListener('click', toggleTOC, false);
    3548. 

  3548. 				
    3549. 

  3549. 				var taskTreeItem = document.getElementById('task_treeitem');
    3550. 

  3550. 				if (taskTreeItem.getElementsByTagName('li').length > 0)
    3551. 

  3551. 				{
    3552. 

  3552. 					taskTreeItem.setAttribute('class', 'children');
    3553. 

  3553. 					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
    3554. 

  3554. 				}
    3555. 

  3555. 				
    3556. 

  3556. 				var tocList = document.getElementById('toc');
    3557. 

  3557. 				
    3558. 

  3558. 				var tocEntries = tocList.getElementsByTagName('li');
    3559. 

  3559. 				for (var i = 0; i < tocEntries.length; i++) {
    3560. 

  3560. 					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
    3561. 

  3561. 				}
    3562. 

  3562. 				
    3563. 

  3563. 				var tocLinks = tocList.getElementsByTagName('a');
    3564. 

  3564. 				for (var i = 0; i < tocLinks.length; i++) {
    3565. 

  3565. 					tocLinks[i].addEventListener('click', tocEntryClick, false);
    3566. 

  3566. 				}
    3567. 

  3567. 				
    3568. 

  3568. 				if (window.name == "hideTOC") {
    3569. 

  3569. 					toggleTOC.call(tocButton);
    3570. 

  3570. 				}
    3571. 

  3571. 			}
    3572. 

  3572. 			
    3573. 

  3573. 			window.onload = init;
    3574. 

  3574. 			
    3575. 

  3575. 			// If showing in Xcode, hide the TOC and Header
    3576. 

  3576. 			if (navigator.userAgent.match(/xcode/i)) {
    3577. 

  3577. 				document.getElementById("contents").className = "hideInXcode"
    3578. 

  3578. 				document.getElementById("tocContainer").className = "hideInXcode"
    3579. 

  3579. 				document.getElementById("top_header").className = "hideInXcode"
    3580. 

  3580. 			}
    3581. 

  3581. 			
    3582. 

  3582. 		</script>
    3583. 

  3583. 	</body>
    3584. 

  3584. </html>
    3585.