├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── appveyor.yml └── src └── lib.rs /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "tokio-named-pipes" 3 | version = "0.1.0" 4 | authors = ["Alex Crichton ", "Nikolay Volf "] 5 | license = "MIT/Apache-2.0" 6 | readme = "README.md" 7 | repository = "https://github.com/nikvolf/tokio-named-pipes" 8 | homepage = "https://github.com/nikvolf/tokio-named-pipes" 9 | description = """ 10 | Windows named pipe bindings for tokio. 11 | """ 12 | 13 | [dependencies] 14 | mio = "0.6" 15 | tokio = "0.1" 16 | mio-named-pipes = "0.1" 17 | futures = "0.1" 18 | bytes = "0.4" -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2014 Alex Crichton 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE. 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # tokio-named-pipes 2 | [![Build status](https://ci.appveyor.com/api/projects/status/motwon3ro35xwb2x?svg=true)](https://ci.appveyor.com/project/NikolayVolf/tokio-named-pipes) 3 | 4 | [Documentation](http://alexcrichton.com/tokio-named-pipes) 5 | 6 | A library for integrating Windows [Named Pipes] with [tokio]. 7 | 8 | [Named Pipes]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365590(v=vs.85).aspx 9 | [tokio]: https://github.com/tokio-rs/tokio 10 | 11 | ```toml 12 | # Cargo.toml 13 | [dependencies] 14 | tokio-named-pipes = { git = "https://github.com/NikVolf/tokio-named-pipes", branch = "stable" } 15 | ``` 16 | 17 | Next, add this to your crate: 18 | 19 | ```rust 20 | extern crate tokio_named_pipes; 21 | ``` 22 | 23 | # License 24 | 25 | `tokio-named-pipes` is primarily distributed under the terms of both the MIT 26 | license and the Apache License (Version 2.0), with portions covered by various 27 | BSD-like licenses. 28 | 29 | See LICENSE-APACHE, and LICENSE-MIT for details. 30 | 31 | 32 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | environment: 2 | matrix: 3 | - TARGET: x86_64-pc-windows-msvc 4 | 5 | install: 6 | - curl -sSf -o rustup-init.exe https://win.rustup.rs/ 7 | - rustup-init.exe -y --default-host %TARGET% 8 | - set PATH=%PATH%;C:\Users\appveyor\.cargo\bin;C:\MinGW\bin 9 | 10 | - rustc -vV 11 | - cargo -vV 12 | 13 | build: false 14 | 15 | test_script: 16 | - cargo test 17 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! Tokio wrapper for windows named pipes. 2 | 3 | #![cfg(windows)] 4 | #![warn(missing_docs)] 5 | 6 | extern crate tokio; 7 | extern crate bytes; 8 | extern crate mio; 9 | extern crate mio_named_pipes; 10 | extern crate futures; 11 | 12 | use std::ffi::OsStr; 13 | use std::fmt; 14 | use std::io::{Read, Write}; 15 | use std::os::windows::io::*; 16 | 17 | use futures::{Async, Poll}; 18 | use bytes::{BufMut, Buf}; 19 | use mio::Ready; 20 | use tokio::reactor::{Handle, PollEvented2}; 21 | use tokio::io::{AsyncRead, AsyncWrite}; 22 | 23 | /// Named pipe connection. 24 | pub struct NamedPipe { 25 | io: PollEvented2, 26 | } 27 | 28 | impl NamedPipe { 29 | /// New named pipe connection to the existing event pool. 30 | pub fn new>(p: P, handle: &Handle) -> std::io::Result { 31 | let inner = try!(mio_named_pipes::NamedPipe::new(p.as_ref())); 32 | NamedPipe::from_pipe(inner, handle) 33 | } 34 | 35 | /// New named pipe connection to the existing event pool from the existig mio pipe. 36 | pub fn from_pipe(pipe: mio_named_pipes::NamedPipe, handle: &Handle) 37 | -> std::io::Result { 38 | Ok(NamedPipe { 39 | io: PollEvented2::new_with_handle(pipe, handle)?, 40 | }) 41 | } 42 | 43 | /// Connect to the pipe. 44 | pub fn connect(&self) -> std::io::Result<()> { 45 | self.io.get_ref().connect() 46 | } 47 | 48 | /// Disconnect from the pipe. 49 | pub fn disconnect(&self) -> std::io::Result<()> { 50 | self.io.get_ref().disconnect() 51 | } 52 | 53 | /// Poll connection for read. 54 | pub fn poll_read_ready_readable(&mut self) -> tokio::io::Result> { 55 | self.io.poll_read_ready(Ready::readable()) 56 | } 57 | 58 | /// Poll connection for write. 59 | pub fn poll_write_ready(&mut self) -> tokio::io::Result> { 60 | self.io.poll_write_ready() 61 | } 62 | 63 | fn io_mut(&mut self) -> &mut PollEvented2 { 64 | &mut self.io 65 | } 66 | } 67 | 68 | impl Read for NamedPipe { 69 | fn read(&mut self, buf: &mut [u8]) -> std::io::Result { 70 | self.io.read(buf) 71 | } 72 | } 73 | 74 | impl Write for NamedPipe { 75 | fn write(&mut self, buf: &[u8]) -> std::io::Result { 76 | self.io.write(buf) 77 | } 78 | fn flush(&mut self) -> std::io::Result<()> { 79 | self.io.flush() 80 | } 81 | } 82 | 83 | impl<'a> Read for &'a NamedPipe { 84 | fn read(&mut self, buf: &mut [u8]) -> std::io::Result { 85 | (&self.io).read(buf) 86 | } 87 | } 88 | 89 | impl<'a> Write for &'a NamedPipe { 90 | fn write(&mut self, buf: &[u8]) -> std::io::Result { 91 | (&self.io).write(buf) 92 | } 93 | 94 | fn flush(&mut self) -> std::io::Result<()> { 95 | (&self.io).flush() 96 | } 97 | } 98 | 99 | impl AsyncRead for NamedPipe { 100 | unsafe fn prepare_uninitialized_buffer(&self, _: &mut [u8]) -> bool { 101 | false 102 | } 103 | 104 | fn read_buf(&mut self, buf: &mut B) -> Poll { 105 | if let Async::NotReady = self.io.poll_read_ready(Ready::readable())? { 106 | return Ok(Async::NotReady) 107 | } 108 | 109 | let mut stack_buf = [0u8; 1024]; 110 | let bytes_read = self.io_mut().read(&mut stack_buf); 111 | match bytes_read { 112 | Err(ref e) if e.kind() == std::io::ErrorKind::WouldBlock => { 113 | self.io_mut().clear_read_ready(Ready::readable())?; 114 | return Ok(Async::NotReady); 115 | }, 116 | Err(e) => Err(e), 117 | Ok(bytes_read) => { 118 | buf.put_slice(&stack_buf[0..bytes_read]); 119 | Ok(Async::Ready(bytes_read)) 120 | } 121 | } 122 | } 123 | } 124 | 125 | impl AsyncWrite for NamedPipe { 126 | fn shutdown(&mut self) -> Poll<(), std::io::Error> { 127 | Ok(().into()) 128 | } 129 | 130 | fn write_buf(&mut self, buf: &mut B) -> Poll { 131 | if let Async::NotReady = self.io.poll_write_ready()? { 132 | return Ok(Async::NotReady) 133 | } 134 | 135 | let bytes_wrt = self.io_mut().write(buf.bytes()); 136 | match bytes_wrt { 137 | Err(ref e) if e.kind() == std::io::ErrorKind::WouldBlock => { 138 | self.io_mut().clear_write_ready()?; 139 | return Ok(Async::NotReady); 140 | }, 141 | Err(e) => Err(e), 142 | Ok(bytes_wrt) => { 143 | buf.advance(bytes_wrt); 144 | Ok(Async::Ready(bytes_wrt)) 145 | } 146 | } 147 | } 148 | } 149 | 150 | impl fmt::Debug for NamedPipe { 151 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 152 | self.io.get_ref().fmt(f) 153 | } 154 | } 155 | 156 | impl AsRawHandle for NamedPipe { 157 | fn as_raw_handle(&self) -> RawHandle { 158 | self.io.get_ref().as_raw_handle() 159 | } 160 | } 161 | --------------------------------------------------------------------------------