mirror of https://github.com/smol-rs/nb-connect
Initial commit
This commit is contained in:
commit
a7d9f52d18
|
@ -0,0 +1 @@
|
||||||
|
github: stjepang
|
|
@ -0,0 +1,51 @@
|
||||||
|
name: Build and test
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build_and_test:
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
os: [ubuntu-latest]
|
||||||
|
rust: [nightly, beta, stable]
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Set current week of the year in environnement
|
||||||
|
if: startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macOS')
|
||||||
|
run: echo "::set-env name=CURRENT_WEEK::$(date +%V)"
|
||||||
|
|
||||||
|
- name: Set current week of the year in environnement
|
||||||
|
if: startsWith(matrix.os, 'windows')
|
||||||
|
run: echo "::set-env name=CURRENT_WEEK::$(Get-Date -UFormat %V)"
|
||||||
|
|
||||||
|
- name: Install latest ${{ matrix.rust }}
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: ${{ matrix.rust }}
|
||||||
|
profile: minimal
|
||||||
|
override: true
|
||||||
|
|
||||||
|
- name: Run cargo check
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: check
|
||||||
|
args: --all --bins --examples --tests --all-features
|
||||||
|
|
||||||
|
- name: Run cargo check (without dev-dependencies to catch missing feature flags)
|
||||||
|
if: startsWith(matrix.rust, 'nightly')
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: check
|
||||||
|
args: -Z features=dev_dep
|
||||||
|
|
||||||
|
- name: Run cargo test
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: test
|
|
@ -0,0 +1,26 @@
|
||||||
|
name: Lint
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
clippy:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Set current week of the year in environnement
|
||||||
|
run: echo "::set-env name=CURRENT_WEEK::$(date +%V)"
|
||||||
|
|
||||||
|
- uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: stable
|
||||||
|
profile: minimal
|
||||||
|
components: clippy
|
||||||
|
- uses: actions-rs/clippy-check@v1
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
args: --all-features -- -W clippy::all
|
|
@ -0,0 +1,20 @@
|
||||||
|
name: Security audit
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security_audit:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Set current week of the year in environnement
|
||||||
|
run: echo "::set-env name=CURRENT_WEEK::$(date +%V)"
|
||||||
|
|
||||||
|
- uses: actions-rs/audit-check@v1
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
@ -0,0 +1,2 @@
|
||||||
|
/target
|
||||||
|
Cargo.lock
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Version 1.0.0
|
||||||
|
|
||||||
|
- Initial version
|
|
@ -0,0 +1,25 @@
|
||||||
|
[package]
|
||||||
|
name = "nb-connect"
|
||||||
|
version = "1.0.0"
|
||||||
|
authors = [
|
||||||
|
"Stjepan Glavina <stjepang@gmail.com>",
|
||||||
|
"Jayce Fayne <jayce.fayne@mailbox.org>",
|
||||||
|
]
|
||||||
|
edition = "2018"
|
||||||
|
description = "Non-blocking TCP or Unix connect"
|
||||||
|
license = "Apache-2.0 OR MIT"
|
||||||
|
repository = "https://github.com/stjepang/nb-connect"
|
||||||
|
homepage = "https://github.com/stjepang/nb-connect"
|
||||||
|
documentation = "https://docs.rs/nb-connect"
|
||||||
|
keywords = ["TcpStream", "UnixStream", "socket2", "polling"]
|
||||||
|
categories = ["asynchronous", "network-programming", "os"]
|
||||||
|
readme = "README.md"
|
||||||
|
|
||||||
|
[target."cfg(unix)".dependencies]
|
||||||
|
libc = "0.2.77"
|
||||||
|
|
||||||
|
[target.'cfg(windows)'.dependencies]
|
||||||
|
winapi = { version = "0.3.9", features = ["handleapi", "ws2tcpip"] }
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
polling = "1.0.2"
|
|
@ -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.
|
|
@ -0,0 +1,23 @@
|
||||||
|
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,57 @@
|
||||||
|
# nb-connect
|
||||||
|
|
||||||
|
[![Build](https://github.com/stjepang/nb-connect/workflows/Build%20and%20test/badge.svg)](
|
||||||
|
https://github.com/stjepang/nb-connect/actions)
|
||||||
|
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](
|
||||||
|
https://github.com/stjepang/nb-connect)
|
||||||
|
[![Cargo](https://img.shields.io/crates/v/nb-connect.svg)](
|
||||||
|
https://crates.io/crates/nb-connect)
|
||||||
|
[![Documentation](https://docs.rs/nb-connect/badge.svg)](
|
||||||
|
https://docs.rs/nb-connect)
|
||||||
|
|
||||||
|
Non-blocking TCP or Unix connect.
|
||||||
|
|
||||||
|
This crate allows you to create a [`TcpStream`] or a [`UnixStream`] in a non-blocking way,
|
||||||
|
without waiting for the connection to become fully established.
|
||||||
|
|
||||||
|
[`TcpStream`]: https://doc.rust-lang.org/stable/std/net/struct.TcpStream.html
|
||||||
|
[`UnixStream`]: https://doc.rust-lang.org/stable/std/os/unix/net/struct.UnixStream.html
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
```rust
|
||||||
|
use polling::{Event, Poller};
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
// Create a pending TCP connection.
|
||||||
|
let stream = nb_connect::tcp(([127, 0, 0, 1], 80))?;
|
||||||
|
|
||||||
|
// Create a poller that waits for the stream to become writable.
|
||||||
|
let poller = Poller::new()?;
|
||||||
|
poller.insert(&stream);
|
||||||
|
poller.interest(&stream, Event::writable(0))?;
|
||||||
|
|
||||||
|
// Wait for at most 1 second.
|
||||||
|
if poller.wait(&mut Vec::new(), Some(Duration::from_secs(1)))? == 0 {
|
||||||
|
println!("timeout");
|
||||||
|
} else if let Some(err) = stream.take_error()? {
|
||||||
|
println!("error: {}", err);
|
||||||
|
} else {
|
||||||
|
println!("connected");
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Licensed under either of
|
||||||
|
|
||||||
|
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
||||||
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
|
at your option.
|
||||||
|
|
||||||
|
#### Contribution
|
||||||
|
|
||||||
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
||||||
|
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
|
||||||
|
dual licensed as above, without any additional terms or conditions.
|
|
@ -0,0 +1,338 @@
|
||||||
|
//! Non-blocking TCP or Unix connect.
|
||||||
|
//!
|
||||||
|
//! This crate allows you to create a [`TcpStream`] or a [`UnixStream`] in a non-blocking way,
|
||||||
|
//! without waiting for the connection to become fully established.
|
||||||
|
//!
|
||||||
|
//! [`TcpStream`]: https://doc.rust-lang.org/stable/std/net/struct.TcpStream.html
|
||||||
|
//! [`UnixStream`]: https://doc.rust-lang.org/stable/std/os/unix/net/struct.UnixStream.html
|
||||||
|
//!
|
||||||
|
//! # Examples
|
||||||
|
//!
|
||||||
|
//! ```
|
||||||
|
//! use polling::{Event, Poller};
|
||||||
|
//! use std::time::Duration;
|
||||||
|
//!
|
||||||
|
//! // Create a pending TCP connection.
|
||||||
|
//! let stream = nb_connect::tcp(([127, 0, 0, 1], 80))?;
|
||||||
|
//!
|
||||||
|
//! // Create a poller that waits for the stream to become writable.
|
||||||
|
//! let poller = Poller::new()?;
|
||||||
|
//! poller.insert(&stream);
|
||||||
|
//! poller.interest(&stream, Event::writable(0))?;
|
||||||
|
//!
|
||||||
|
//! // Wait for at most 1 second.
|
||||||
|
//! if poller.wait(&mut Vec::new(), Some(Duration::from_secs(1)))? == 0 {
|
||||||
|
//! println!("timeout");
|
||||||
|
//! } else if let Some(err) = stream.take_error()? {
|
||||||
|
//! println!("error: {}", err);
|
||||||
|
//! } else {
|
||||||
|
//! println!("connected");
|
||||||
|
//! }
|
||||||
|
//! # std::io::Result::Ok(())
|
||||||
|
//! ```
|
||||||
|
|
||||||
|
#![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)]
|
||||||
|
|
||||||
|
use std::io;
|
||||||
|
use std::mem::{self, MaybeUninit};
|
||||||
|
use std::net::{SocketAddr, TcpStream};
|
||||||
|
use std::ptr;
|
||||||
|
|
||||||
|
#[cfg(unix)]
|
||||||
|
use {
|
||||||
|
libc::{sockaddr, sockaddr_storage, socklen_t},
|
||||||
|
std::os::unix::net::UnixStream,
|
||||||
|
std::os::unix::prelude::{FromRawFd, RawFd},
|
||||||
|
std::path::Path,
|
||||||
|
};
|
||||||
|
|
||||||
|
#[cfg(windows)]
|
||||||
|
use {
|
||||||
|
std::os::windows::io::FromRawSocket,
|
||||||
|
winapi::shared::ws2def::{SOCKADDR as sockaddr, SOCKADDR_STORAGE as sockaddr_storage},
|
||||||
|
winapi::um::ws2tcpip::socklen_t,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// A raw socket address.
|
||||||
|
struct Addr {
|
||||||
|
storage: sockaddr_storage,
|
||||||
|
len: socklen_t,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Addr {
|
||||||
|
/// Creates a raw socket address from `SocketAddr`.
|
||||||
|
fn new(addr: SocketAddr) -> Self {
|
||||||
|
let (addr, len): (*const sockaddr, socklen_t) = match &addr {
|
||||||
|
SocketAddr::V4(addr) => (addr as *const _ as *const _, mem::size_of_val(addr) as _),
|
||||||
|
SocketAddr::V6(addr) => (addr as *const _ as *const _, mem::size_of_val(addr) as _),
|
||||||
|
};
|
||||||
|
unsafe { Self::from_raw_parts(addr, len) }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Creates an `Addr` from its raw parts.
|
||||||
|
unsafe fn from_raw_parts(addr: *const sockaddr, len: socklen_t) -> Self {
|
||||||
|
let mut storage = MaybeUninit::<sockaddr_storage>::uninit();
|
||||||
|
ptr::copy_nonoverlapping(
|
||||||
|
addr as *const _ as *const u8,
|
||||||
|
&mut storage as *mut _ as *mut u8,
|
||||||
|
len as usize,
|
||||||
|
);
|
||||||
|
Self {
|
||||||
|
storage: storage.assume_init(),
|
||||||
|
len,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(unix)]
|
||||||
|
fn connect(addr: Addr, family: libc::c_int, protocol: libc::c_int) -> io::Result<RawFd> {
|
||||||
|
/// Calls a libc function and results in `io::Result`.
|
||||||
|
macro_rules! syscall {
|
||||||
|
($fn:ident $args:tt) => {{
|
||||||
|
let res = unsafe { libc::$fn $args };
|
||||||
|
if res == -1 {
|
||||||
|
Err(std::io::Error::last_os_error())
|
||||||
|
} else {
|
||||||
|
Ok(res)
|
||||||
|
}
|
||||||
|
}};
|
||||||
|
}
|
||||||
|
|
||||||
|
// On linux, we pass the `SOCK_CLOEXEC` flag to atomically create the socket and set it as
|
||||||
|
// CLOEXEC.
|
||||||
|
#[cfg(target_os = "linux")]
|
||||||
|
let fd = syscall!(socket(
|
||||||
|
family,
|
||||||
|
libc::SOCK_STREAM | libc::SOCK_CLOEXEC,
|
||||||
|
protocol
|
||||||
|
))?;
|
||||||
|
|
||||||
|
// On other systems, we first create the socket and then set it as CLOEXEC.
|
||||||
|
#[cfg(not(target_os = "linux"))]
|
||||||
|
let fd = {
|
||||||
|
let fd = syscall!(socket(family, libc::SOCK_STREAM, protocol))?;
|
||||||
|
let flags = syscall!(fcntl(fd, libc::F_GETFD))? | libc::FD_CLOEXEC;
|
||||||
|
syscall!(fcntl(fd, libc::F_SETFD, flags))?;
|
||||||
|
|
||||||
|
#[cfg(any(target_os = "macos", target_os = "ios"))]
|
||||||
|
{
|
||||||
|
let payload = &1i32 as *const i32 as *const libc::c_void;
|
||||||
|
syscall!(setsockopt(
|
||||||
|
fd,
|
||||||
|
libc::SOL_SOCKET,
|
||||||
|
libc::SO_NOSIGPIPE,
|
||||||
|
payload,
|
||||||
|
std::mem::size_of::<i32>() as libc::socklen_t,
|
||||||
|
))?;
|
||||||
|
}
|
||||||
|
fd
|
||||||
|
};
|
||||||
|
|
||||||
|
// Put socket into non-blocking mode.
|
||||||
|
let flags = syscall!(fcntl(fd, libc::F_GETFL))? | libc::O_NONBLOCK;
|
||||||
|
syscall!(fcntl(fd, libc::F_SETFL, flags))?;
|
||||||
|
|
||||||
|
// Start connecting.
|
||||||
|
match syscall!(connect(fd, &addr.storage as *const _ as *const _, addr.len)) {
|
||||||
|
Ok(_) => {}
|
||||||
|
Err(err) if err.raw_os_error() == Some(libc::EINPROGRESS) => {}
|
||||||
|
Err(err) if err.kind() == io::ErrorKind::WouldBlock => {}
|
||||||
|
Err(err) => return Err(err),
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(fd)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Creates a pending Unix connection to the specified path.
|
||||||
|
///
|
||||||
|
/// The returned Unix stream will be in non-blocking mode and in the process of connecting to the
|
||||||
|
/// specified path.
|
||||||
|
///
|
||||||
|
/// The stream becomes writable when connected.
|
||||||
|
///
|
||||||
|
/// # Examples
|
||||||
|
///
|
||||||
|
/// ```no_run
|
||||||
|
/// use polling::{Event, Poller};
|
||||||
|
/// use std::time::Duration;
|
||||||
|
///
|
||||||
|
/// // Create a pending Unix connection.
|
||||||
|
/// let stream = nb_connect::unix("/tmp/socket")?;
|
||||||
|
///
|
||||||
|
/// // Create a poller that waits for the stream to become writable.
|
||||||
|
/// let poller = Poller::new()?;
|
||||||
|
/// poller.insert(&stream);
|
||||||
|
/// poller.interest(&stream, Event::writable(0))?;
|
||||||
|
///
|
||||||
|
/// // Wait for at most 1 second.
|
||||||
|
/// if poller.wait(&mut Vec::new(), Some(Duration::from_secs(1)))? == 0 {
|
||||||
|
/// println!("timeout");
|
||||||
|
/// } else {
|
||||||
|
/// println!("connected");
|
||||||
|
/// }
|
||||||
|
/// # std::io::Result::Ok(())
|
||||||
|
/// ```
|
||||||
|
#[cfg(unix)]
|
||||||
|
pub fn unix<P: AsRef<Path>>(path: P) -> io::Result<UnixStream> {
|
||||||
|
use std::cmp::Ordering;
|
||||||
|
use std::os::unix::ffi::OsStrExt;
|
||||||
|
|
||||||
|
let addr = unsafe {
|
||||||
|
let mut addr = mem::zeroed::<libc::sockaddr_un>();
|
||||||
|
addr.sun_family = libc::AF_UNIX as libc::sa_family_t;
|
||||||
|
|
||||||
|
let bytes = path.as_ref().as_os_str().as_bytes();
|
||||||
|
|
||||||
|
match (bytes.get(0), bytes.len().cmp(&addr.sun_path.len())) {
|
||||||
|
// Abstract paths don't need a null terminator
|
||||||
|
(Some(&0), Ordering::Greater) => {
|
||||||
|
return Err(io::Error::new(
|
||||||
|
io::ErrorKind::InvalidInput,
|
||||||
|
"path must be no longer than SUN_LEN",
|
||||||
|
));
|
||||||
|
}
|
||||||
|
(Some(&0), _) => {}
|
||||||
|
(_, Ordering::Greater) | (_, Ordering::Equal) => {
|
||||||
|
return Err(io::Error::new(
|
||||||
|
io::ErrorKind::InvalidInput,
|
||||||
|
"path must be shorter than SUN_LEN",
|
||||||
|
));
|
||||||
|
}
|
||||||
|
_ => {}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (dst, src) in addr.sun_path.iter_mut().zip(bytes) {
|
||||||
|
*dst = *src as libc::c_char;
|
||||||
|
}
|
||||||
|
// null byte for pathname is already there since we zeroed up front
|
||||||
|
|
||||||
|
let base = &addr as *const _ as usize;
|
||||||
|
let path = &addr.sun_path as *const _ as usize;
|
||||||
|
let sun_path_offset = path - base;
|
||||||
|
|
||||||
|
let mut len = sun_path_offset + bytes.len();
|
||||||
|
match bytes.get(0) {
|
||||||
|
Some(&0) | None => {}
|
||||||
|
Some(_) => len += 1,
|
||||||
|
}
|
||||||
|
Addr::from_raw_parts(&addr as *const _ as *const _, len as libc::socklen_t)
|
||||||
|
};
|
||||||
|
|
||||||
|
let fd = connect(addr, libc::AF_UNIX, 0)?;
|
||||||
|
unsafe { Ok(UnixStream::from_raw_fd(fd)) }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Creates a pending TCP connection to the specified address.
|
||||||
|
///
|
||||||
|
/// The returned TCP stream will be in non-blocking mode and in the process of connecting to the
|
||||||
|
/// specified address.
|
||||||
|
///
|
||||||
|
/// The stream becomes writable when connected.
|
||||||
|
///
|
||||||
|
/// # Examples
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// use polling::{Event, Poller};
|
||||||
|
/// use std::time::Duration;
|
||||||
|
///
|
||||||
|
/// // Create a pending TCP connection.
|
||||||
|
/// let stream = nb_connect::tcp(([127, 0, 0, 1], 80))?;
|
||||||
|
///
|
||||||
|
/// // Create a poller that waits for the stream to become writable.
|
||||||
|
/// let poller = Poller::new()?;
|
||||||
|
/// poller.insert(&stream);
|
||||||
|
/// poller.interest(&stream, Event::writable(0))?;
|
||||||
|
///
|
||||||
|
/// // Wait for at most 1 second.
|
||||||
|
/// if poller.wait(&mut Vec::new(), Some(Duration::from_secs(1)))? == 0 {
|
||||||
|
/// println!("timeout");
|
||||||
|
/// } else if let Some(err) = stream.take_error()? {
|
||||||
|
/// println!("error: {}", err);
|
||||||
|
/// } else {
|
||||||
|
/// println!("connected");
|
||||||
|
/// }
|
||||||
|
/// # std::io::Result::Ok(())
|
||||||
|
/// ```
|
||||||
|
pub fn tcp<A: Into<SocketAddr>>(addr: A) -> io::Result<TcpStream> {
|
||||||
|
tcp_connect(addr.into())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(unix)]
|
||||||
|
fn tcp_connect(addr: SocketAddr) -> io::Result<TcpStream> {
|
||||||
|
let addr = addr.into();
|
||||||
|
let fd = connect(
|
||||||
|
Addr::new(addr),
|
||||||
|
if addr.is_ipv6() {
|
||||||
|
libc::AF_INET6
|
||||||
|
} else {
|
||||||
|
libc::AF_INET
|
||||||
|
},
|
||||||
|
libc::IPPROTO_TCP,
|
||||||
|
)?;
|
||||||
|
unsafe { Ok(TcpStream::from_raw_fd(fd)) }
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(windows)]
|
||||||
|
fn tcp_connect(addr: SocketAddr) -> io::Result<TcpStream> {
|
||||||
|
use std::net::UdpSocket;
|
||||||
|
use std::sync::Once;
|
||||||
|
|
||||||
|
use winapi::ctypes::{c_int, c_ulong};
|
||||||
|
use winapi::shared::minwindef::DWORD;
|
||||||
|
use winapi::shared::ntdef::HANDLE;
|
||||||
|
use winapi::shared::ws2def::{AF_INET, AF_INET6, IPPROTO_TCP, SOCK_STREAM};
|
||||||
|
use winapi::um::handleapi::SetHandleInformation;
|
||||||
|
use winapi::um::winsock2 as sock;
|
||||||
|
|
||||||
|
static INIT: Once = Once::new();
|
||||||
|
INIT.call_once(|| {
|
||||||
|
// Initialize winsock through the standard library by just creating a dummy socket.
|
||||||
|
// Whether this is successful or not we drop the result as libstd will be sure to have
|
||||||
|
// initialized winsock.
|
||||||
|
let _ = UdpSocket::bind("127.0.0.1:34254");
|
||||||
|
});
|
||||||
|
|
||||||
|
const HANDLE_FLAG_INHERIT: DWORD = 0x00000001;
|
||||||
|
const WSA_FLAG_OVERLAPPED: DWORD = 0x01;
|
||||||
|
|
||||||
|
let family = if addr.is_ipv6() { AF_INET6 } else { AF_INET };
|
||||||
|
let addr = Addr::new(addr);
|
||||||
|
|
||||||
|
unsafe {
|
||||||
|
let socket = match sock::WSASocketW(
|
||||||
|
family,
|
||||||
|
SOCK_STREAM,
|
||||||
|
IPPROTO_TCP as _,
|
||||||
|
ptr::null_mut(),
|
||||||
|
0,
|
||||||
|
WSA_FLAG_OVERLAPPED,
|
||||||
|
) {
|
||||||
|
sock::INVALID_SOCKET => {
|
||||||
|
return Err(io::Error::from_raw_os_error(sock::WSAGetLastError()))
|
||||||
|
}
|
||||||
|
socket => socket,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Set no inherit.
|
||||||
|
if SetHandleInformation(socket as HANDLE, HANDLE_FLAG_INHERIT, 0) == 0 {
|
||||||
|
return Err(io::Error::last_os_error());
|
||||||
|
}
|
||||||
|
|
||||||
|
// Put socket into nonblocking mode.
|
||||||
|
let mut nonblocking = true as c_ulong;
|
||||||
|
if sock::ioctlsocket(socket, sock::FIONBIO as c_int, &mut nonblocking) != 0 {
|
||||||
|
return Err(io::Error::last_os_error());
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start connecting.
|
||||||
|
match sock::connect(socket, &addr.storage as *const _ as *const _, addr.len) {
|
||||||
|
0 => {}
|
||||||
|
_ => match io::Error::from_raw_os_error(sock::WSAGetLastError()) {
|
||||||
|
err if err.kind() == io::ErrorKind::WouldBlock => {}
|
||||||
|
err => return Err(err),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(TcpStream::from_raw_socket(socket as _))
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue