NetworkReachabilityManager.html 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764
  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 Docs
  21. </a>
  22. (87% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  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"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. </header>
  36. <p class="breadcrumbs">
  37. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  38. <img class="carat" src="../img/carat.png" />
  39. NetworkReachabilityManager Class Reference
  40. </p>
  41. <div class="content-wrapper">
  42. <nav class="navigation">
  43. <ul class="nav-groups">
  44. <li class="nav-group-name">
  45. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  46. <ul class="nav-group-tasks">
  47. <li class="nav-group-task">
  48. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  49. </li>
  50. <li class="nav-group-task">
  51. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  52. </li>
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  94. </li>
  95. </ul>
  96. </li>
  97. <li class="nav-group-name">
  98. <a class="nav-group-name-link" href="../Enums.html">Enums</a>
  99. <ul class="nav-group-tasks">
  100. <li class="nav-group-task">
  101. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  102. </li>
  103. <li class="nav-group-task">
  104. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  105. </li>
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  123. </li>
  124. </ul>
  125. </li>
  126. <li class="nav-group-name">
  127. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  128. <ul class="nav-group-tasks">
  129. <li class="nav-group-task">
  130. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  131. </li>
  132. <li class="nav-group-task">
  133. <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
  134. </li>
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  149. </li>
  150. </ul>
  151. </li>
  152. <li class="nav-group-name">
  153. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  154. <ul class="nav-group-tasks">
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  202. </li>
  203. </ul>
  204. </li>
  205. <li class="nav-group-name">
  206. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  207. <ul class="nav-group-tasks">
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  222. </li>
  223. <li class="nav-group-task">
  224. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  225. </li>
  226. <li class="nav-group-task">
  227. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  228. </li>
  229. </ul>
  230. </li>
  231. <li class="nav-group-name">
  232. <a class="nav-group-name-link" href="../Structs.html">Structs</a>
  233. <ul class="nav-group-tasks">
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  263. </li>
  264. <li class="nav-group-task">
  265. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  266. </li>
  267. </ul>
  268. </li>
  269. <li class="nav-group-name">
  270. <a class="nav-group-name-link" href="../Typealiases.html">Typealiases</a>
  271. <ul class="nav-group-tasks">
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  280. </li>
  281. </ul>
  282. </li>
  283. </ul>
  284. </nav>
  285. <article class="main-content">
  286. <section class="section">
  287. <div class="section-content">
  288. <h1>NetworkReachabilityManager</h1>
  289. <div class="declaration">
  290. <div class="language">
  291. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">NetworkReachabilityManager</span></code></pre>
  292. </div>
  293. </div>
  294. <p>The <code>NetworkReachabilityManager</code> class listens for reachability changes of hosts and addresses for both WWAN and
  295. WiFi network interfaces.</p>
  296. <p>Reachability can be used to determine background information about why a network operation failed, or to retry
  297. network requests when a connection is established. It should not be used to prevent a user from initiating a network
  298. request, as it&rsquo;s possible that an initial request may be required to establish reachability.</p>
  299. </div>
  300. </section>
  301. <section class="section">
  302. <div class="section-content">
  303. <div class="task-group">
  304. <ul class="item-container">
  305. <li class="item">
  306. <div>
  307. <code>
  308. <a name="/s:9Alamofire26NetworkReachabilityManagerC0bC6StatusO"></a>
  309. <a name="//apple_ref/swift/Enum/NetworkReachabilityStatus" class="dashAnchor"></a>
  310. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC0bC6StatusO">NetworkReachabilityStatus</a>
  311. </code>
  312. </div>
  313. <div class="height-container">
  314. <div class="pointer-container"></div>
  315. <section class="section">
  316. <div class="pointer"></div>
  317. <div class="abstract">
  318. <p>Defines the various states of network reachability.</p>
  319. <ul>
  320. <li>unknown: It is unknown whether the network is reachable.</li>
  321. <li>notReachable: The network is not reachable.</li>
  322. <li>reachable: The network is reachable.</li>
  323. </ul>
  324. <a href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html" class="slightly-smaller">See more</a>
  325. </div>
  326. <div class="declaration">
  327. <h4>Declaration</h4>
  328. <div class="language">
  329. <p class="aside-title">Swift</p>
  330. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">NetworkReachabilityStatus</span></code></pre>
  331. </div>
  332. </div>
  333. </section>
  334. </div>
  335. </li>
  336. <li class="item">
  337. <div>
  338. <code>
  339. <a name="/s:9Alamofire26NetworkReachabilityManagerC14ConnectionTypeO"></a>
  340. <a name="//apple_ref/swift/Enum/ConnectionType" class="dashAnchor"></a>
  341. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC14ConnectionTypeO">ConnectionType</a>
  342. </code>
  343. </div>
  344. <div class="height-container">
  345. <div class="pointer-container"></div>
  346. <section class="section">
  347. <div class="pointer"></div>
  348. <div class="abstract">
  349. <p>Defines the various connection types detected by reachability flags.</p>
  350. <ul>
  351. <li>ethernetOrWiFi: The connection type is either over Ethernet or WiFi.</li>
  352. <li>wwan: The connection type is a WWAN connection.</li>
  353. </ul>
  354. <a href="../Classes/NetworkReachabilityManager/ConnectionType.html" class="slightly-smaller">See more</a>
  355. </div>
  356. <div class="declaration">
  357. <h4>Declaration</h4>
  358. <div class="language">
  359. <p class="aside-title">Swift</p>
  360. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ConnectionType</span></code></pre>
  361. </div>
  362. </div>
  363. </section>
  364. </div>
  365. </li>
  366. <li class="item">
  367. <div>
  368. <code>
  369. <a name="/s:9Alamofire26NetworkReachabilityManagerC8Listenera"></a>
  370. <a name="//apple_ref/swift/Alias/Listener" class="dashAnchor"></a>
  371. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC8Listenera">Listener</a>
  372. </code>
  373. </div>
  374. <div class="height-container">
  375. <div class="pointer-container"></div>
  376. <section class="section">
  377. <div class="pointer"></div>
  378. <div class="abstract">
  379. <p>A closure executed when the network reachability status changes. The closure takes a single argument: the
  380. network reachability status.</p>
  381. </div>
  382. <div class="declaration">
  383. <h4>Declaration</h4>
  384. <div class="language">
  385. <p class="aside-title">Swift</p>
  386. <pre class="highlight"><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>
  387. </div>
  388. </div>
  389. </section>
  390. </div>
  391. </li>
  392. </ul>
  393. </div>
  394. <div class="task-group">
  395. <div class="task-name-container">
  396. <a name="/Properties"></a>
  397. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  398. <a href="#/Properties">
  399. <h3 class="section-name">Properties</h3>
  400. </a>
  401. </div>
  402. <ul class="item-container">
  403. <li class="item">
  404. <div>
  405. <code>
  406. <a name="/s:9Alamofire26NetworkReachabilityManagerC11isReachableSbv"></a>
  407. <a name="//apple_ref/swift/Property/isReachable" class="dashAnchor"></a>
  408. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC11isReachableSbv">isReachable</a>
  409. </code>
  410. </div>
  411. <div class="height-container">
  412. <div class="pointer-container"></div>
  413. <section class="section">
  414. <div class="pointer"></div>
  415. <div class="abstract">
  416. <p>Whether the network is currently reachable.</p>
  417. </div>
  418. <div class="declaration">
  419. <h4>Declaration</h4>
  420. <div class="language">
  421. <p class="aside-title">Swift</p>
  422. <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isReachable</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
  423. </div>
  424. </div>
  425. </section>
  426. </div>
  427. </li>
  428. <li class="item">
  429. <div>
  430. <code>
  431. <a name="/s:9Alamofire26NetworkReachabilityManagerC17isReachableOnWWANSbv"></a>
  432. <a name="//apple_ref/swift/Property/isReachableOnWWAN" class="dashAnchor"></a>
  433. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC17isReachableOnWWANSbv">isReachableOnWWAN</a>
  434. </code>
  435. </div>
  436. <div class="height-container">
  437. <div class="pointer-container"></div>
  438. <section class="section">
  439. <div class="pointer"></div>
  440. <div class="abstract">
  441. <p>Whether the network is currently reachable over the WWAN interface.</p>
  442. </div>
  443. <div class="declaration">
  444. <h4>Declaration</h4>
  445. <div class="language">
  446. <p class="aside-title">Swift</p>
  447. <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isReachableOnWWAN</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
  448. </div>
  449. </div>
  450. </section>
  451. </div>
  452. </li>
  453. <li class="item">
  454. <div>
  455. <code>
  456. <a name="/s:9Alamofire26NetworkReachabilityManagerC27isReachableOnEthernetOrWiFiSbv"></a>
  457. <a name="//apple_ref/swift/Property/isReachableOnEthernetOrWiFi" class="dashAnchor"></a>
  458. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC27isReachableOnEthernetOrWiFiSbv">isReachableOnEthernetOrWiFi</a>
  459. </code>
  460. </div>
  461. <div class="height-container">
  462. <div class="pointer-container"></div>
  463. <section class="section">
  464. <div class="pointer"></div>
  465. <div class="abstract">
  466. <p>Whether the network is currently reachable over Ethernet or WiFi interface.</p>
  467. </div>
  468. <div class="declaration">
  469. <h4>Declaration</h4>
  470. <div class="language">
  471. <p class="aside-title">Swift</p>
  472. <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isReachableOnEthernetOrWiFi</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
  473. </div>
  474. </div>
  475. </section>
  476. </div>
  477. </li>
  478. <li class="item">
  479. <div>
  480. <code>
  481. <a name="/s:9Alamofire26NetworkReachabilityManagerC07networkC6StatusAC0bcF0Ov"></a>
  482. <a name="//apple_ref/swift/Property/networkReachabilityStatus" class="dashAnchor"></a>
  483. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC07networkC6StatusAC0bcF0Ov">networkReachabilityStatus</a>
  484. </code>
  485. </div>
  486. <div class="height-container">
  487. <div class="pointer-container"></div>
  488. <section class="section">
  489. <div class="pointer"></div>
  490. <div class="abstract">
  491. <p>The current network reachability status.</p>
  492. </div>
  493. <div class="declaration">
  494. <h4>Declaration</h4>
  495. <div class="language">
  496. <p class="aside-title">Swift</p>
  497. <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">networkReachabilityStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">NetworkReachabilityStatus</a></span></code></pre>
  498. </div>
  499. </div>
  500. </section>
  501. </div>
  502. </li>
  503. <li class="item">
  504. <div>
  505. <code>
  506. <a name="/s:9Alamofire26NetworkReachabilityManagerC13listenerQueueSo08DispatchF0Cv"></a>
  507. <a name="//apple_ref/swift/Property/listenerQueue" class="dashAnchor"></a>
  508. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC13listenerQueueSo08DispatchF0Cv">listenerQueue</a>
  509. </code>
  510. </div>
  511. <div class="height-container">
  512. <div class="pointer-container"></div>
  513. <section class="section">
  514. <div class="pointer"></div>
  515. <div class="abstract">
  516. <p>The dispatch queue to execute the <code><a href="../Classes/NetworkReachabilityManager.html#/s:9Alamofire26NetworkReachabilityManagerC8listeneryAC0bC6StatusOcSgv">listener</a></code> closure on.</p>
  517. </div>
  518. <div class="declaration">
  519. <h4>Declaration</h4>
  520. <div class="language">
  521. <p class="aside-title">Swift</p>
  522. <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">listenerQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="kt">DispatchQueue</span><span class="o">.</span><span class="n">main</span></code></pre>
  523. </div>
  524. </div>
  525. </section>
  526. </div>
  527. </li>
  528. <li class="item">
  529. <div>
  530. <code>
  531. <a name="/s:9Alamofire26NetworkReachabilityManagerC8listeneryAC0bC6StatusOcSgv"></a>
  532. <a name="//apple_ref/swift/Property/listener" class="dashAnchor"></a>
  533. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC8listeneryAC0bC6StatusOcSgv">listener</a>
  534. </code>
  535. </div>
  536. <div class="height-container">
  537. <div class="pointer-container"></div>
  538. <section class="section">
  539. <div class="pointer"></div>
  540. <div class="abstract">
  541. <p>A closure executed when the network reachability status changes.</p>
  542. </div>
  543. <div class="declaration">
  544. <h4>Declaration</h4>
  545. <div class="language">
  546. <p class="aside-title">Swift</p>
  547. <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">listener</span><span class="p">:</span> <span class="kt"><a href="../Classes/NetworkReachabilityManager.html#/s:9Alamofire26NetworkReachabilityManagerC8Listenera">Listener</a></span><span class="p">?</span></code></pre>
  548. </div>
  549. </div>
  550. </section>
  551. </div>
  552. </li>
  553. </ul>
  554. </div>
  555. <div class="task-group">
  556. <div class="task-name-container">
  557. <a name="/Initialization"></a>
  558. <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
  559. <a href="#/Initialization">
  560. <h3 class="section-name">Initialization</h3>
  561. </a>
  562. </div>
  563. <ul class="item-container">
  564. <li class="item">
  565. <div>
  566. <code>
  567. <a name="/s:9Alamofire26NetworkReachabilityManagerCACSgSS4host_tcfc"></a>
  568. <a name="//apple_ref/swift/Method/init(host:)" class="dashAnchor"></a>
  569. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerCACSgSS4host_tcfc">init(host:)</a>
  570. </code>
  571. </div>
  572. <div class="height-container">
  573. <div class="pointer-container"></div>
  574. <section class="section">
  575. <div class="pointer"></div>
  576. <div class="abstract">
  577. <p>Creates a <code>NetworkReachabilityManager</code> instance with the specified host.</p>
  578. </div>
  579. <div class="declaration">
  580. <h4>Declaration</h4>
  581. <div class="language">
  582. <p class="aside-title">Swift</p>
  583. <pre class="highlight"><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>
  584. </div>
  585. </div>
  586. <div>
  587. <h4>Parameters</h4>
  588. <table class="graybox">
  589. <tbody>
  590. <tr>
  591. <td>
  592. <code>
  593. <em>host</em>
  594. </code>
  595. </td>
  596. <td>
  597. <div>
  598. <p>The host used to evaluate network reachability.</p>
  599. </div>
  600. </td>
  601. </tr>
  602. </tbody>
  603. </table>
  604. </div>
  605. <div>
  606. <h4>Return Value</h4>
  607. <p>The new <code>NetworkReachabilityManager</code> instance.</p>
  608. </div>
  609. </section>
  610. </div>
  611. </li>
  612. <li class="item">
  613. <div>
  614. <code>
  615. <a name="/s:9Alamofire26NetworkReachabilityManagerCACSgycfc"></a>
  616. <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
  617. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerCACSgycfc">init()</a>
  618. </code>
  619. </div>
  620. <div class="height-container">
  621. <div class="pointer-container"></div>
  622. <section class="section">
  623. <div class="pointer"></div>
  624. <div class="abstract">
  625. <p>Creates a <code>NetworkReachabilityManager</code> instance that monitors the address 0.0.0.0.</p>
  626. <p>Reachability treats the 0.0.0.0 address as a special token that causes it to monitor the general routing
  627. status of the device, both IPv4 and IPv6.</p>
  628. </div>
  629. <div class="declaration">
  630. <h4>Declaration</h4>
  631. <div class="language">
  632. <p class="aside-title">Swift</p>
  633. <pre class="highlight"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">?()</span></code></pre>
  634. </div>
  635. </div>
  636. <div>
  637. <h4>Return Value</h4>
  638. <p>The new <code>NetworkReachabilityManager</code> instance.</p>
  639. </div>
  640. </section>
  641. </div>
  642. </li>
  643. </ul>
  644. </div>
  645. <div class="task-group">
  646. <div class="task-name-container">
  647. <a name="/Listening"></a>
  648. <a name="//apple_ref/swift/Section/Listening" class="dashAnchor"></a>
  649. <a href="#/Listening">
  650. <h3 class="section-name">Listening</h3>
  651. </a>
  652. </div>
  653. <ul class="item-container">
  654. <li class="item">
  655. <div>
  656. <code>
  657. <a name="/s:9Alamofire26NetworkReachabilityManagerC14startListeningSbyF"></a>
  658. <a name="//apple_ref/swift/Method/startListening()" class="dashAnchor"></a>
  659. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC14startListeningSbyF">startListening()</a>
  660. </code>
  661. </div>
  662. <div class="height-container">
  663. <div class="pointer-container"></div>
  664. <section class="section">
  665. <div class="pointer"></div>
  666. <div class="abstract">
  667. <p>Starts listening for changes in network reachability status.</p>
  668. </div>
  669. <div class="declaration">
  670. <h4>Declaration</h4>
  671. <div class="language">
  672. <p class="aside-title">Swift</p>
  673. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">startListening</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  674. </div>
  675. </div>
  676. <div>
  677. <h4>Return Value</h4>
  678. <p><code>true</code> if listening was started successfully, <code>false</code> otherwise.</p>
  679. </div>
  680. </section>
  681. </div>
  682. </li>
  683. <li class="item">
  684. <div>
  685. <code>
  686. <a name="/s:9Alamofire26NetworkReachabilityManagerC13stopListeningyyF"></a>
  687. <a name="//apple_ref/swift/Method/stopListening()" class="dashAnchor"></a>
  688. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC13stopListeningyyF">stopListening()</a>
  689. </code>
  690. </div>
  691. <div class="height-container">
  692. <div class="pointer-container"></div>
  693. <section class="section">
  694. <div class="pointer"></div>
  695. <div class="abstract">
  696. <p>Stops listening for changes in network reachability status.</p>
  697. </div>
  698. <div class="declaration">
  699. <h4>Declaration</h4>
  700. <div class="language">
  701. <p class="aside-title">Swift</p>
  702. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">stopListening</span><span class="p">()</span></code></pre>
  703. </div>
  704. </div>
  705. </section>
  706. </div>
  707. </li>
  708. </ul>
  709. </div>
  710. </div>
  711. </section>
  712. </article>
  713. </div>
  714. <section class="footer">
  715. <p>&copy; 2017 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2017-08-21)</p>
  716. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  717. </section>
  718. </body>
  719. </div>
  720. </html>