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/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..a581353 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,13 @@ +[package] +name = "tokio-line" +version = "0.1.0" +authors = ["Carl Lerche "] + +[dependencies] +log = "*" +mio = { git = "https://github.com/carllerche/mio", branch = "dev" } +tokio = { git = "https://github.com/tokio-rs/tokio" } +futures = "0.1.0" + +[dev-dependencies] +env_logger = "0.3.0" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..2a6afc5 --- /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 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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..d5a3b63 --- /dev/null +++ b/LICENSE-MIT @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2afa645 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Tokio Line Proto + +A very basic protocol built on top of Tokio. The line protocol is UTF-8 +strings such that each message is terminated with a new line. The +library shows how to implement a client and server on using Tokio and +the example shows how to consume the client and server. + +## 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. diff --git a/examples/echo.rs b/examples/echo.rs new file mode 100644 index 0000000..a7538e7 --- /dev/null +++ b/examples/echo.rs @@ -0,0 +1,44 @@ +extern crate futures; +extern crate tokio; +extern crate tokio_line as line; +extern crate env_logger; + +use futures::Future; +use tokio::Service; + +pub fn main() { + env_logger::init().unwrap(); + + let addr = "127.0.0.1:12345".parse().unwrap(); + + line::Server::new() + .bind(addr) + .serve(tokio::simple_service(|msg| { + println!("GOT: {:?}", msg); + Ok(msg) + })) + .unwrap(); + + + let client = line::Client::new() + .connect(&addr) + .unwrap(); + + let resp = client.call("Hello".to_string()); + println!("RESPONSE: {:?}", await(resp)); + + drop(client); +} + +// Why this isn't in futures-rs, I do not know... +fn await(f: T) -> Result { + use std::sync::mpsc; + let (tx, rx) = mpsc::channel(); + + f.then(move |res| { + tx.send(res).unwrap(); + Ok::<(), ()>(()) + }).forget(); + + rx.recv().unwrap() +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..b1e1839 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,222 @@ +extern crate tokio; +extern crate mio; + +#[macro_use] +extern crate log; + +use tokio::{server, NewService}; +use tokio::io::{Readiness, Transport}; +use tokio::proto::pipeline; +use tokio::reactor::{Reactor, ReactorHandle}; +use std::{io, mem}; +use std::net::SocketAddr; + +/// Line transport +pub struct Line { + inner: T, + rd: Vec, + wr: io::Cursor>, +} + +pub struct Server { + reactor: Option, + addr: Option +} + +pub struct Client { + reactor: Option, +} + +impl Server { + pub fn new() -> Server { + Server { + reactor: None, + addr: None, + } + } + + pub fn bind(mut self, addr: SocketAddr) -> Self { + self.addr = Some(addr); + self + } + + pub fn serve(self, new_service: T) -> io::Result<()> + where T: NewService + Send + 'static, + { + let reactor = match self.reactor { + Some(r) => r, + None => { + let reactor = try!(Reactor::default()); + let handle = reactor.handle(); + reactor.spawn(); + handle + }, + }; + + let addr = self.addr.unwrap_or_else(|| "0.0.0.0:0".parse().unwrap()); + + try!(server::listen(&reactor, addr, move |stream| { + // Initialize the pipeline dispatch with the service and the line + // transport + let service = try!(new_service.new_service()); + pipeline::Server::new(service, Line::new(stream)) + })); + + Ok(()) + } +} + +pub type ClientHandle = pipeline::ClientHandle; + +impl Client { + pub fn new() -> Client { + Client { + reactor: None, + } + } + + pub fn connect(self, addr: &SocketAddr) -> io::Result { + let reactor = match self.reactor { + Some(r) => r, + None => { + let reactor = try!(Reactor::default()); + let handle = reactor.handle(); + reactor.spawn(); + handle + }, + }; + + let addr = addr.clone(); + + // Connect the client + Ok(pipeline::connect(&reactor, addr, |stream| Ok(Line::new(stream)))) + } +} + +impl Line + where T: io::Read + io::Write + Readiness, +{ + pub fn new(inner: T) -> Line { + Line { + inner: inner, + rd: vec![], + wr: io::Cursor::new(vec![]), + } + } +} + +pub type Frame = pipeline::Frame; + +impl Transport for Line + where T: io::Read + io::Write + Readiness +{ + type In = Frame; + type Out = Frame; + + /// Read a message from the `Transport` + fn read(&mut self) -> io::Result> { + loop { + if let Some(n) = self.rd.iter().position(|b| *b == b'\n') { + let tail = self.rd.split_off(n+1); + let mut line = mem::replace(&mut self.rd, tail); + + // Remove the new line + line.truncate(n); + + return String::from_utf8(line) + .map(|s| Some(pipeline::Frame::Message(s))) + .map_err(|_| io::Error::new(io::ErrorKind::Other, "invalid string")); + } + + match self.inner.read_to_end(&mut self.rd) { + Ok(0) => return Ok(Some(pipeline::Frame::Done)), + Ok(_) => {} + Err(e) => { + if e.kind() == io::ErrorKind::WouldBlock { + return Ok(None); + } + + return Err(e) + } + } + } + } + + /// Write a message to the `Transport` + fn write(&mut self, req: Frame) -> io::Result> { + match req { + pipeline::Frame::Message(req) => { + trace!("writing value; val={:?}", req); + if self.wr.position() < self.wr.get_ref().len() as u64 { + return Err(io::Error::new(io::ErrorKind::Other, "transport has pending writes")); + } + + let mut bytes = req.into_bytes(); + bytes.push(b'\n'); + + self.wr = io::Cursor::new(bytes); + self.flush() + } + _ => unimplemented!(), + } + } + + /// Flush pending writes to the socket + fn flush(&mut self) -> io::Result> { + trace!("flushing transport"); + loop { + // Making the borrow checker happy + let res = { + let buf = { + let pos = self.wr.position() as usize; + let buf = &self.wr.get_ref()[pos..]; + + if buf.is_empty() { + trace!("transport flushed"); + return Ok(Some(())); + } + + trace!("writing; remaining={:?}", buf); + + buf + }; + + self.inner.write(buf) + }; + + match res { + Ok(mut n) => { + n += self.wr.position() as usize; + self.wr.set_position(n as u64) + } + Err(e) => { + if e.kind() == io::ErrorKind::WouldBlock { + trace!("transport flush would block"); + return Ok(None); + } + + trace!("transport flush error; err={:?}", e); + return Err(e) + } + } + } + } +} + +impl Readiness for Line + where T: Readiness +{ + fn is_readable(&self) -> bool { + self.inner.is_readable() + } + + fn is_writable(&self) -> bool { + let is_writable = self.wr.position() == self.wr.get_ref().len() as u64; + + if !is_writable { + assert!(!self.inner.is_writable()); + } + + is_writable + } +}