Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misc org update #246

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Misc org update #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6d61e6
Update github org references
dannys42 Nov 26, 2020
53a7eec
Update jazzy docs
dannys42 Nov 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .jazzy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module: KituraNet
author: IBM
github_url: https://github.com/IBM-Swift/Kitura-NIO/
author: IBM & Kitura project contributors
github_url: https://github.com/Kitura/Kitura-NIO/

theme: fullwidth
clean: true
Expand All @@ -11,4 +11,3 @@ readme: README.md
skip_undocumented: false
hide_documentation_coverage: false

xcodebuild_arguments: [-project, Kitura-NIO.xcodeproj, -target, KituraNet, LIBRARY_SEARCH_PATHS=.build/debug]
2 changes: 1 addition & 1 deletion .kitura-test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ fi
set -e
echo ">> Building Kitura"
travis_start "swift_build_kitura"
cd .. && git clone https://github.com/IBM-Swift/Kitura && cd Kitura
cd .. && git clone https://github.com/Kitura/Kitura && cd Kitura

# Set KITURA_NIO
export KITURA_NIO=1
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ matrix:


before_install:
- git clone https://github.com/IBM-Swift/Package-Builder.git
- git clone https://github.com/Kitura/Package-Builder.git

script:
- ./Package-Builder/build-package.sh -projectDir $TRAVIS_BUILD_DIR
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<p align="center">
<a href="http://kitura.io/">
<img src="https://raw.githubusercontent.com/IBM-Swift/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
<img src="https://raw.githubusercontent.com/Kitura/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
</a>
</p>


<p align="center">
<img src="https://img.shields.io/badge/Swift-5.0-orange.svg?style=flat" alt="Swift 5.0">
<a href="https://ibm-swift.github.io/Kitura-NIO/index.html">
<a href="https://kitura.github.io/Kitura-NIO/index.html">
<img src="https://img.shields.io/badge/apidoc-KituraNIO-1FBCE4.svg?style=flat" alt="APIDoc">
</a>
<a href="https://travis-ci.org/IBM-Swift/Kitura-NIO">
<img src="https://travis-ci.org/IBM-Swift/Kitura-NIO.svg?branch=master" alt="Build Status - Master">
<a href="https://travis-ci.org/Kitura/Kitura-NIO">
<img src="https://travis-ci.org/Kitura/Kitura-NIO.svg?branch=master" alt="Build Status - Master">
</a>
<img src="https://img.shields.io/badge/os-macOS-green.svg?style=flat" alt="macOS">
<img src="https://img.shields.io/badge/os-linux-green.svg?style=flat" alt="Linux">
Expand All @@ -23,11 +23,11 @@

# Kitura-NIO

