-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
156 lines (142 loc) · 7.01 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<!DOCTYPE html>
<html lang="en">
<head>
<title>Nexum Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
</head>
<body>
<a title="Nexum Reference"></a>
<header>
<div class="content-wrapper">
<p>
<a href="index.html">Nexum Docs</a>
<span class="no-mobile"> (92% documented)</span>
</p>
<p class="header-right">
<a href="https://github.com/vsanthanam/Nexum">
<img src="img/gh.png"/>
<span class="no-mobile">View on GitHub</span>
</a>
</p>
</div>
</header>
<div id="breadcrumbs-container">
<div class="content-wrapper">
<p id="breadcrumbs">
<span class="no-mobile">
<a href="index.html">Nexum Reference</a>
<img id="carat" src="img/carat.png" />
</span>
Nexum Reference
</p>
</div>
</div>
<div class="wrapper">
<div class="article-wrapper">
<article class="main-content">
<section>
<section class="section">
<h1 id='nexum' class='heading'>Nexum</h1>
<p>Updated Reachability for iOS Apps in Objective-C, based on Apple’s <a href="https://developer.apple.com/library/content/samplecode/Reachability/Introduction/Intro.html">Reachability</a>.</p>
<h2 id='about' class='heading'>About</h2>
<p>Apple appears to have stopped updating their Reachability code. It isn’t marked up with nullability for use with Swift projects, it doesn’t use ARC, and is generally inflexible. Nexum is a drop-in replacement for Apple’s reachability that is still extremely similar and very simple, but designed for easy, drop-in use and more design flexibility. Not everyone wants to use NSNotification all the time :P</p>
<h2 id='requirements' class='heading'>Requirements</h2>
<p>Nexum is compiled with the iOS 11.2 SDK, but support iOS 9.x+</p>
<h2 id='set-up' class='heading'>Set Up</h2>
<p>Take a look at the <a href="https://code.vsanthanam.com/Nexum/Documentation/project-setup.html">Project Setup guide</a> for detailed step by step instruction on setting up your project and building the documentation locally.</p>
<h2 id='usage' class='heading'>Usage</h2>
<p>Basic usage is pretty simple:</p>
<ol>
<li>Create and retain a reference to an instance of an <code><a href="Classes/NXNetwork.html">NXNetwork</a></code> object, or use the shared instance for basic projects.</li>
<li>Observe changes in reachability using <code><a href="Protocols/NXNetworkDelegate.html">NXNetworkDelegate</a></code>, <code>NXNetworkReachabilityStatusChangedNotification</code>, or a block.</li>
</ol>
<p>See the <a href="https://code.vsanthanam.com/Nexum/Documentation/designing-for-reachability.html">Designing for Reachability</a> for a detailed primer on potential different implentations, and see <a href="https://code.vsanthanam.com/Nexum/Documentation/example---basic-reachability.html">Example - Basic Reachability</a> for a quick start.</p>
<h2 id='docs' class='heading'>Docs</h2>
<p>The full documentaion is available <a href="https://code.vsanthanam.com/Nexum/Documentation/">here</a>, hosted on GitHub Pages, but is also included as an xcode docset.</p>
<p>Documentation with made with <a href="https://github.com/realm/jazzy">Jazzy</a> by <a href="https://realm.io">Realm</a>, using the <a href="https://github.com/HarshilShah/Jony">Jony Theme</a> by <a href="https://github.com/HarshilShah/">Harshil Shah</a></p>
</section>
</section>
</article>
</div>
<div class="nav-wrapper">
<nav class="nav-bottom">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="designing-for-reachability.html">Designing For Reachability</a>
</li>
<li class="nav-group-task">
<a href="example---basic-reachability.html">Example - Basic Reachability</a>
</li>
<li class="nav-group-task">
<a href="project-setup.html">Project Setup</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/NXNetwork.html">NXNetwork</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Constants.html">Constants</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Constants.html#/c:@NXNetworkReachabilityStatusChanged">NXNetworkReachabilityStatusChanged</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/NXNetworkReachabilityStatus.html">NXNetworkReachabilityStatus</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/NXNetworkDelegate.html">NXNetworkDelegate</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Type Definitions.html">Type Definitions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Type Definitions.html#/c:NXNetwork.h@T@NXNetworkReachabilityStatusChangedHandler">NXNetworkReachabilityStatusChangedHandler</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs.html#/c:@S@sockaddr">sockaddr</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="footer-wrapper">
<section id="footer">
<p>© 2018 <a class="link" href="https://www.vsanthanam.com" target="_blank" rel="external">Varun Santhanam</a>. All rights reserved. (Last updated: 2018-03-25)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</div>
</div>
</body>
</div>
</html>