Skip to content

Commit

Permalink
Merge pull request #1 from vsanthanam/dev_address
Browse files Browse the repository at this point in the history
Dev address
  • Loading branch information
vsanthanam committed Mar 28, 2018
2 parents 7af8b05 + 4bb9edd commit 1b1b220
Show file tree
Hide file tree
Showing 43 changed files with 1,127 additions and 60 deletions.
39 changes: 37 additions & 2 deletions Documentation/Classes.html
Expand Up @@ -15,7 +15,7 @@
<div class="content-wrapper">
<p>
<a href="index.html">Nexum Docs</a>
<span class="no-mobile"> (92% documented)</span>
<span class="no-mobile"> (93% documented)</span>
</p>

<p class="header-right">
Expand Down Expand Up @@ -48,6 +48,38 @@ <h1>Classes</h1>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NXAddressInfo"></a>
<a name="//apple_ref/objc/Class/NXAddressInfo" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NXAddressInfo">NXAddressInfo</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>NXAddressInfo is a singleton class that lets you get IP address infomation about current connection(s). NXAddress shouldn&rsquo;t instantiated directly.</p>

<a href="Classes/NXAddressInfo.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">NXAddressInfo</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
Expand Down Expand Up @@ -104,6 +136,9 @@ <h4>Declaration</h4>
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/NXAddressInfo.html">NXAddressInfo</a>
</li>
<li class="nav-group-task">
<a href="Classes/NXNetwork.html">NXNetwork</a>
</li>
Expand Down Expand Up @@ -154,7 +189,7 @@ <h4>Declaration</h4>
</div>
<div class="footer-wrapper">
<section id="footer">
<p>&copy; 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>&copy; 2018 <a class="link" href="https://www.vsanthanam.com" target="_blank" rel="external">Varun Santhanam</a>. All rights reserved. (Last updated: 2018-03-28)</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>
Expand Down
314 changes: 314 additions & 0 deletions Documentation/Classes/NXAddressInfo.html
@@ -0,0 +1,314 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>NXAddressInfo Class 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 name="//apple_ref/objc/Class/NXAddressInfo" class="dashAnchor"></a>
<a title="NXAddressInfo Class Reference"></a>
<header>
<div class="content-wrapper">
<p>
<a href="../index.html">Nexum Docs</a>
<span class="no-mobile"> (93% 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>
NXAddressInfo Class Reference
</p>
</div>
</div>
<div class="wrapper">
<div class="article-wrapper">
<article class="main-content">
<section>
<section class="section">
<h1>NXAddressInfo</h1>
<div class="declaration">
<div class="language">
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">NXAddressInfo</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre>

</div>
</div>
<p>NXAddressInfo is a singleton class that lets you get IP address infomation about current connection(s). NXAddress shouldn&rsquo;t instantiated directly.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/Shared%20Instance"></a>
<a name="//apple_ref/objc/Section/Shared Instance" class="dashAnchor"></a>
<a href="#/Shared%20Instance">
<h3 class="section-name">Shared Instance</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NXAddressInfo(cm)sharedAddressInfo"></a>
<a name="//apple_ref/objc/Method/+sharedAddressInfo" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NXAddressInfo(cm)sharedAddressInfo">+sharedAddressInfo</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Get the shared address info object</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">sharedAddressInfo</span><span class="p">;</span></code></pre>

</div>
</div>
<div>
<h4>Return Value</h4>
<p>The shared instance</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Get%20WLAN%20Address%20Info"></a>
<a name="//apple_ref/objc/Section/Get WLAN Address Info" class="dashAnchor"></a>
<a href="#/Get%20WLAN%20Address%20Info">
<h3 class="section-name">Get WLAN Address Info</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NXAddressInfo(py)WLANIPv4Address"></a>
<a name="//apple_ref/objc/Property/WLANIPv4Address" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NXAddressInfo(py)WLANIPv4Address">WLANIPv4Address</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>IPv4 WLAN Address</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">WLANIPv4Address</span><span class="p">;</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NXAddressInfo(py)WLANIPv6Address"></a>
<a name="//apple_ref/objc/Property/WLANIPv6Address" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NXAddressInfo(py)WLANIPv6Address">WLANIPv6Address</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>IPv6 WLAN Address</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">WLANIPv6Address</span><span class="p">;</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Get%20WWAN%20Address%20Info"></a>
<a name="//apple_ref/objc/Section/Get WWAN Address Info" class="dashAnchor"></a>
<a href="#/Get%20WWAN%20Address%20Info">
<h3 class="section-name">Get WWAN Address Info</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NXAddressInfo(py)WWANIPv4Address"></a>
<a name="//apple_ref/objc/Property/WWANIPv4Address" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NXAddressInfo(py)WWANIPv4Address">WWANIPv4Address</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>IPv4 WWAN Address</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">WWANIPv4Address</span><span class="p">;</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NXAddressInfo(py)WWANIPv6Address"></a>
<a name="//apple_ref/objc/Property/WWANIPv6Address" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NXAddressInfo(py)WWANIPv6Address">WWANIPv6Address</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>IPv6 WWAN Address</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">WWANIPv6Address</span><span class="p">;</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</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/NXAddressInfo.html">NXAddressInfo</a>
</li>
<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>&copy; 2018 <a class="link" href="https://www.vsanthanam.com" target="_blank" rel="external">Varun Santhanam</a>. All rights reserved. (Last updated: 2018-03-28)</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>

0 comments on commit 1b1b220

Please sign in to comment.