NetworkReachabilityManager.html 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>NetworkReachabilityManager Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/NetworkReachabilityManager" class="dashAnchor"></a>
  16. <a title="NetworkReachabilityManager Class Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire 5.8.0 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png" alt="GitHub"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png" alt="Dash"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" alt=""/>
  45. NetworkReachabilityManager Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  208. </li>
  209. <li class="nav-group-task">
  210. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  211. </li>
  212. <li class="nav-group-task">
  213. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  214. </li>
  215. </ul>
  216. </li>
  217. <li class="nav-group-name">
  218. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  219. <ul class="nav-group-tasks">
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  222. </li>
  223. </ul>
  224. </li>
  225. <li class="nav-group-name">
  226. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  227. <ul class="nav-group-tasks">
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  260. </li>
  261. </ul>
  262. </li>
  263. <li class="nav-group-name">
  264. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  265. <ul class="nav-group-tasks">
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  319. </li>
  320. </ul>
  321. </li>
  322. <li class="nav-group-name">
  323. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  324. <ul class="nav-group-tasks">
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  387. </li>
  388. <li class="nav-group-task">
  389. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  390. </li>
  391. <li class="nav-group-task">
  392. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  393. </li>
  394. <li class="nav-group-task">
  395. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  396. </li>
  397. </ul>
  398. </li>
  399. <li class="nav-group-name">
  400. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  401. <ul class="nav-group-tasks">
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  485. </li>
  486. <li class="nav-group-task">
  487. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  488. </li>
  489. <li class="nav-group-task">
  490. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  491. </li>
  492. <li class="nav-group-task">
  493. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  494. </li>
  495. <li class="nav-group-task">
  496. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  497. </li>
  498. <li class="nav-group-task">
  499. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  500. </li>
  501. <li class="nav-group-task">
  502. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  503. </li>
  504. <li class="nav-group-task">
  505. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  506. </li>
  507. </ul>
  508. </li>
  509. <li class="nav-group-name">
  510. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  511. <ul class="nav-group-tasks">
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  514. </li>
  515. <li class="nav-group-task">
  516. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  517. </li>
  518. <li class="nav-group-task">
  519. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  520. </li>
  521. <li class="nav-group-task">
  522. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  523. </li>
  524. <li class="nav-group-task">
  525. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  526. </li>
  527. <li class="nav-group-task">
  528. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  529. </li>
  530. <li class="nav-group-task">
  531. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  532. </li>
  533. </ul>
  534. </li>
  535. </ul>
  536. </nav>
  537. <article class="main-content">
  538. <section class="section">
  539. <div class="section-content top-matter">
  540. <h1>NetworkReachabilityManager</h1>
  541. <div class="declaration">
  542. <div class="language">
  543. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">NetworkReachabilityManager</span></code></pre>
  544. </div>
  545. </div>
  546. <p>The <code>NetworkReachabilityManager</code> class listens for reachability changes of hosts and addresses for both cellular and
  547. WiFi network interfaces.</p>
  548. <p>Reachability can be used to determine background information about why a network operation failed, or to retry
  549. network requests when a connection is established. It should not be used to prevent a user from initiating a network
  550. request, as it&rsquo;s possible that an initial request may be required to establish reachability.</p>
  551. </div>
  552. </section>
  553. <section class="section">
  554. <div class="section-content">
  555. <div class="task-group">
  556. <ul class="item-container">
  557. <li class="item">
  558. <div>
  559. <code>
  560. <a name="/s:9Alamofire26NetworkReachabilityManagerC0bC6StatusO"></a>
  561. <a name="//apple_ref/swift/Enum/NetworkReachabilityStatus" class="dashAnchor"></a>
  562. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC0bC6StatusO">NetworkReachabilityStatus</a>
  563. </code>
  564. </div>
  565. <div class="height-container">
  566. <div class="pointer-container"></div>
  567. <section class="section">
  568. <div class="pointer"></div>
  569. <div class="abstract">
  570. <p>Defines the various states of network reachability.</p>
  571. <a href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html" class="slightly-smaller">See more</a>
  572. </div>
  573. <div class="declaration">
  574. <h4>Declaration</h4>
  575. <div class="language">
  576. <p class="aside-title">Swift</p>
  577. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">NetworkReachabilityStatus</span></code></pre>
  578. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt"><a href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a></span><span class="o">.</span><span class="kt">NetworkReachabilityStatus</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>
  579. </div>
  580. </div>
  581. </section>
  582. </div>
  583. </li>
  584. <li class="item">
  585. <div>
  586. <code>
  587. <a name="/s:9Alamofire26NetworkReachabilityManagerC8Listenera"></a>
  588. <a name="//apple_ref/swift/Alias/Listener" class="dashAnchor"></a>
  589. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC8Listenera">Listener</a>
  590. </code>
  591. </div>
  592. <div class="height-container">
  593. <div class="pointer-container"></div>
  594. <section class="section">
  595. <div class="pointer"></div>
  596. <div class="abstract">
  597. <p>A closure executed when the network reachability status changes. The closure takes a single argument: the
  598. network reachability status.</p>
  599. </div>
  600. <div class="declaration">
  601. <h4>Declaration</h4>
  602. <div class="language">
  603. <p class="aside-title">Swift</p>
  604. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Listener</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">NetworkReachabilityStatus</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span></code></pre>
  605. </div>
  606. </div>
  607. </section>
  608. </div>
  609. </li>
  610. <li class="item">
  611. <div>
  612. <code>
  613. <a name="/s:9Alamofire26NetworkReachabilityManagerC7defaultACSgvpZ"></a>
  614. <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
  615. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC7defaultACSgvpZ">default</a>
  616. </code>
  617. </div>
  618. <div class="height-container">
  619. <div class="pointer-container"></div>
  620. <section class="section">
  621. <div class="pointer"></div>
  622. <div class="abstract">
  623. <p>Default <code>NetworkReachabilityManager</code> for the zero address and a <code>listenerQueue</code> of <code>.main</code>.</p>
  624. </div>
  625. <div class="declaration">
  626. <h4>Declaration</h4>
  627. <div class="language">
  628. <p class="aside-title">Swift</p>
  629. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">let</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span><span class="p">:</span> <span class="kt">NetworkReachabilityManager</span><span class="p">?</span></code></pre>
  630. </div>
  631. </div>
  632. </section>
  633. </div>
  634. </li>
  635. </ul>
  636. </div>
  637. <div class="task-group">
  638. <div class="task-name-container">
  639. <a name="/Properties"></a>
  640. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  641. <div class="section-name-container">
  642. <a class="section-name-link" href="#/Properties"></a>
  643. <h3 class="section-name"><span>Properties</span>
  644. </h3>
  645. </div>
  646. </div>
  647. <ul class="item-container">
  648. <li class="item">
  649. <div>
  650. <code>
  651. <a name="/s:9Alamofire26NetworkReachabilityManagerC11isReachableSbvp"></a>
  652. <a name="//apple_ref/swift/Property/isReachable" class="dashAnchor"></a>
  653. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC11isReachableSbvp">isReachable</a>
  654. </code>
  655. </div>
  656. <div class="height-container">
  657. <div class="pointer-container"></div>
  658. <section class="section">
  659. <div class="pointer"></div>
  660. <div class="abstract">
  661. <p>Whether the network is currently reachable.</p>
  662. </div>
  663. <div class="declaration">
  664. <h4>Declaration</h4>
  665. <div class="language">
  666. <p class="aside-title">Swift</p>
  667. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">isReachable</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  668. </div>
  669. </div>
  670. </section>
  671. </div>
  672. </li>
  673. <li class="item">
  674. <div>
  675. <code>
  676. <a name="/s:9Alamofire26NetworkReachabilityManagerC21isReachableOnCellularSbvp"></a>
  677. <a name="//apple_ref/swift/Property/isReachableOnCellular" class="dashAnchor"></a>
  678. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC21isReachableOnCellularSbvp">isReachableOnCellular</a>
  679. </code>
  680. </div>
  681. <div class="height-container">
  682. <div class="pointer-container"></div>
  683. <section class="section">
  684. <div class="pointer"></div>
  685. <div class="abstract">
  686. <p>Whether the network is currently reachable over the cellular interface.</p>
  687. <div class="aside aside-note">
  688. <p class="aside-title">Note</p>
  689. Using this property to decide whether to make a high or low bandwidth request is not recommended.
  690. Instead, set the <code>allowsCellularAccess</code> on any <code>URLRequest</code>s being issued.
  691. </div>
  692. </div>
  693. <div class="declaration">
  694. <h4>Declaration</h4>
  695. <div class="language">
  696. <p class="aside-title">Swift</p>
  697. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">isReachableOnCellular</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  698. </div>
  699. </div>
  700. </section>
  701. </div>
  702. </li>
  703. <li class="item">
  704. <div>
  705. <code>
  706. <a name="/s:9Alamofire26NetworkReachabilityManagerC27isReachableOnEthernetOrWiFiSbvp"></a>
  707. <a name="//apple_ref/swift/Property/isReachableOnEthernetOrWiFi" class="dashAnchor"></a>
  708. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC27isReachableOnEthernetOrWiFiSbvp">isReachableOnEthernetOrWiFi</a>
  709. </code>
  710. </div>
  711. <div class="height-container">
  712. <div class="pointer-container"></div>
  713. <section class="section">
  714. <div class="pointer"></div>
  715. <div class="abstract">
  716. <p>Whether the network is currently reachable over Ethernet or WiFi interface.</p>
  717. </div>
  718. <div class="declaration">
  719. <h4>Declaration</h4>
  720. <div class="language">
  721. <p class="aside-title">Swift</p>
  722. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">isReachableOnEthernetOrWiFi</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  723. </div>
  724. </div>
  725. </section>
  726. </div>
  727. </li>
  728. <li class="item">
  729. <div>
  730. <code>
  731. <a name="/s:9Alamofire26NetworkReachabilityManagerC17reachabilityQueueSo17OS_dispatch_queueCvp"></a>
  732. <a name="//apple_ref/swift/Property/reachabilityQueue" class="dashAnchor"></a>
  733. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC17reachabilityQueueSo17OS_dispatch_queueCvp">reachabilityQueue</a>
  734. </code>
  735. </div>
  736. <div class="height-container">
  737. <div class="pointer-container"></div>
  738. <section class="section">
  739. <div class="pointer"></div>
  740. <div class="abstract">
  741. <p><code>DispatchQueue</code> on which reachability will update.</p>
  742. </div>
  743. <div class="declaration">
  744. <h4>Declaration</h4>
  745. <div class="language">
  746. <p class="aside-title">Swift</p>
  747. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">reachabilityQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
  748. </div>
  749. </div>
  750. </section>
  751. </div>
  752. </li>
  753. <li class="item">
  754. <div>
  755. <code>
  756. <a name="/s:9Alamofire26NetworkReachabilityManagerC5flagsSo09SCNetworkC5FlagsVSgvp"></a>
  757. <a name="//apple_ref/swift/Property/flags" class="dashAnchor"></a>
  758. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC5flagsSo09SCNetworkC5FlagsVSgvp">flags</a>
  759. </code>
  760. </div>
  761. <div class="height-container">
  762. <div class="pointer-container"></div>
  763. <section class="section">
  764. <div class="pointer"></div>
  765. <div class="abstract">
  766. <p>Flags of the current reachability type, if any.</p>
  767. </div>
  768. <div class="declaration">
  769. <h4>Declaration</h4>
  770. <div class="language">
  771. <p class="aside-title">Swift</p>
  772. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">flags</span><span class="p">:</span> <span class="kt">SCNetworkReachabilityFlags</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  773. </div>
  774. </div>
  775. </section>
  776. </div>
  777. </li>
  778. <li class="item">
  779. <div>
  780. <code>
  781. <a name="/s:9Alamofire26NetworkReachabilityManagerC6statusAC0bC6StatusOvp"></a>
  782. <a name="//apple_ref/swift/Property/status" class="dashAnchor"></a>
  783. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC6statusAC0bC6StatusOvp">status</a>
  784. </code>
  785. </div>
  786. <div class="height-container">
  787. <div class="pointer-container"></div>
  788. <section class="section">
  789. <div class="pointer"></div>
  790. <div class="abstract">
  791. <p>The current network reachability status.</p>
  792. </div>
  793. <div class="declaration">
  794. <h4>Declaration</h4>
  795. <div class="language">
  796. <p class="aside-title">Swift</p>
  797. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">status</span><span class="p">:</span> <span class="kt"><a href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">NetworkReachabilityStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  798. </div>
  799. </div>
  800. </section>
  801. </div>
  802. </li>
  803. </ul>
  804. </div>
  805. <div class="task-group">
  806. <div class="task-name-container">
  807. <a name="/Initialization"></a>
  808. <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
  809. <div class="section-name-container">
  810. <a class="section-name-link" href="#/Initialization"></a>
  811. <h3 class="section-name"><span>Initialization</span>
  812. </h3>
  813. </div>
  814. </div>
  815. <ul class="item-container">
  816. <li class="item">
  817. <div>
  818. <code>
  819. <a name="/s:9Alamofire26NetworkReachabilityManagerC4hostACSgSS_tcfc"></a>
  820. <a name="//apple_ref/swift/Method/init(host:)" class="dashAnchor"></a>
  821. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC4hostACSgSS_tcfc">init(host:<wbr>)</a>
  822. </code>
  823. </div>
  824. <div class="height-container">
  825. <div class="pointer-container"></div>
  826. <section class="section">
  827. <div class="pointer"></div>
  828. <div class="abstract">
  829. <p>Creates an instance with the specified host.</p>
  830. <div class="aside aside-note">
  831. <p class="aside-title">Note</p>
  832. <p>The <code>host</code> value must <em>not</em> contain a scheme, just the hostname.</p>
  833. </div>
  834. </div>
  835. <div class="declaration">
  836. <h4>Declaration</h4>
  837. <div class="language">
  838. <p class="aside-title">Swift</p>
  839. <pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">?(</span><span class="nv">host</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  840. </div>
  841. </div>
  842. <div>
  843. <h4>Parameters</h4>
  844. <table class="graybox">
  845. <tbody>
  846. <tr>
  847. <td>
  848. <code>
  849. <em>host</em>
  850. </code>
  851. </td>
  852. <td>
  853. <div>
  854. <p>Host used to evaluate network reachability. Must <em>not</em> include the scheme (e.g. <code>https</code>).</p>
  855. </div>
  856. </td>
  857. </tr>
  858. </tbody>
  859. </table>
  860. </div>
  861. </section>
  862. </div>
  863. </li>
  864. <li class="item">
  865. <div>
  866. <code>
  867. <a name="/s:9Alamofire26NetworkReachabilityManagerCACSgycfc"></a>
  868. <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
  869. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerCACSgycfc">init()</a>
  870. </code>
  871. </div>
  872. <div class="height-container">
  873. <div class="pointer-container"></div>
  874. <section class="section">
  875. <div class="pointer"></div>
  876. <div class="abstract">
  877. <p>Creates an instance that monitors the address 0.0.0.0.</p>
  878. <p>Reachability treats the 0.0.0.0 address as a special token that causes it to monitor the general routing
  879. status of the device, both IPv4 and IPv6.</p>
  880. </div>
  881. <div class="declaration">
  882. <h4>Declaration</h4>
  883. <div class="language">
  884. <p class="aside-title">Swift</p>
  885. <pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">?()</span></code></pre>
  886. </div>
  887. </div>
  888. </section>
  889. </div>
  890. </li>
  891. </ul>
  892. </div>
  893. <div class="task-group">
  894. <div class="task-name-container">
  895. <a name="/Listening"></a>
  896. <a name="//apple_ref/swift/Section/Listening" class="dashAnchor"></a>
  897. <div class="section-name-container">
  898. <a class="section-name-link" href="#/Listening"></a>
  899. <h3 class="section-name"><span>Listening</span>
  900. </h3>
  901. </div>
  902. </div>
  903. <ul class="item-container">
  904. <li class="item">
  905. <div>
  906. <code>
  907. <a name="/s:9Alamofire26NetworkReachabilityManagerC14startListening7onQueue0G16UpdatePerformingSbSo17OS_dispatch_queueC_yAC0bC6StatusOctF"></a>
  908. <a name="//apple_ref/swift/Method/startListening(onQueue:onUpdatePerforming:)" class="dashAnchor"></a>
  909. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC14startListening7onQueue0G16UpdatePerformingSbSo17OS_dispatch_queueC_yAC0bC6StatusOctF">startListening(onQueue:<wbr>onUpdatePerforming:<wbr>)</a>
  910. </code>
  911. </div>
  912. <div class="height-container">
  913. <div class="pointer-container"></div>
  914. <section class="section">
  915. <div class="pointer"></div>
  916. <div class="abstract">
  917. <p>Starts listening for changes in network reachability status.</p>
  918. <div class="aside aside-note">
  919. <p class="aside-title">Note</p>
  920. <p>Stops and removes any existing listener.</p>
  921. </div>
  922. </div>
  923. <div class="declaration">
  924. <h4>Declaration</h4>
  925. <div class="language">
  926. <p class="aside-title">Swift</p>
  927. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  928. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">startListening</span><span class="p">(</span><span class="n">onQueue</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  929. <span class="n">onUpdatePerforming</span> <span class="nv">listener</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/NetworkReachabilityManager.html#/s:9Alamofire26NetworkReachabilityManagerC8Listenera">Listener</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  930. </div>
  931. </div>
  932. <div>
  933. <h4>Parameters</h4>
  934. <table class="graybox">
  935. <tbody>
  936. <tr>
  937. <td>
  938. <code>
  939. <em>queue</em>
  940. </code>
  941. </td>
  942. <td>
  943. <div>
  944. <p><code>DispatchQueue</code> on which to call the <code>listener</code> closure. <code>.main</code> by default.</p>
  945. </div>
  946. </td>
  947. </tr>
  948. <tr>
  949. <td>
  950. <code>
  951. <em>listener</em>
  952. </code>
  953. </td>
  954. <td>
  955. <div>
  956. <p><code><a href="../Classes/NetworkReachabilityManager.html#/s:9Alamofire26NetworkReachabilityManagerC8Listenera">Listener</a></code> closure called when reachability changes.</p>
  957. </div>
  958. </td>
  959. </tr>
  960. </tbody>
  961. </table>
  962. </div>
  963. <div>
  964. <h4>Return Value</h4>
  965. <p><code>true</code> if listening was started successfully, <code>false</code> otherwise.</p>
  966. </div>
  967. </section>
  968. </div>
  969. </li>
  970. <li class="item">
  971. <div>
  972. <code>
  973. <a name="/s:9Alamofire26NetworkReachabilityManagerC13stopListeningyyF"></a>
  974. <a name="//apple_ref/swift/Method/stopListening()" class="dashAnchor"></a>
  975. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC13stopListeningyyF">stopListening()</a>
  976. </code>
  977. </div>
  978. <div class="height-container">
  979. <div class="pointer-container"></div>
  980. <section class="section">
  981. <div class="pointer"></div>
  982. <div class="abstract">
  983. <p>Stops listening for changes in network reachability status.</p>
  984. </div>
  985. <div class="declaration">
  986. <h4>Declaration</h4>
  987. <div class="language">
  988. <p class="aside-title">Swift</p>
  989. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">stopListening</span><span class="p">()</span></code></pre>
  990. </div>
  991. </div>
  992. </section>
  993. </div>
  994. </li>
  995. </ul>
  996. </div>
  997. </div>
  998. </section>
  999. </article>
  1000. </div>
  1001. <section class="footer">
  1002. <p>&copy; 2023 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2023-08-31)</p>
  1003. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  1004. </section>
  1005. </body>
  1006. </html>