NetworkReachabilityManager.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831
  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. (86% 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:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationO0_AI0H7OptionsV7optionstAT_So17NSHTTPURLResponseCtcSgtF">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:9Alamofire8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationI0_AE0D7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSgtF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AG3URLV011destinationJ0_AF0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestyAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF">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:9Alamofire6stream4withAA13StreamRequestCSo12NSNetServiceC_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream12withHostName4portAA13StreamRequestCSS_SitF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold2to6method7headers18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgyAA14SessionManagerC0mdE14EncodingResultOcSgtF">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:9Alamofire6upload17multipartFormData14usingThreshold4with18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA21URLRequestConvertible_pyAA14SessionManagerC0kdE14EncodingResultOcSgtF">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. <li class="nav-group-task">
  274. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  275. </li>
  276. <li class="nav-group-task">
  277. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  278. </li>
  279. </ul>
  280. </li>
  281. <li class="nav-group-name">
  282. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  283. <ul class="nav-group-tasks">
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </nav>
  297. <article class="main-content">
  298. <section class="section">
  299. <div class="section-content">
  300. <h1>NetworkReachabilityManager</h1>
  301. <div class="declaration">
  302. <div class="language">
  303. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">NetworkReachabilityManager</span></code></pre>
  304. </div>
  305. </div>
  306. <p>The <code>NetworkReachabilityManager</code> class listens for reachability changes of hosts and addresses for both WWAN and
  307. WiFi network interfaces.</p>
  308. <p>Reachability can be used to determine background information about why a network operation failed, or to retry
  309. network requests when a connection is established. It should not be used to prevent a user from initiating a network
  310. request, as it&rsquo;s possible that an initial request may be required to establish reachability.</p>
  311. </div>
  312. </section>
  313. <section class="section">
  314. <div class="section-content">
  315. <div class="task-group">
  316. <ul class="item-container">
  317. <li class="item">
  318. <div>
  319. <code>
  320. <a name="/s:9Alamofire26NetworkReachabilityManagerC0bC6StatusO"></a>
  321. <a name="//apple_ref/swift/Enum/NetworkReachabilityStatus" class="dashAnchor"></a>
  322. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC0bC6StatusO">NetworkReachabilityStatus</a>
  323. </code>
  324. </div>
  325. <div class="height-container">
  326. <div class="pointer-container"></div>
  327. <section class="section">
  328. <div class="pointer"></div>
  329. <div class="abstract">
  330. <p>Defines the various states of network reachability.</p>
  331. <ul>
  332. <li>unknown: It is unknown whether the network is reachable.</li>
  333. <li>notReachable: The network is not reachable.</li>
  334. <li>reachable: The network is reachable.</li>
  335. </ul>
  336. <a href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html" class="slightly-smaller">See more</a>
  337. </div>
  338. <div class="declaration">
  339. <h4>Declaration</h4>
  340. <div class="language">
  341. <p class="aside-title">Swift</p>
  342. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">NetworkReachabilityStatus</span></code></pre>
  343. </div>
  344. </div>
  345. </section>
  346. </div>
  347. </li>
  348. <li class="item">
  349. <div>
  350. <code>
  351. <a name="/s:9Alamofire26NetworkReachabilityManagerC14ConnectionTypeO"></a>
  352. <a name="//apple_ref/swift/Enum/ConnectionType" class="dashAnchor"></a>
  353. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC14ConnectionTypeO">ConnectionType</a>
  354. </code>
  355. </div>
  356. <div class="height-container">
  357. <div class="pointer-container"></div>
  358. <section class="section">
  359. <div class="pointer"></div>
  360. <div class="abstract">
  361. <p>Defines the various connection types detected by reachability flags.</p>
  362. <ul>
  363. <li>ethernetOrWiFi: The connection type is either over Ethernet or WiFi.</li>
  364. <li>wwan: The connection type is a WWAN connection.</li>
  365. </ul>
  366. <a href="../Classes/NetworkReachabilityManager/ConnectionType.html" class="slightly-smaller">See more</a>
  367. </div>
  368. <div class="declaration">
  369. <h4>Declaration</h4>
  370. <div class="language">
  371. <p class="aside-title">Swift</p>
  372. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ConnectionType</span></code></pre>
  373. </div>
  374. </div>
  375. </section>
  376. </div>
  377. </li>
  378. <li class="item">
  379. <div>
  380. <code>
  381. <a name="/s:9Alamofire26NetworkReachabilityManagerC8Listenera"></a>
  382. <a name="//apple_ref/swift/Alias/Listener" class="dashAnchor"></a>
  383. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC8Listenera">Listener</a>
  384. </code>
  385. </div>
  386. <div class="height-container">
  387. <div class="pointer-container"></div>
  388. <section class="section">
  389. <div class="pointer"></div>
  390. <div class="abstract">
  391. <p>A closure executed when the network reachability status changes. The closure takes a single argument: the
  392. network reachability status.</p>
  393. </div>
  394. <div class="declaration">
  395. <h4>Declaration</h4>
  396. <div class="language">
  397. <p class="aside-title">Swift</p>
  398. <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>
  399. </div>
  400. </div>
  401. </section>
  402. </div>
  403. </li>
  404. </ul>
  405. </div>
  406. <div class="task-group">
  407. <div class="task-name-container">
  408. <a name="/Properties"></a>
  409. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  410. <a href="#/Properties">
  411. <h3 class="section-name">Properties</h3>
  412. </a>
  413. </div>
  414. <ul class="item-container">
  415. <li class="item">
  416. <div>
  417. <code>
  418. <a name="/s:9Alamofire26NetworkReachabilityManagerC11isReachableSbvp"></a>
  419. <a name="//apple_ref/swift/Property/isReachable" class="dashAnchor"></a>
  420. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC11isReachableSbvp">isReachable</a>
  421. </code>
  422. </div>
  423. <div class="height-container">
  424. <div class="pointer-container"></div>
  425. <section class="section">
  426. <div class="pointer"></div>
  427. <div class="abstract">
  428. <p>Whether the network is currently reachable.</p>
  429. </div>
  430. <div class="declaration">
  431. <h4>Declaration</h4>
  432. <div class="language">
  433. <p class="aside-title">Swift</p>
  434. <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>
  435. </div>
  436. </div>
  437. </section>
  438. </div>
  439. </li>
  440. <li class="item">
  441. <div>
  442. <code>
  443. <a name="/s:9Alamofire26NetworkReachabilityManagerC17isReachableOnWWANSbvp"></a>
  444. <a name="//apple_ref/swift/Property/isReachableOnWWAN" class="dashAnchor"></a>
  445. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC17isReachableOnWWANSbvp">isReachableOnWWAN</a>
  446. </code>
  447. </div>
  448. <div class="height-container">
  449. <div class="pointer-container"></div>
  450. <section class="section">
  451. <div class="pointer"></div>
  452. <div class="abstract">
  453. <p>Whether the network is currently reachable over the WWAN interface.</p>
  454. </div>
  455. <div class="declaration">
  456. <h4>Declaration</h4>
  457. <div class="language">
  458. <p class="aside-title">Swift</p>
  459. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">isReachableOnWWAN</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>
  460. </div>
  461. </div>
  462. </section>
  463. </div>
  464. </li>
  465. <li class="item">
  466. <div>
  467. <code>
  468. <a name="/s:9Alamofire26NetworkReachabilityManagerC27isReachableOnEthernetOrWiFiSbvp"></a>
  469. <a name="//apple_ref/swift/Property/isReachableOnEthernetOrWiFi" class="dashAnchor"></a>
  470. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC27isReachableOnEthernetOrWiFiSbvp">isReachableOnEthernetOrWiFi</a>
  471. </code>
  472. </div>
  473. <div class="height-container">
  474. <div class="pointer-container"></div>
  475. <section class="section">
  476. <div class="pointer"></div>
  477. <div class="abstract">
  478. <p>Whether the network is currently reachable over Ethernet or WiFi interface.</p>
  479. </div>
  480. <div class="declaration">
  481. <h4>Declaration</h4>
  482. <div class="language">
  483. <p class="aside-title">Swift</p>
  484. <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>
  485. </div>
  486. </div>
  487. </section>
  488. </div>
  489. </li>
  490. <li class="item">
  491. <div>
  492. <code>
  493. <a name="/s:9Alamofire26NetworkReachabilityManagerC07networkC6StatusAC0bcF0Ovp"></a>
  494. <a name="//apple_ref/swift/Property/networkReachabilityStatus" class="dashAnchor"></a>
  495. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC07networkC6StatusAC0bcF0Ovp">networkReachabilityStatus</a>
  496. </code>
  497. </div>
  498. <div class="height-container">
  499. <div class="pointer-container"></div>
  500. <section class="section">
  501. <div class="pointer"></div>
  502. <div class="abstract">
  503. <p>The current network reachability status.</p>
  504. </div>
  505. <div class="declaration">
  506. <h4>Declaration</h4>
  507. <div class="language">
  508. <p class="aside-title">Swift</p>
  509. <pre class="highlight swift"><code><span class="kd">open</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> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  510. </div>
  511. </div>
  512. </section>
  513. </div>
  514. </li>
  515. <li class="item">
  516. <div>
  517. <code>
  518. <a name="/s:9Alamofire26NetworkReachabilityManagerC13listenerQueueSo17OS_dispatch_queueCvp"></a>
  519. <a name="//apple_ref/swift/Property/listenerQueue" class="dashAnchor"></a>
  520. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC13listenerQueueSo17OS_dispatch_queueCvp">listenerQueue</a>
  521. </code>
  522. </div>
  523. <div class="height-container">
  524. <div class="pointer-container"></div>
  525. <section class="section">
  526. <div class="pointer"></div>
  527. <div class="abstract">
  528. <p>The dispatch queue to execute the <code><a href="../Classes/NetworkReachabilityManager.html#/s:9Alamofire26NetworkReachabilityManagerC8listeneryAC0bC6StatusOcSgvp">listener</a></code> closure on.</p>
  529. </div>
  530. <div class="declaration">
  531. <h4>Declaration</h4>
  532. <div class="language">
  533. <p class="aside-title">Swift</p>
  534. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">listenerQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
  535. </div>
  536. </div>
  537. </section>
  538. </div>
  539. </li>
  540. <li class="item">
  541. <div>
  542. <code>
  543. <a name="/s:9Alamofire26NetworkReachabilityManagerC8listeneryAC0bC6StatusOcSgvp"></a>
  544. <a name="//apple_ref/swift/Property/listener" class="dashAnchor"></a>
  545. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC8listeneryAC0bC6StatusOcSgvp">listener</a>
  546. </code>
  547. </div>
  548. <div class="height-container">
  549. <div class="pointer-container"></div>
  550. <section class="section">
  551. <div class="pointer"></div>
  552. <div class="abstract">
  553. <p>A closure executed when the network reachability status changes.</p>
  554. </div>
  555. <div class="declaration">
  556. <h4>Declaration</h4>
  557. <div class="language">
  558. <p class="aside-title">Swift</p>
  559. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">listener</span><span class="p">:</span> <span class="kt">NetworkReachabilityManager</span><span class="o">.</span><span class="kt"><a href="../Classes/NetworkReachabilityManager.html#/s:9Alamofire26NetworkReachabilityManagerC8Listenera">Listener</a></span><span class="p">?</span></code></pre>
  560. </div>
  561. </div>
  562. </section>
  563. </div>
  564. </li>
  565. <li class="item">
  566. <div>
  567. <code>
  568. <a name="/s:9Alamofire26NetworkReachabilityManagerC5flagsSo09SCNetworkC5FlagsVSgvp"></a>
  569. <a name="//apple_ref/swift/Property/flags" class="dashAnchor"></a>
  570. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC5flagsSo09SCNetworkC5FlagsVSgvp">flags</a>
  571. </code>
  572. </div>
  573. <div class="height-container">
  574. <div class="pointer-container"></div>
  575. <section class="section">
  576. <div class="pointer"></div>
  577. <div class="abstract">
  578. <p>Undocumented</p>
  579. </div>
  580. <div class="declaration">
  581. <h4>Declaration</h4>
  582. <div class="language">
  583. <p class="aside-title">Swift</p>
  584. <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>
  585. </div>
  586. </div>
  587. </section>
  588. </div>
  589. </li>
  590. <li class="item">
  591. <div>
  592. <code>
  593. <a name="/s:9Alamofire26NetworkReachabilityManagerC13previousFlagsSo09SCNetworkcF0Vvp"></a>
  594. <a name="//apple_ref/swift/Property/previousFlags" class="dashAnchor"></a>
  595. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC13previousFlagsSo09SCNetworkcF0Vvp">previousFlags</a>
  596. </code>
  597. </div>
  598. <div class="height-container">
  599. <div class="pointer-container"></div>
  600. <section class="section">
  601. <div class="pointer"></div>
  602. <div class="abstract">
  603. <p>Undocumented</p>
  604. </div>
  605. <div class="declaration">
  606. <h4>Declaration</h4>
  607. <div class="language">
  608. <p class="aside-title">Swift</p>
  609. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">previousFlags</span><span class="p">:</span> <span class="kt">SCNetworkReachabilityFlags</span></code></pre>
  610. </div>
  611. </div>
  612. </section>
  613. </div>
  614. </li>
  615. </ul>
  616. </div>
  617. <div class="task-group">
  618. <div class="task-name-container">
  619. <a name="/Initialization"></a>
  620. <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
  621. <a href="#/Initialization">
  622. <h3 class="section-name">Initialization</h3>
  623. </a>
  624. </div>
  625. <ul class="item-container">
  626. <li class="item">
  627. <div>
  628. <code>
  629. <a name="/s:9Alamofire26NetworkReachabilityManagerC4hostACSgSS_tcfc"></a>
  630. <a name="//apple_ref/swift/Method/init(host:)" class="dashAnchor"></a>
  631. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC4hostACSgSS_tcfc">init(host:)</a>
  632. </code>
  633. </div>
  634. <div class="height-container">
  635. <div class="pointer-container"></div>
  636. <section class="section">
  637. <div class="pointer"></div>
  638. <div class="abstract">
  639. <p>Creates a <code>NetworkReachabilityManager</code> instance with the specified host.</p>
  640. </div>
  641. <div class="declaration">
  642. <h4>Declaration</h4>
  643. <div class="language">
  644. <p class="aside-title">Swift</p>
  645. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">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>
  646. </div>
  647. </div>
  648. <div>
  649. <h4>Parameters</h4>
  650. <table class="graybox">
  651. <tbody>
  652. <tr>
  653. <td>
  654. <code>
  655. <em>host</em>
  656. </code>
  657. </td>
  658. <td>
  659. <div>
  660. <p>The host used to evaluate network reachability.</p>
  661. </div>
  662. </td>
  663. </tr>
  664. </tbody>
  665. </table>
  666. </div>
  667. <div>
  668. <h4>Return Value</h4>
  669. <p>The new <code>NetworkReachabilityManager</code> instance.</p>
  670. </div>
  671. </section>
  672. </div>
  673. </li>
  674. <li class="item">
  675. <div>
  676. <code>
  677. <a name="/s:9Alamofire26NetworkReachabilityManagerCACSgycfc"></a>
  678. <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
  679. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerCACSgycfc">init()</a>
  680. </code>
  681. </div>
  682. <div class="height-container">
  683. <div class="pointer-container"></div>
  684. <section class="section">
  685. <div class="pointer"></div>
  686. <div class="abstract">
  687. <p>Creates a <code>NetworkReachabilityManager</code> instance that monitors the address 0.0.0.0.</p>
  688. <p>Reachability treats the 0.0.0.0 address as a special token that causes it to monitor the general routing
  689. status of the device, both IPv4 and IPv6.</p>
  690. </div>
  691. <div class="declaration">
  692. <h4>Declaration</h4>
  693. <div class="language">
  694. <p class="aside-title">Swift</p>
  695. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">?()</span></code></pre>
  696. </div>
  697. </div>
  698. <div>
  699. <h4>Return Value</h4>
  700. <p>The new <code>NetworkReachabilityManager</code> instance.</p>
  701. </div>
  702. </section>
  703. </div>
  704. </li>
  705. </ul>
  706. </div>
  707. <div class="task-group">
  708. <div class="task-name-container">
  709. <a name="/Listening"></a>
  710. <a name="//apple_ref/swift/Section/Listening" class="dashAnchor"></a>
  711. <a href="#/Listening">
  712. <h3 class="section-name">Listening</h3>
  713. </a>
  714. </div>
  715. <ul class="item-container">
  716. <li class="item">
  717. <div>
  718. <code>
  719. <a name="/s:9Alamofire26NetworkReachabilityManagerC14startListeningSbyF"></a>
  720. <a name="//apple_ref/swift/Method/startListening()" class="dashAnchor"></a>
  721. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC14startListeningSbyF">startListening()</a>
  722. </code>
  723. </div>
  724. <div class="height-container">
  725. <div class="pointer-container"></div>
  726. <section class="section">
  727. <div class="pointer"></div>
  728. <div class="abstract">
  729. <p>Starts listening for changes in network reachability status.</p>
  730. </div>
  731. <div class="declaration">
  732. <h4>Declaration</h4>
  733. <div class="language">
  734. <p class="aside-title">Swift</p>
  735. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  736. <span class="kd">open</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>
  737. </div>
  738. </div>
  739. <div>
  740. <h4>Return Value</h4>
  741. <p><code>true</code> if listening was started successfully, <code>false</code> otherwise.</p>
  742. </div>
  743. </section>
  744. </div>
  745. </li>
  746. <li class="item">
  747. <div>
  748. <code>
  749. <a name="/s:9Alamofire26NetworkReachabilityManagerC13stopListeningyyF"></a>
  750. <a name="//apple_ref/swift/Method/stopListening()" class="dashAnchor"></a>
  751. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC13stopListeningyyF">stopListening()</a>
  752. </code>
  753. </div>
  754. <div class="height-container">
  755. <div class="pointer-container"></div>
  756. <section class="section">
  757. <div class="pointer"></div>
  758. <div class="abstract">
  759. <p>Stops listening for changes in network reachability status.</p>
  760. </div>
  761. <div class="declaration">
  762. <h4>Declaration</h4>
  763. <div class="language">
  764. <p class="aside-title">Swift</p>
  765. <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>
  766. </div>
  767. </div>
  768. </section>
  769. </div>
  770. </li>
  771. </ul>
  772. </div>
  773. </div>
  774. </section>
  775. </article>
  776. </div>
  777. <section class="footer">
  778. <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-11-24)</p>
  779. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  780. </section>
  781. </body>
  782. </div>
  783. </html>