2
0

NetworkReachabilityManager.html 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954
  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. (77% 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/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  178. </li>
  179. </ul>
  180. </li>
  181. <li class="nav-group-name">
  182. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  183. <ul class="nav-group-tasks">
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  256. </li>
  257. </ul>
  258. </li>
  259. <li class="nav-group-name">
  260. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  261. <ul class="nav-group-tasks">
  262. <li class="nav-group-task">
  263. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  264. </li>
  265. <li class="nav-group-task">
  266. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  267. </li>
  268. <li class="nav-group-task">
  269. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  270. </li>
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  321. </li>
  322. </ul>
  323. </li>
  324. <li class="nav-group-name">
  325. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  326. <ul class="nav-group-tasks">
  327. <li class="nav-group-task">
  328. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  329. </li>
  330. <li class="nav-group-task">
  331. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  332. </li>
  333. <li class="nav-group-task">
  334. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  335. </li>
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  338. </li>
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  371. </li>
  372. </ul>
  373. </li>
  374. <li class="nav-group-name">
  375. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  376. <ul class="nav-group-tasks">
  377. <li class="nav-group-task">
  378. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  379. </li>
  380. <li class="nav-group-task">
  381. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  382. </li>
  383. <li class="nav-group-task">
  384. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  385. </li>
  386. <li class="nav-group-task">
  387. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  388. </li>
  389. </ul>
  390. </li>
  391. </ul>
  392. </nav>
  393. <article class="main-content">
  394. <section class="section">
  395. <div class="section-content">
  396. <h1>NetworkReachabilityManager</h1>
  397. <div class="declaration">
  398. <div class="language">
  399. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">NetworkReachabilityManager</span></code></pre>
  400. </div>
  401. </div>
  402. <p>The <code>NetworkReachabilityManager</code> class listens for reachability changes of hosts and addresses for both WWAN and
  403. WiFi network interfaces.</p>
  404. <p>Reachability can be used to determine background information about why a network operation failed, or to retry
  405. network requests when a connection is established. It should not be used to prevent a user from initiating a network
  406. request, as it&rsquo;s possible that an initial request may be required to establish reachability.</p>
  407. </div>
  408. </section>
  409. <section class="section">
  410. <div class="section-content">
  411. <div class="task-group">
  412. <ul class="item-container">
  413. <li class="item">
  414. <div>
  415. <code>
  416. <a name="/s:9Alamofire26NetworkReachabilityManagerC0bC6StatusO"></a>
  417. <a name="//apple_ref/swift/Enum/NetworkReachabilityStatus" class="dashAnchor"></a>
  418. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC0bC6StatusO">NetworkReachabilityStatus</a>
  419. </code>
  420. </div>
  421. <div class="height-container">
  422. <div class="pointer-container"></div>
  423. <section class="section">
  424. <div class="pointer"></div>
  425. <div class="abstract">
  426. <p>Defines the various states of network reachability.</p>
  427. <ul>
  428. <li>unknown: It is unknown whether the network is reachable.</li>
  429. <li>notReachable: The network is not reachable.</li>
  430. <li>reachable: The network is reachable.</li>
  431. </ul>
  432. <a href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html" class="slightly-smaller">See more</a>
  433. </div>
  434. <div class="declaration">
  435. <h4>Declaration</h4>
  436. <div class="language">
  437. <p class="aside-title">Swift</p>
  438. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">NetworkReachabilityStatus</span></code></pre>
  439. </div>
  440. </div>
  441. </section>
  442. </div>
  443. </li>
  444. <li class="item">
  445. <div>
  446. <code>
  447. <a name="/s:9Alamofire26NetworkReachabilityManagerC14ConnectionTypeO"></a>
  448. <a name="//apple_ref/swift/Enum/ConnectionType" class="dashAnchor"></a>
  449. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC14ConnectionTypeO">ConnectionType</a>
  450. </code>
  451. </div>
  452. <div class="height-container">
  453. <div class="pointer-container"></div>
  454. <section class="section">
  455. <div class="pointer"></div>
  456. <div class="abstract">
  457. <p>Defines the various connection types detected by reachability flags.</p>
  458. <ul>
  459. <li>ethernetOrWiFi: The connection type is either over Ethernet or WiFi.</li>
  460. <li>wwan: The connection type is a WWAN connection.</li>
  461. </ul>
  462. <a href="../Classes/NetworkReachabilityManager/ConnectionType.html" class="slightly-smaller">See more</a>
  463. </div>
  464. <div class="declaration">
  465. <h4>Declaration</h4>
  466. <div class="language">
  467. <p class="aside-title">Swift</p>
  468. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ConnectionType</span></code></pre>
  469. </div>
  470. </div>
  471. </section>
  472. </div>
  473. </li>
  474. <li class="item">
  475. <div>
  476. <code>
  477. <a name="/s:9Alamofire26NetworkReachabilityManagerC8Listenera"></a>
  478. <a name="//apple_ref/swift/Alias/Listener" class="dashAnchor"></a>
  479. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC8Listenera">Listener</a>
  480. </code>
  481. </div>
  482. <div class="height-container">
  483. <div class="pointer-container"></div>
  484. <section class="section">
  485. <div class="pointer"></div>
  486. <div class="abstract">
  487. <p>A closure executed when the network reachability status changes. The closure takes a single argument: the
  488. network reachability status.</p>
  489. </div>
  490. <div class="declaration">
  491. <h4>Declaration</h4>
  492. <div class="language">
  493. <p class="aside-title">Swift</p>
  494. <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>
  495. </div>
  496. </div>
  497. </section>
  498. </div>
  499. </li>
  500. </ul>
  501. </div>
  502. <div class="task-group">
  503. <div class="task-name-container">
  504. <a name="/Properties"></a>
  505. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  506. <a href="#/Properties">
  507. <h3 class="section-name">Properties</h3>
  508. </a>
  509. </div>
  510. <ul class="item-container">
  511. <li class="item">
  512. <div>
  513. <code>
  514. <a name="/s:9Alamofire26NetworkReachabilityManagerC11isReachableSbvp"></a>
  515. <a name="//apple_ref/swift/Property/isReachable" class="dashAnchor"></a>
  516. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC11isReachableSbvp">isReachable</a>
  517. </code>
  518. </div>
  519. <div class="height-container">
  520. <div class="pointer-container"></div>
  521. <section class="section">
  522. <div class="pointer"></div>
  523. <div class="abstract">
  524. <p>Whether the network is currently reachable.</p>
  525. </div>
  526. <div class="declaration">
  527. <h4>Declaration</h4>
  528. <div class="language">
  529. <p class="aside-title">Swift</p>
  530. <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>
  531. </div>
  532. </div>
  533. </section>
  534. </div>
  535. </li>
  536. <li class="item">
  537. <div>
  538. <code>
  539. <a name="/s:9Alamofire26NetworkReachabilityManagerC17isReachableOnWWANSbvp"></a>
  540. <a name="//apple_ref/swift/Property/isReachableOnWWAN" class="dashAnchor"></a>
  541. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC17isReachableOnWWANSbvp">isReachableOnWWAN</a>
  542. </code>
  543. </div>
  544. <div class="height-container">
  545. <div class="pointer-container"></div>
  546. <section class="section">
  547. <div class="pointer"></div>
  548. <div class="abstract">
  549. <p>Whether the network is currently reachable over the WWAN interface.</p>
  550. </div>
  551. <div class="declaration">
  552. <h4>Declaration</h4>
  553. <div class="language">
  554. <p class="aside-title">Swift</p>
  555. <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>
  556. </div>
  557. </div>
  558. </section>
  559. </div>
  560. </li>
  561. <li class="item">
  562. <div>
  563. <code>
  564. <a name="/s:9Alamofire26NetworkReachabilityManagerC27isReachableOnEthernetOrWiFiSbvp"></a>
  565. <a name="//apple_ref/swift/Property/isReachableOnEthernetOrWiFi" class="dashAnchor"></a>
  566. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC27isReachableOnEthernetOrWiFiSbvp">isReachableOnEthernetOrWiFi</a>
  567. </code>
  568. </div>
  569. <div class="height-container">
  570. <div class="pointer-container"></div>
  571. <section class="section">
  572. <div class="pointer"></div>
  573. <div class="abstract">
  574. <p>Whether the network is currently reachable over Ethernet or WiFi interface.</p>
  575. </div>
  576. <div class="declaration">
  577. <h4>Declaration</h4>
  578. <div class="language">
  579. <p class="aside-title">Swift</p>
  580. <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>
  581. </div>
  582. </div>
  583. </section>
  584. </div>
  585. </li>
  586. <li class="item">
  587. <div>
  588. <code>
  589. <a name="/s:9Alamofire26NetworkReachabilityManagerC07networkC6StatusAC0bcF0Ovp"></a>
  590. <a name="//apple_ref/swift/Property/networkReachabilityStatus" class="dashAnchor"></a>
  591. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC07networkC6StatusAC0bcF0Ovp">networkReachabilityStatus</a>
  592. </code>
  593. </div>
  594. <div class="height-container">
  595. <div class="pointer-container"></div>
  596. <section class="section">
  597. <div class="pointer"></div>
  598. <div class="abstract">
  599. <p>The current network reachability status.</p>
  600. </div>
  601. <div class="declaration">
  602. <h4>Declaration</h4>
  603. <div class="language">
  604. <p class="aside-title">Swift</p>
  605. <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>
  606. </div>
  607. </div>
  608. </section>
  609. </div>
  610. </li>
  611. <li class="item">
  612. <div>
  613. <code>
  614. <a name="/s:9Alamofire26NetworkReachabilityManagerC13listenerQueueSo17OS_dispatch_queueCvp"></a>
  615. <a name="//apple_ref/swift/Property/listenerQueue" class="dashAnchor"></a>
  616. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC13listenerQueueSo17OS_dispatch_queueCvp">listenerQueue</a>
  617. </code>
  618. </div>
  619. <div class="height-container">
  620. <div class="pointer-container"></div>
  621. <section class="section">
  622. <div class="pointer"></div>
  623. <div class="abstract">
  624. <p>The dispatch queue to execute the <code><a href="../Classes/NetworkReachabilityManager.html#/s:9Alamofire26NetworkReachabilityManagerC8listeneryAC0bC6StatusOcSgvp">listener</a></code> closure on.</p>
  625. </div>
  626. <div class="declaration">
  627. <h4>Declaration</h4>
  628. <div class="language">
  629. <p class="aside-title">Swift</p>
  630. <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>
  631. </div>
  632. </div>
  633. </section>
  634. </div>
  635. </li>
  636. <li class="item">
  637. <div>
  638. <code>
  639. <a name="/s:9Alamofire26NetworkReachabilityManagerC8listeneryAC0bC6StatusOcSgvp"></a>
  640. <a name="//apple_ref/swift/Property/listener" class="dashAnchor"></a>
  641. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC8listeneryAC0bC6StatusOcSgvp">listener</a>
  642. </code>
  643. </div>
  644. <div class="height-container">
  645. <div class="pointer-container"></div>
  646. <section class="section">
  647. <div class="pointer"></div>
  648. <div class="abstract">
  649. <p>A closure executed when the network reachability status changes.</p>
  650. </div>
  651. <div class="declaration">
  652. <h4>Declaration</h4>
  653. <div class="language">
  654. <p class="aside-title">Swift</p>
  655. <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>
  656. </div>
  657. </div>
  658. </section>
  659. </div>
  660. </li>
  661. <li class="item">
  662. <div>
  663. <code>
  664. <a name="/s:9Alamofire26NetworkReachabilityManagerC5flagsSo09SCNetworkC5FlagsVSgvp"></a>
  665. <a name="//apple_ref/swift/Property/flags" class="dashAnchor"></a>
  666. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC5flagsSo09SCNetworkC5FlagsVSgvp">flags</a>
  667. </code>
  668. </div>
  669. <div class="height-container">
  670. <div class="pointer-container"></div>
  671. <section class="section">
  672. <div class="pointer"></div>
  673. <div class="abstract">
  674. <p>Undocumented</p>
  675. </div>
  676. <div class="declaration">
  677. <h4>Declaration</h4>
  678. <div class="language">
  679. <p class="aside-title">Swift</p>
  680. <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>
  681. </div>
  682. </div>
  683. </section>
  684. </div>
  685. </li>
  686. <li class="item">
  687. <div>
  688. <code>
  689. <a name="/s:9Alamofire26NetworkReachabilityManagerC13previousFlagsSo09SCNetworkcF0Vvp"></a>
  690. <a name="//apple_ref/swift/Property/previousFlags" class="dashAnchor"></a>
  691. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC13previousFlagsSo09SCNetworkcF0Vvp">previousFlags</a>
  692. </code>
  693. </div>
  694. <div class="height-container">
  695. <div class="pointer-container"></div>
  696. <section class="section">
  697. <div class="pointer"></div>
  698. <div class="abstract">
  699. <p>Undocumented</p>
  700. </div>
  701. <div class="declaration">
  702. <h4>Declaration</h4>
  703. <div class="language">
  704. <p class="aside-title">Swift</p>
  705. <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>
  706. </div>
  707. </div>
  708. </section>
  709. </div>
  710. </li>
  711. </ul>
  712. </div>
  713. <div class="task-group">
  714. <div class="task-name-container">
  715. <a name="/Initialization"></a>
  716. <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
  717. <a href="#/Initialization">
  718. <h3 class="section-name">Initialization</h3>
  719. </a>
  720. </div>
  721. <ul class="item-container">
  722. <li class="item">
  723. <div>
  724. <code>
  725. <a name="/s:9Alamofire26NetworkReachabilityManagerC4hostACSgSS_tcfc"></a>
  726. <a name="//apple_ref/swift/Method/init(host:)" class="dashAnchor"></a>
  727. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC4hostACSgSS_tcfc">init(host:)</a>
  728. </code>
  729. </div>
  730. <div class="height-container">
  731. <div class="pointer-container"></div>
  732. <section class="section">
  733. <div class="pointer"></div>
  734. <div class="abstract">
  735. <p>Creates a <code>NetworkReachabilityManager</code> instance with the specified host.</p>
  736. </div>
  737. <div class="declaration">
  738. <h4>Declaration</h4>
  739. <div class="language">
  740. <p class="aside-title">Swift</p>
  741. <pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">?(</span><span class="nv">host</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  742. </div>
  743. </div>
  744. <div>
  745. <h4>Parameters</h4>
  746. <table class="graybox">
  747. <tbody>
  748. <tr>
  749. <td>
  750. <code>
  751. <em>host</em>
  752. </code>
  753. </td>
  754. <td>
  755. <div>
  756. <p>The host used to evaluate network reachability.</p>
  757. </div>
  758. </td>
  759. </tr>
  760. </tbody>
  761. </table>
  762. </div>
  763. <div>
  764. <h4>Return Value</h4>
  765. <p>The new <code>NetworkReachabilityManager</code> instance.</p>
  766. </div>
  767. </section>
  768. </div>
  769. </li>
  770. <li class="item">
  771. <div>
  772. <code>
  773. <a name="/s:9Alamofire26NetworkReachabilityManagerCACSgycfc"></a>
  774. <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
  775. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerCACSgycfc">init()</a>
  776. </code>
  777. </div>
  778. <div class="height-container">
  779. <div class="pointer-container"></div>
  780. <section class="section">
  781. <div class="pointer"></div>
  782. <div class="abstract">
  783. <p>Creates a <code>NetworkReachabilityManager</code> instance that monitors the address 0.0.0.0.</p>
  784. <p>Reachability treats the 0.0.0.0 address as a special token that causes it to monitor the general routing
  785. status of the device, both IPv4 and IPv6.</p>
  786. </div>
  787. <div class="declaration">
  788. <h4>Declaration</h4>
  789. <div class="language">
  790. <p class="aside-title">Swift</p>
  791. <pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">?()</span></code></pre>
  792. </div>
  793. </div>
  794. <div>
  795. <h4>Return Value</h4>
  796. <p>The new <code>NetworkReachabilityManager</code> instance.</p>
  797. </div>
  798. </section>
  799. </div>
  800. </li>
  801. <li class="item">
  802. <div>
  803. <code>
  804. <a name="/s:9Alamofire26NetworkReachabilityManagerCfd"></a>
  805. <a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
  806. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerCfd">deinit</a>
  807. </code>
  808. </div>
  809. <div class="height-container">
  810. <div class="pointer-container"></div>
  811. <section class="section">
  812. <div class="pointer"></div>
  813. <div class="abstract">
  814. <p>Undocumented</p>
  815. </div>
  816. <div class="declaration">
  817. <h4>Declaration</h4>
  818. <div class="language">
  819. <p class="aside-title">Swift</p>
  820. <pre class="highlight swift"><code><span class="kd">deinit</span></code></pre>
  821. </div>
  822. </div>
  823. </section>
  824. </div>
  825. </li>
  826. </ul>
  827. </div>
  828. <div class="task-group">
  829. <div class="task-name-container">
  830. <a name="/Listening"></a>
  831. <a name="//apple_ref/swift/Section/Listening" class="dashAnchor"></a>
  832. <a href="#/Listening">
  833. <h3 class="section-name">Listening</h3>
  834. </a>
  835. </div>
  836. <ul class="item-container">
  837. <li class="item">
  838. <div>
  839. <code>
  840. <a name="/s:9Alamofire26NetworkReachabilityManagerC14startListeningSbyF"></a>
  841. <a name="//apple_ref/swift/Method/startListening()" class="dashAnchor"></a>
  842. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC14startListeningSbyF">startListening()</a>
  843. </code>
  844. </div>
  845. <div class="height-container">
  846. <div class="pointer-container"></div>
  847. <section class="section">
  848. <div class="pointer"></div>
  849. <div class="abstract">
  850. <p>Starts listening for changes in network reachability status.</p>
  851. </div>
  852. <div class="declaration">
  853. <h4>Declaration</h4>
  854. <div class="language">
  855. <p class="aside-title">Swift</p>
  856. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  857. <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>
  858. </div>
  859. </div>
  860. <div>
  861. <h4>Return Value</h4>
  862. <p><code>true</code> if listening was started successfully, <code>false</code> otherwise.</p>
  863. </div>
  864. </section>
  865. </div>
  866. </li>
  867. <li class="item">
  868. <div>
  869. <code>
  870. <a name="/s:9Alamofire26NetworkReachabilityManagerC13stopListeningyyF"></a>
  871. <a name="//apple_ref/swift/Method/stopListening()" class="dashAnchor"></a>
  872. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC13stopListeningyyF">stopListening()</a>
  873. </code>
  874. </div>
  875. <div class="height-container">
  876. <div class="pointer-container"></div>
  877. <section class="section">
  878. <div class="pointer"></div>
  879. <div class="abstract">
  880. <p>Stops listening for changes in network reachability status.</p>
  881. </div>
  882. <div class="declaration">
  883. <h4>Declaration</h4>
  884. <div class="language">
  885. <p class="aside-title">Swift</p>
  886. <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>
  887. </div>
  888. </div>
  889. </section>
  890. </div>
  891. </li>
  892. </ul>
  893. </div>
  894. </div>
  895. </section>
  896. </article>
  897. </div>
  898. <section class="footer">
  899. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-12)</p>
  900. <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>
  901. </section>
  902. </body>
  903. </div>
  904. </html>