NetworkReachabilityManager.html 47 KB

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