commit 6faead4e6342eeb35556e5594dd23ba17d4fa670 Author: Alex Crichton Date: Fri Aug 26 16:26:03 2016 -0700 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a9d37c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +target +Cargo.lock diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..eff7de1 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,24 @@ +language: rust + +rust: + - stable + - beta + - nightly +sudo: false +before_script: + - pip install 'travis-cargo<0.2' --user && export PATH=$HOME/.local/bin:$PATH +script: + - cargo build + - cargo test + - cargo doc --no-deps +after_success: + - travis-cargo --only nightly doc-upload +env: + global: + - secure: LU4wJZYCqDdxKVGFKv8XInk6GzE5ubVVu9g8vXbkyXOS2+sNhT1bMjLE+7jxFwZTSnaCXmQ5+Vo6thpnGEmndVdvbvsmYL0EswPhAXcatgc4zG+ntjbo6x1Fl+VE9l3+84yB5jWIGx1YCPBbG1hkW0QyaxPTOHnrdqcD3KEbkGYFea69mLGFLDB+0GZxr8VeNag38qXZt/yp4C8KR/la7sOlAuXGBAsNQsUK1laUWg/z71KnsprBk37hqAyH+QPks0B9BDuFKO2WYwZPNx/P+S+HuVeNmNA77JKO84NOyEcVrjm3zl0AYEA1Ovofkx2UuYKeHlKlXPncTKXoHwRnFk870nubVM/YNs1k0IlOxz11YXQW3Va3zu5BlEySn8coY8q5/x/UuAe9S/eIxeT2zJNcddaKGa9oEPaL1OJZdDt2zrIpJFC8btm/3AmzRjMx00pm04nmv1eoLgMjPTpdkD6SoHIHOzkodtAMb9qfovVyLUKKFCVMA3ZBK3bO2s7N69pQol3wlDrv8lhy0ZS1YzDyJNI3gn1+nafr2o8L4BgH+ROgYXF+JSx0AFc1ZegAokUYkwBd1Q33oEMYvw/jw66qPldoonAYhI+V6du9PIRLve+G1CT8dVjFH7220Qr07Nezz7FKikIEY4hhgT7Y6Y2R0sQNJNbeiE50eWjbaEo= +notifications: + email: + on_success: never +os: + - linux + - osx diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..f420ee3 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,16 @@ +[package] + +name = "tokio-service" +version = "0.1.0" +license = "MIT/Apache-2.0" +authors = ["Carl Lerche "] +description = """ +The core `Service` trait for Tokio. +""" +documentation = "https://tokio-rs.github.io/tokio-service" +homepage = "https://github.com/tokio-rs/tokio-service" +repository = "https://github.com/tokio-rs/tokio-service" +readme = "README.md" + +[dependencies] +futures = { git = "https://github.com/alexcrichton/futures-rs", default-features = false } diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -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 [yyyy] [name of copyright owner] + +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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..28e630c --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2016 Alex Crichton + +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. diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..75c11da --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,15 @@ +environment: + matrix: + - TARGET: x86_64-pc-windows-msvc +install: + - curl -sSf -o rustup-init.exe https://win.rustup.rs/ + - rustup-init.exe -y --default-host %TARGET% + - set PATH=%PATH%;C:\Users\appveyor\.cargo\bin + - rustc -V + - cargo -V + +build: false + +test_script: + - cargo build + - cargo test diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..eecea25 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,203 @@ +//! Definition of the core `Service` trait to Tokio +//! +//! More information can be found on [the trait] itself. +//! +//! [the trait]: trait.Service.html + +#![deny(missing_docs)] + +extern crate futures; + +use std::marker::PhantomData; +use std::sync::Arc; + +use futures::{Future, IntoFuture}; + +/// An asynchronous function from `Request` to a `Response`. +/// +/// The `Service` trait is a simplified interface making it easy to write +/// network applications in a modular and reusable way, decoupled from the +/// underlying protocol. It is one of Tokio's fundamental abstractions. +/// +/// # Functional +/// +/// A `Service` is a function from a `Request`. It immediately returns a +/// `Future` representing the the eventual completion of processing the +/// request. The actual request processing may happen at any time in the +/// future, on any thread or executor. The processing may depend on calling +/// other services. At some point in the future, the processing will complete, +/// and the `Future` will resolve to a response or error. +/// +/// At a high level, the `Service::call` represents an RPC request. The +/// `Service` value can be a server or a client. +/// +/// # Server +/// +/// An RPC server *implements* the `Service` trait. Requests received by the +/// server over the network are deserialized then passed as an argument to the +/// server value. The returned response is sent back over the network. +/// +/// As an example, here is how an HTTP request is processed by a server: +/// +/// ```rust,ignore +/// impl Service for HelloWorld { +/// type Req = http::Request; +/// type Resp = http::Response; +/// type Error = http::Error; +/// type Fut = Box>; +/// +/// fn call(&self, req: http::Request) -> Self::Fut { +/// // Create the HTTP response +/// let resp = http::Response::ok() +/// .with_body(b"hello world\n"); +/// +/// // Return the response as an immediate future +/// futures::finished(resp).boxed() +/// } +/// } +/// ``` +/// +/// # Client +/// +/// A client consumes a service by using a `Service` value. The client may +/// issue requests by invoking `call` and passing the request as an argument. +/// It then waits receives the response by waiting for the returned future. +/// +/// As an example, here is how a Redis request would be issued: +/// +/// ```rust,ignore +/// let client = redis::Client::new() +/// .connect("127.0.0.1:6379".parse().unwrap()) +/// .unwrap(); +/// +/// let resp = client.call(Cmd::set("foo", "this is the value of foo")); +/// +/// // Wait for the future to resolve +/// println!("Redis response: {:?}", await(resp)); +/// ``` +/// +/// # Middleware +/// +/// More often than not, all the pieces needed for writing robust, scalable +/// network applications are the same no matter the underlying protocol. By +/// unifying the API for both clients and servers in a protocol agnostic way, +/// it is possible to write middlware that provide these pieces in in a +/// reusable way. +/// +/// For example, take timeouts as an example: +/// +/// ```rust,ignore +/// use tokio::Service; +/// use futures::Future; +/// use std::time::Duration; +/// +/// // Not yet implemented, but soon :) +/// use tokio::timer::{Timer, Expired}; +/// +/// pub struct Timeout { +/// upstream: T, +/// delay: Duration, +/// timer: Timer, +/// } +/// +/// impl Timeout { +/// pub fn new(upstream: T, delay: Duration) -> Timeout { +/// Timeout { +/// upstream: upstream, +/// delay: delay, +/// timer: Timer::default(), +/// } +/// } +/// } +/// +/// impl Service for Timeout +/// where T: Service, +/// T::Error: From, +/// { +/// type Req = T::Req; +/// type Resp = T::Resp; +/// type Error = T::Error; +/// type Fut = Box>; +/// +/// fn call(&self, req: Self::Req) -> Self::Fut { +/// let timeout = self.timer.timeout(self.delay) +/// .and_then(|timeout| Err(Self::Error::from(timeout))); +/// +/// self.upstream.call(req) +/// .select(timeout) +/// .map(|(v, _)| v) +/// .map_err(|(e, _)| e) +/// .boxed() +/// } +/// } +/// +/// ``` +/// +/// The above timeout implementation is decoupled from the underlying protocol +/// and is also decoupled from client or server concerns. In other words, the +/// same timeout middleware could be used in either a client or a server. +pub trait Service: Send + 'static { + + /// Requests handled by the service. + type Req: Send + 'static; + + /// Responses given by the service. + type Resp: Send + 'static; + + /// Errors produced by the service. + type Error: Send + 'static; + + /// The future response value. + type Fut: Future + Send + 'static; + + /// Process the request and return the response asynchronously. + fn call(&self, req: Self::Req) -> Self::Fut; +} + +/// A service implemented by a closure. +pub struct SimpleService { + f: Arc, + _ty: PhantomData R>, // don't impose Sync on R +} + +/// Returns a `Service` backed by the given closure. +pub fn simple_service(f: F) -> SimpleService { + SimpleService::new(f) +} + +impl SimpleService { + /// Create and return a new `SimpleService` backed by the given function. + pub fn new(f: F) -> SimpleService { + SimpleService { + f: Arc::new(f), + _ty: PhantomData, + } + } +} + +impl Service for SimpleService + where F: Fn(R) -> S + Sync + Send + 'static, + R: Send + 'static, + S: IntoFuture + Send + 'static, + S::Future: Send + 'static, + ::Item: Send + 'static, + ::Error: Send + 'static, +{ + type Req = R; + type Resp = S::Item; + type Error = S::Error; + type Fut = S::Future; + + fn call(&self, req: R) -> Self::Fut { + (self.f)(req).into_future() + } +} + +impl Clone for SimpleService { + fn clone(&self) -> SimpleService { + SimpleService { + f: self.f.clone(), + _ty: PhantomData, + } + } +}