NetworkReachabilityManager.html 40 KB

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