Permalink
Browse files

Initial commit

  • Loading branch information...
0 parents commit 4321d820b9443a7d8d2690bfbc416596a9a2d52f @alexcrichton alexcrichton committed Sep 9, 2016
Showing with 343 additions and 0 deletions.
  1. +201 −0 LICENSE-APACHE
  2. +25 −0 LICENSE-MIT
  3. +117 −0 README.md
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright 2016 Tokio contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
@@ -0,0 +1,25 @@
+Copyright (c) 2016 Tokio contributors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,117 @@
+# Tokio
+
+Tokio is a one-stop-shop for all your async I/O needs in Rust. At the heart of
+Tokio is the [`futures`] crate to model asynchronous computations, and you'll
+find all layers from futures to event loops to protocols to services in the
+various Tokio crates.
+
+> **Note**: Currently the Tokio project is a work in progress, so breakage
+> should be expected. Crates will be published to crates.io as they
+> begin to stabilize, and this repository itself will eventually be
+> home to a `tokio` crate as well. Stay tuned for updates!
+
+## What is Tokio?
+
+Tokio is a an async I/O stack in Rust running the full gamut in terms of what it
+provides. At the very bottom you'll find the [`tokio-core`] crate with a
+bare-bones event loop and `Future` spawning. Near the top you'll find the
+[`tokio-proto`] crate with generic implementations of protocol details like
+pipelining and multiplexing used to serve requests to the [`Service`] trait in
+[`tokio-service`] inspired by [Finagle].
+
+[Finagle]: https://twitter.github.io/finagle/
+
+The Tokio project is split into a number of crates to encapsulate
+responsibilities and encourage reuse. Some layers of the Tokio stack are more
+"opinionated" than others, for example with a particular buffering strategy.
+Currently the lowest layers, [`tokio-core`] and [`tokio-service`], are intended
+to be zero-to-very-low cost abstractions while moving up to crates like
+[`tokio-proto`] may not be zero cost for some applications.
+
+It's intended that the `tokio` crate (not existent yet) is generally what you'll
+want for async I/O, and more specialized applications can use the dependencies
+individually. This document is then intended to help you navigate what's
+available!
+
+## Tokio Crates
+
+* [`tokio-core`] - the core I/O event loop for all of Tokio
+* [`tokio-service`] - definition of the `Service` trait for applications wishing
+ to define a service or work with middleware.
+* [`tokio-proto`] - protocol implementation utilities such as
+ pipelining/multiplexing
+* [`tokio-curl`] - a sample HTTP client backed by libcurl
+* [`tokio-socks5`] - a sample SOCKSv5 proxy server
+* [`tokio-line`] - a sample line-based protocol for using [`tokio-proto`]
+* [`tokio-middleware`] - collection of middleware using the [`tokio-service`] crate
+* [`tokio-minihttp`] - a mini HTTP server implementation intended to showcase
+ [`tokio-proto`]
+* [`tokio-redis`] - an implementation of the Redis protocol using
+ [`tokio-proto`]
+* [`tokio-timer`] - a timer wheel and other timer-related functions for use with
+ an event loop
+* [`tokio-tls`] - an implementation of TLS/SSL streams used by
+ [`tokio-minihttp`] for an SSL server
+* [`tokio-uds`] - Unix domain sockets for [`tokio-core`]
+
+### Third-party Tokio Crates
+
+In addition to the crates above in the `tokio-rs` organization, there are a few
+crates outside the organization which integrate with Tokio:
+
+* [`tokio-dns`] - asynchronous DNS resolution and utilities
+* [`tokio-signal`] - Unix signal handling and Windows console control events
+* [`tokio-process`] - process management and spawning
+
+## Current Status
+
+A bottom-up approach is currently being used to stabilize pieces and enable more
+and more applications to build on the stable portions of Tokio. The [`futures`]
+crate recently published 0.1, and the Tokio crates are intended to follow suit
+soon. Listed below is a table of the current status of each crate.
+
+| Crate | Status |
+|----------------------|----------|
+| [`tokio-core`] | [Nearly 0.1](https://github.com/tokio-rs/tokio-core/milestone/1) |
+| [`tokio-service`] | Nearly 0.1 |
+| [`tokio-proto`] | Waiting on `tokio-core`, next major piece |
+| [`tokio-curl`] | Waiting on `tokio-core` |
+| [`tokio-timer`] | Waiting on `tokio-core` |
+| [`tokio-tls`] | Waiting on `tokio-core` and `native-tls` |
+| [`tokio-uds`] | Waiting on `tokio-core` |
+| [`tokio-middleware`] | Planned soon after `tokio-service` |
+
+Note that the following example projects are not currently intended to be
+published on crates.io:
+
+* [`tokio-socks5`]
+* [`tokio-line`]
+* [`tokio-minihttp`]
+* [`tokio-redis`]
+
+## License
+
+Tokio is primarily distributed under the terms of both the MIT license
+and the Apache License (Version 2.0), with portions covered by various
+BSD-like licenses.
+
+See LICENSE-APACHE, and LICENSE-MIT for details.
+
+[`tokio-core`]: https://github.com/tokio-rs/tokio-core
+[`tokio-curl`]: https://github.com/tokio-rs/tokio-curl
+[`tokio-dns`]: https://github.com/sbstp/tokio-dns
+[`tokio-line`]: https://github.com/tokio-rs/tokio-line
+[`tokio-middleware`]: https://github.com/tokio-rs/tokio-middleware
+[`tokio-minihttp`]: https://github.com/tokio-rs/tokio-minihttp
+[`tokio-process`]: https://github.com/alexcrichton/tokio-process
+[`tokio-proto`]: https://github.com/tokio-rs/tokio-proto
+[`tokio-redis`]: https://github.com/tokio-rs/tokio-redis
+[`tokio-service`]: https://github.com/tokio-rs/tokio-service
+[`tokio-signal`]: https://github.com/alexcrichton/tokio-signal
+[`tokio-socks5`]: https://github.com/tokio-rs/tokio-socks5
+[`tokio-timer`]: https://github.com/tokio-rs/tokio-timer
+[`tokio-tls`]: https://github.com/tokio-rs/tokio-tls
+[`tokio-uds`]: https://github.com/tokio-rs/tokio-uds
+[`futures`]: https://github.com/alexcrichton/futures-rs
+[`native-tls`]: https://github.com/sfackler/rust-native-tls
+[`Service`]: https://tokio-rs.github.io/tokio-service/tokio_service/trait.Service.html

0 comments on commit 4321d82

Please sign in to comment.