Kitura-NIO is a [SwiftNIO](https://github.com/apple/swift-nio) based networking library for Kitura. Kitura-NIO adopts the same API as [KituraNet](https://github.com/IBM-Swift/Kitura-net), making the transition from KituraNet to Kitura-NIO seamless. While Kitura-NIO shares some code with Kitura-Net, the core comprising of HTTPServer, ClientRequest/ClientResponse and TLS support have been implemented using SwiftNIO. Kitura-NIO uses [NIOSSL](https://github.com/apple/swift-nio-ssl) for TLS support.
Kitura-NIO is a [SwiftNIO](https://github.com/apple/swift-nio) based networking library for Kitura. Kitura-NIO adopts the same API as [KituraNet](https://github.com/Kitura/Kitura-net), making the transition from KituraNet to Kitura-NIO seamless. While Kitura-NIO shares some code with Kitura-Net, the core comprising of HTTPServer, ClientRequest/ClientResponse and TLS support have been implemented using SwiftNIO. Kitura-NIO uses [NIOSSL](https://github.com/apple/swift-nio-ssl) for TLS support.

We expect most of our users to require higher level concepts such as routing, templates and middleware. These are not provided in Kitura-NIO. If you want to use those facilities you should be coding at the Kitura level, for this please see the [Kitura](https://github.com/IBM-Swift/Kitura) project. Kitura-NIO, like [Kitura-net](https://github.com/IBM-Swift/Kitura-net), underpins Kitura which offers a higher abstraction level to users.
We expect most of our users to require higher level concepts such as routing, templates and middleware. These are not provided in Kitura-NIO. If you want to use those facilities you should be coding at the Kitura level, for this please see the [Kitura](https://github.com/Kitura/Kitura) project. Kitura-NIO, like [Kitura-net](https://github.com/Kitura/Kitura-net), underpins Kitura which offers a higher abstraction level to users.

Kitura-NIO 2 has been tested with Swift 5. If you are using Swift 4, please use Kitura-NIO 1. See the [release history](https://github.com/IBM-Swift/Kitura-NIO/releases) for details.
Kitura-NIO 2 has been tested with Swift 5. If you are using Swift 4, please use Kitura-NIO 1. See the [release history](https://github.com/Kitura/Kitura-NIO/releases) for details.

## Features

Expand Down Expand Up @@ -64,7 +64,7 @@ We'd be more than happy to receive bug reports, enhancement requests and pull re

1. Clone this repository.

`$ git clone https://github.com/IBM-Swift/Kitura-NIO && cd Kitura-NIO`
`$ git clone https://github.com/Kitura/Kitura-NIO && cd Kitura-NIO`

2. Build and run tests.

Expand All @@ -73,7 +73,7 @@ We'd be more than happy to receive bug reports, enhancement requests and pull re
You may also want to run the tests in parallel:
`$ swift test --parallel`

In some Linux environments, a low open file limit could cause test failures. See [this](https://github.com/IBM-Swift/Kitura-NIO/issues/1).
In some Linux environments, a low open file limit could cause test failures. See [this](https://github.com/Kitura/Kitura-NIO/issues/1).

## Community

Expand All @@ -83,4 +83,4 @@ Join the [Kitura on Swift Forums](https://forums.swift.org/c/related-projects/ki

## License

This library is licensed under Apache 2.0. The full license text is available in [LICENSE](https://github.com/IBM-Swift/Kitura-NIO/blob/master/LICENSE.txt).
This library is licensed under Apache 2.0. The full license text is available in [LICENSE](https://github.com/Kitura/Kitura-NIO/blob/master/LICENSE.txt).
121 changes: 53 additions & 68 deletions docs/Classes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<a class="header-link" href="index.html">
KituraNet Docs
</a>
(95% documented)
(94% documented)
</p>

<p class="header-col--secondary">
Expand All @@ -33,7 +33,7 @@
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/IBM-Swift/Kitura-NIO/">
<a class="header-link" href="https://github.com/Kitura/Kitura-NIO/">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
Expand Down Expand Up @@ -152,6 +152,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ConnectionUpgrader.html">ConnectionUpgrader</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/HTTPServerError.html">HTTPServerError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Monitor.html">Monitor</a>
</li>
Expand All @@ -165,7 +168,7 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>Classes</h1>
<p>The following classes are available globally.</p>

Expand All @@ -176,11 +179,13 @@ <h1>Classes</h1>
<div class="section-content">
<div class="task-group">
<div class="task-name-container">
<a name="/BufferList%20"></a>
<a name="//apple_ref/swift/Section/BufferList " class="dashAnchor"></a>
<a href="#/BufferList%20">
<h3 class="section-name">BufferList </h3>
</a>
<a name="/BufferList"></a>
<a name="//apple_ref/swift/Section/BufferList" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/BufferList"></a>
<h3 class="section-name"><p>BufferList</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -250,9 +255,11 @@ <h4>Declaration</h4>
<div class="task-name-container">
<a name="/ClientRequest"></a>
<a name="//apple_ref/swift/Section/ClientRequest" class="dashAnchor"></a>
<a href="#/ClientRequest">
<h3 class="section-name">ClientRequest</h3>
</a>
<div class="section-name-container">
<a class="section-name-link" href="#/ClientRequest"></a>
<h3 class="section-name"><p>ClientRequest</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -294,10 +301,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -327,10 +330,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand All @@ -344,7 +343,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The <q>root</q> class for the FastCGI server implementation.</p>
<p>The &ldquo;root&rdquo; class for the FastCGI server implementation.</p>

<a href="Classes/FastCGI.html" class="slightly-smaller">See more</a>
</div>
Expand All @@ -359,10 +358,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -392,10 +387,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -425,10 +416,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -464,9 +451,11 @@ <h4>Declaration</h4>
<div class="task-name-container">
<a name="/HTTP"></a>
<a name="//apple_ref/swift/Section/HTTP" class="dashAnchor"></a>
<a href="#/HTTP">
<h3 class="section-name">HTTP</h3>
</a>
<div class="section-name-container">
<a class="section-name-link" href="#/HTTP"></a>
<h3 class="section-name"><p>HTTP</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -519,9 +508,11 @@ <h4>Declaration</h4>
<div class="task-name-container">
<a name="/HTTPServer"></a>
<a name="//apple_ref/swift/Section/HTTPServer" class="dashAnchor"></a>
<a href="#/HTTPServer">
<h3 class="section-name">HTTPServer</h3>
</a>
<div class="section-name-container">
<a class="section-name-link" href="#/HTTPServer"></a>
<h3 class="section-name"><p>HTTPServer</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand All @@ -537,14 +528,7 @@ <h3 class="section-name">HTTPServer</h3>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An HTTP server that listens for connections on a socket.</p>
<h3 id='usage-example' class='heading'>Usage Example:</h3>
<pre class="highlight swift"><code> <span class="c1">//Create a server that listens for connections on a specified socket.</span>
<span class="k">let</span> <span class="nv">server</span> <span class="o">=</span> <span class="k">try</span> <span class="kt">HTTPServer</span><span class="o">.</span><span class="nf">listen</span><span class="p">(</span><span class="nv">on</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="nv">delegate</span><span class="p">:</span> <span class="n">delegate</span><span class="p">)</span>
<span class="o">...</span>
<span class="c1">//Stop the server.</span>
<span class="n">server</span><span class="o">.</span><span class="nf">stop</span><span class="p">()</span>
</code></pre>
<p>Undocumented</p>

<a href="Classes/HTTPServer.html" class="slightly-smaller">See more</a>
</div>
Expand All @@ -565,9 +549,11 @@ <h4>Declaration</h4>
<div class="task-name-container">
<a name="/HTTPServerRequest"></a>
<a name="//apple_ref/swift/Section/HTTPServerRequest" class="dashAnchor"></a>
<a href="#/HTTPServerRequest">
<h3 class="section-name">HTTPServerRequest</h3>
</a>
<div class="section-name-container">
<a class="section-name-link" href="#/HTTPServerRequest"></a>
<h3 class="section-name"><p>HTTPServerRequest</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -620,9 +606,11 @@ <h4>Declaration</h4>
<div class="task-name-container">
<a name="/HTTPServerResponse"></a>
<a name="//apple_ref/swift/Section/HTTPServerResponse" class="dashAnchor"></a>
<a href="#/HTTPServerResponse">
<h3 class="section-name">HTTPServerResponse</h3>
</a>
<div class="section-name-container">
<a class="section-name-link" href="#/HTTPServerResponse"></a>
<h3 class="section-name"><p>HTTPServerResponse</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -671,10 +659,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand All @@ -698,16 +682,13 @@ <h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">HeadersContainer</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HeadersContainer</span><span class="p">:</span> <span class="kt">Collection</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -749,9 +730,11 @@ <h4>Declaration</h4>
<div class="task-name-container">
<a name="/SPIUtils"></a>
<a name="//apple_ref/swift/Section/SPIUtils" class="dashAnchor"></a>
<a href="#/SPIUtils">
<h3 class="section-name">SPIUtils</h3>
</a>
<div class="section-name-container">
<a class="section-name-link" href="#/SPIUtils"></a>
<h3 class="section-name"><p>SPIUtils</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -792,9 +775,11 @@ <h4>Declaration</h4>
<div class="task-name-container">
<a name="/URLParser"></a>
<a name="//apple_ref/swift/Section/URLParser" class="dashAnchor"></a>
<a href="#/URLParser">
<h3 class="section-name">URLParser</h3>
</a>
<div class="section-name-container">
<a class="section-name-link" href="#/URLParser"></a>
<h3 class="section-name"><p>URLParser</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -840,8 +825,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-10-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura project contributors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Loading