mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-26 00:00:16 +02:00
Split net::tcp code into files: (#177)
- Incoming -> src/net/tcp/incoming.rs - TcpListener -> src/net/tcp/listener.rs - TcpStream, ConnectFuture -> src/net/tcp/stream.rs
This commit is contained in:
@@ -0,0 +1,30 @@
|
||||
use net::tcp::TcpListener;
|
||||
use net::tcp::TcpStream;
|
||||
|
||||
use std::io;
|
||||
use futures::stream::Stream;
|
||||
use futures::{Poll, Async};
|
||||
|
||||
/// Stream returned by the `TcpListener::incoming` function representing the
|
||||
/// stream of sockets received from a listener.
|
||||
#[must_use = "streams do nothing unless polled"]
|
||||
#[derive(Debug)]
|
||||
pub struct Incoming {
|
||||
inner: TcpListener,
|
||||
}
|
||||
|
||||
impl Incoming {
|
||||
pub(crate) fn new(listener: TcpListener) -> Incoming {
|
||||
Incoming { inner: listener }
|
||||
}
|
||||
}
|
||||
|
||||
impl Stream for Incoming {
|
||||
type Item = TcpStream;
|
||||
type Error = io::Error;
|
||||
|
||||
fn poll(&mut self) -> Poll<Option<Self::Item>, io::Error> {
|
||||
let (socket, _) = try_ready!(self.inner.poll_accept());
|
||||
Ok(Async::Ready(Some(socket)))
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,213 @@
|
||||
use net::tcp::Incoming;
|
||||
use net::tcp::TcpStream;
|
||||
|
||||
use std::fmt;
|
||||
use std::io;
|
||||
use std::net::{self, SocketAddr};
|
||||
|
||||
use futures::{Poll, Async};
|
||||
use mio;
|
||||
|
||||
use reactor::{Handle, PollEvented2};
|
||||
|
||||
/// An I/O object representing a TCP socket listening for incoming connections.
|
||||
///
|
||||
/// This object can be converted into a stream of incoming connections for
|
||||
/// various forms of processing.
|
||||
pub struct TcpListener {
|
||||
io: PollEvented2<mio::net::TcpListener>,
|
||||
}
|
||||
|
||||
impl TcpListener {
|
||||
/// Create a new TCP listener associated with this event loop.
|
||||
///
|
||||
/// The TCP listener will bind to the provided `addr` address, if available.
|
||||
/// If the result is `Ok`, the socket has successfully bound.
|
||||
pub fn bind(addr: &SocketAddr) -> io::Result<TcpListener> {
|
||||
let l = mio::net::TcpListener::bind(addr)?;
|
||||
Ok(TcpListener::new(l))
|
||||
}
|
||||
|
||||
#[deprecated(since = "0.1.2", note = "use poll_accept instead")]
|
||||
#[doc(hidden)]
|
||||
pub fn accept(&mut self) -> io::Result<(TcpStream, SocketAddr)> {
|
||||
match self.poll_accept()? {
|
||||
Async::Ready(ret) => Ok(ret),
|
||||
Async::NotReady => Err(io::ErrorKind::WouldBlock.into()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Attempt to accept a connection and create a new connected `TcpStream` if
|
||||
/// successful.
|
||||
///
|
||||
/// Note that typically for simple usage it's easier to treat incoming
|
||||
/// connections as a `Stream` of `TcpStream`s with the `incoming` method
|
||||
/// below.
|
||||
///
|
||||
/// # Return
|
||||
///
|
||||
/// On success, returns `Ok(Async::Ready((socket, addr)))`.
|
||||
///
|
||||
/// If the listener is not ready to accept, the method returns
|
||||
/// `Ok(Async::NotReady)` and arranges for the current task to receive a
|
||||
/// notification when the listener becomes ready to accept.
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// This function will panic if called from outside of a task context.
|
||||
pub fn poll_accept(&mut self) -> Poll<(TcpStream, SocketAddr), io::Error> {
|
||||
let (io, addr) = try_ready!(self.poll_accept_std());
|
||||
|
||||
let io = mio::net::TcpStream::from_stream(io)?;
|
||||
let io = TcpStream::new(io);
|
||||
|
||||
Ok((io, addr).into())
|
||||
}
|
||||
|
||||
#[deprecated(since = "0.1.2", note = "use poll_accept_std instead")]
|
||||
#[doc(hidden)]
|
||||
pub fn accept_std(&mut self) -> io::Result<(net::TcpStream, SocketAddr)> {
|
||||
match self.poll_accept_std()? {
|
||||
Async::Ready(ret) => Ok(ret),
|
||||
Async::NotReady => Err(io::ErrorKind::WouldBlock.into()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Attempt to accept a connection and create a new connected `TcpStream` if
|
||||
/// successful.
|
||||
///
|
||||
/// This function is the asme as `accept` above except that it returns a
|
||||
/// `std::net::TcpStream` instead of a `tokio::net::TcpStream`. This in turn
|
||||
/// can then allow for the TCP stream to be assoiated with a different
|
||||
/// reactor than the one this `TcpListener` is associated with.
|
||||
///
|
||||
/// # Return
|
||||
///
|
||||
/// On success, returns `Ok(Async::Ready((socket, addr)))`.
|
||||
///
|
||||
/// If the listener is not ready to accept, the method returns
|
||||
/// `Ok(Async::NotReady)` and arranges for the current task to receive a
|
||||
/// notification when the listener becomes ready to accept.
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// This function will panic if called from outside of a task context.
|
||||
pub fn poll_accept_std(&mut self) -> Poll<(net::TcpStream, SocketAddr), io::Error> {
|
||||
try_ready!(self.io.poll_read_ready());
|
||||
|
||||
match self.io.get_ref().accept_std() {
|
||||
Ok(pair) => Ok(pair.into()),
|
||||
Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {
|
||||
self.io.need_read()?;
|
||||
Ok(Async::NotReady)
|
||||
}
|
||||
Err(e) => Err(e),
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a new TCP listener from the standard library's TCP listener.
|
||||
///
|
||||
/// This method can be used when the `Handle::tcp_listen` method isn't
|
||||
/// sufficient because perhaps some more configuration is needed in terms of
|
||||
/// before the calls to `bind` and `listen`.
|
||||
///
|
||||
/// This API is typically paired with the `net2` crate and the `TcpBuilder`
|
||||
/// type to build up and customize a listener before it's shipped off to the
|
||||
/// backing event loop. This allows configuration of options like
|
||||
/// `SO_REUSEPORT`, binding to multiple addresses, etc.
|
||||
///
|
||||
/// The `addr` argument here is one of the addresses that `listener` is
|
||||
/// bound to and the listener will only be guaranteed to accept connections
|
||||
/// of the same address type currently.
|
||||
///
|
||||
/// Finally, the `handle` argument is the event loop that this listener will
|
||||
/// be bound to.
|
||||
///
|
||||
/// The platform specific behavior of this function looks like:
|
||||
///
|
||||
/// * On Unix, the socket is placed into nonblocking mode and connections
|
||||
/// can be accepted as normal
|
||||
///
|
||||
/// * On Windows, the address is stored internally and all future accepts
|
||||
/// will only be for the same IP version as `addr` specified. That is, if
|
||||
/// `addr` is an IPv4 address then all sockets accepted will be IPv4 as
|
||||
/// well (same for IPv6).
|
||||
pub fn from_std(listener: net::TcpListener, handle: &Handle)
|
||||
-> io::Result<TcpListener>
|
||||
{
|
||||
let io = mio::net::TcpListener::from_std(listener)?;
|
||||
let io = PollEvented2::new_with_handle(io, handle)?;
|
||||
Ok(TcpListener { io })
|
||||
}
|
||||
|
||||
fn new(listener: mio::net::TcpListener) -> TcpListener {
|
||||
let io = PollEvented2::new(listener);
|
||||
TcpListener { io }
|
||||
}
|
||||
|
||||
/// Returns the local address that this listener is bound to.
|
||||
///
|
||||
/// This can be useful, for example, when binding to port 0 to figure out
|
||||
/// which port was actually bound.
|
||||
pub fn local_addr(&self) -> io::Result<SocketAddr> {
|
||||
self.io.get_ref().local_addr()
|
||||
}
|
||||
|
||||
/// Consumes this listener, returning a stream of the sockets this listener
|
||||
/// accepts.
|
||||
///
|
||||
/// This method returns an implementation of the `Stream` trait which
|
||||
/// resolves to the sockets the are accepted on this listener.
|
||||
pub fn incoming(self) -> Incoming {
|
||||
Incoming::new(self)
|
||||
}
|
||||
|
||||
/// Gets the value of the `IP_TTL` option for this socket.
|
||||
///
|
||||
/// For more information about this option, see [`set_ttl`].
|
||||
///
|
||||
/// [`set_ttl`]: #method.set_ttl
|
||||
pub fn ttl(&self) -> io::Result<u32> {
|
||||
self.io.get_ref().ttl()
|
||||
}
|
||||
|
||||
/// Sets the value for the `IP_TTL` option on this socket.
|
||||
///
|
||||
/// This value sets the time-to-live field that is used in every packet sent
|
||||
/// from this socket.
|
||||
pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
|
||||
self.io.get_ref().set_ttl(ttl)
|
||||
}
|
||||
}
|
||||
|
||||
impl fmt::Debug for TcpListener {
|
||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
self.io.get_ref().fmt(f)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(all(unix, not(target_os = "fuchsia")))]
|
||||
mod sys {
|
||||
use std::os::unix::prelude::*;
|
||||
use super::TcpListener;
|
||||
|
||||
impl AsRawFd for TcpListener {
|
||||
fn as_raw_fd(&self) -> RawFd {
|
||||
self.io.get_ref().as_raw_fd()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(windows)]
|
||||
mod sys {
|
||||
// TODO: let's land these upstream with mio and then we can add them here.
|
||||
//
|
||||
// use std::os::windows::prelude::*;
|
||||
// use super::{TcpListener;
|
||||
//
|
||||
// impl AsRawHandle for TcpListener {
|
||||
// fn as_raw_handle(&self) -> RawHandle {
|
||||
// self.listener.io().as_raw_handle()
|
||||
// }
|
||||
// }
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
mod incoming;
|
||||
mod listener;
|
||||
mod stream;
|
||||
|
||||
pub use self::incoming::Incoming;
|
||||
pub use self::listener::TcpListener;
|
||||
pub use self::stream::TcpStream;
|
||||
pub use self::stream::ConnectFuture;
|
||||
@@ -5,7 +5,6 @@ use std::net::{self, SocketAddr, Shutdown};
|
||||
use std::time::Duration;
|
||||
|
||||
use bytes::{Buf, BufMut};
|
||||
use futures::stream::Stream;
|
||||
use futures::{Future, Poll, Async};
|
||||
use iovec::IoVec;
|
||||
use mio;
|
||||
@@ -13,201 +12,6 @@ use tokio_io::{AsyncRead, AsyncWrite};
|
||||
|
||||
use reactor::{Handle, PollEvented2};
|
||||
|
||||
/// An I/O object representing a TCP socket listening for incoming connections.
|
||||
///
|
||||
/// This object can be converted into a stream of incoming connections for
|
||||
/// various forms of processing.
|
||||
pub struct TcpListener {
|
||||
io: PollEvented2<mio::net::TcpListener>,
|
||||
}
|
||||
|
||||
/// Stream returned by the `TcpListener::incoming` function representing the
|
||||
/// stream of sockets received from a listener.
|
||||
#[must_use = "streams do nothing unless polled"]
|
||||
#[derive(Debug)]
|
||||
pub struct Incoming {
|
||||
inner: TcpListener,
|
||||
}
|
||||
|
||||
impl TcpListener {
|
||||
/// Create a new TCP listener associated with this event loop.
|
||||
///
|
||||
/// The TCP listener will bind to the provided `addr` address, if available.
|
||||
/// If the result is `Ok`, the socket has successfully bound.
|
||||
pub fn bind(addr: &SocketAddr) -> io::Result<TcpListener> {
|
||||
let l = mio::net::TcpListener::bind(addr)?;
|
||||
Ok(TcpListener::new(l))
|
||||
}
|
||||
|
||||
#[deprecated(since = "0.1.2", note = "use poll_accept instead")]
|
||||
#[doc(hidden)]
|
||||
pub fn accept(&mut self) -> io::Result<(TcpStream, SocketAddr)> {
|
||||
match self.poll_accept()? {
|
||||
Async::Ready(ret) => Ok(ret),
|
||||
Async::NotReady => Err(io::ErrorKind::WouldBlock.into()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Attempt to accept a connection and create a new connected `TcpStream` if
|
||||
/// successful.
|
||||
///
|
||||
/// Note that typically for simple usage it's easier to treat incoming
|
||||
/// connections as a `Stream` of `TcpStream`s with the `incoming` method
|
||||
/// below.
|
||||
///
|
||||
/// # Return
|
||||
///
|
||||
/// On success, returns `Ok(Async::Ready((socket, addr)))`.
|
||||
///
|
||||
/// If the listener is not ready to accept, the method returns
|
||||
/// `Ok(Async::NotReady)` and arranges for the current task to receive a
|
||||
/// notification when the listener becomes ready to accept.
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// This function will panic if called from outside of a task context.
|
||||
pub fn poll_accept(&mut self) -> Poll<(TcpStream, SocketAddr), io::Error> {
|
||||
let (io, addr) = try_ready!(self.poll_accept_std());
|
||||
|
||||
let io = mio::net::TcpStream::from_stream(io)?;
|
||||
let io = PollEvented2::new(io);
|
||||
let io = TcpStream { io };
|
||||
|
||||
Ok((io, addr).into())
|
||||
}
|
||||
|
||||
#[deprecated(since = "0.1.2", note = "use poll_accept_std instead")]
|
||||
#[doc(hidden)]
|
||||
pub fn accept_std(&mut self) -> io::Result<(net::TcpStream, SocketAddr)> {
|
||||
match self.poll_accept_std()? {
|
||||
Async::Ready(ret) => Ok(ret),
|
||||
Async::NotReady => Err(io::ErrorKind::WouldBlock.into()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Attempt to accept a connection and create a new connected `TcpStream` if
|
||||
/// successful.
|
||||
///
|
||||
/// This function is the asme as `accept` above except that it returns a
|
||||
/// `std::net::TcpStream` instead of a `tokio::net::TcpStream`. This in turn
|
||||
/// can then allow for the TCP stream to be assoiated with a different
|
||||
/// reactor than the one this `TcpListener` is associated with.
|
||||
///
|
||||
/// # Return
|
||||
///
|
||||
/// On success, returns `Ok(Async::Ready((socket, addr)))`.
|
||||
///
|
||||
/// If the listener is not ready to accept, the method returns
|
||||
/// `Ok(Async::NotReady)` and arranges for the current task to receive a
|
||||
/// notification when the listener becomes ready to accept.
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// This function will panic if called from outside of a task context.
|
||||
pub fn poll_accept_std(&mut self) -> Poll<(net::TcpStream, SocketAddr), io::Error> {
|
||||
try_ready!(self.io.poll_read_ready());
|
||||
|
||||
match self.io.get_ref().accept_std() {
|
||||
Ok(pair) => Ok(pair.into()),
|
||||
Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {
|
||||
self.io.need_read()?;
|
||||
Ok(Async::NotReady)
|
||||
}
|
||||
Err(e) => Err(e),
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a new TCP listener from the standard library's TCP listener.
|
||||
///
|
||||
/// This method can be used when the `Handle::tcp_listen` method isn't
|
||||
/// sufficient because perhaps some more configuration is needed in terms of
|
||||
/// before the calls to `bind` and `listen`.
|
||||
///
|
||||
/// This API is typically paired with the `net2` crate and the `TcpBuilder`
|
||||
/// type to build up and customize a listener before it's shipped off to the
|
||||
/// backing event loop. This allows configuration of options like
|
||||
/// `SO_REUSEPORT`, binding to multiple addresses, etc.
|
||||
///
|
||||
/// The `addr` argument here is one of the addresses that `listener` is
|
||||
/// bound to and the listener will only be guaranteed to accept connections
|
||||
/// of the same address type currently.
|
||||
///
|
||||
/// Finally, the `handle` argument is the event loop that this listener will
|
||||
/// be bound to.
|
||||
///
|
||||
/// The platform specific behavior of this function looks like:
|
||||
///
|
||||
/// * On Unix, the socket is placed into nonblocking mode and connections
|
||||
/// can be accepted as normal
|
||||
///
|
||||
/// * On Windows, the address is stored internally and all future accepts
|
||||
/// will only be for the same IP version as `addr` specified. That is, if
|
||||
/// `addr` is an IPv4 address then all sockets accepted will be IPv4 as
|
||||
/// well (same for IPv6).
|
||||
pub fn from_std(listener: net::TcpListener, handle: &Handle)
|
||||
-> io::Result<TcpListener>
|
||||
{
|
||||
let io = mio::net::TcpListener::from_std(listener)?;
|
||||
let io = PollEvented2::new_with_handle(io, handle)?;
|
||||
Ok(TcpListener { io })
|
||||
}
|
||||
|
||||
fn new(listener: mio::net::TcpListener) -> TcpListener {
|
||||
let io = PollEvented2::new(listener);
|
||||
TcpListener { io }
|
||||
}
|
||||
|
||||
/// Returns the local address that this listener is bound to.
|
||||
///
|
||||
/// This can be useful, for example, when binding to port 0 to figure out
|
||||
/// which port was actually bound.
|
||||
pub fn local_addr(&self) -> io::Result<SocketAddr> {
|
||||
self.io.get_ref().local_addr()
|
||||
}
|
||||
|
||||
/// Consumes this listener, returning a stream of the sockets this listener
|
||||
/// accepts.
|
||||
///
|
||||
/// This method returns an implementation of the `Stream` trait which
|
||||
/// resolves to the sockets the are accepted on this listener.
|
||||
pub fn incoming(self) -> Incoming {
|
||||
Incoming { inner: self }
|
||||
}
|
||||
|
||||
/// Gets the value of the `IP_TTL` option for this socket.
|
||||
///
|
||||
/// For more information about this option, see [`set_ttl`].
|
||||
///
|
||||
/// [`set_ttl`]: #method.set_ttl
|
||||
pub fn ttl(&self) -> io::Result<u32> {
|
||||
self.io.get_ref().ttl()
|
||||
}
|
||||
|
||||
/// Sets the value for the `IP_TTL` option on this socket.
|
||||
///
|
||||
/// This value sets the time-to-live field that is used in every packet sent
|
||||
/// from this socket.
|
||||
pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
|
||||
self.io.get_ref().set_ttl(ttl)
|
||||
}
|
||||
}
|
||||
|
||||
impl fmt::Debug for TcpListener {
|
||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
self.io.get_ref().fmt(f)
|
||||
}
|
||||
}
|
||||
|
||||
impl Stream for Incoming {
|
||||
type Item = TcpStream;
|
||||
type Error = io::Error;
|
||||
|
||||
fn poll(&mut self) -> Poll<Option<Self::Item>, io::Error> {
|
||||
let (socket, _) = try_ready!(self.inner.poll_accept());
|
||||
Ok(Async::Ready(Some(socket)))
|
||||
}
|
||||
}
|
||||
|
||||
/// An I/O object representing a TCP stream connected to a remote endpoint.
|
||||
///
|
||||
/// A TCP stream can either be created by connecting to an endpoint, via the
|
||||
@@ -254,7 +58,7 @@ impl TcpStream {
|
||||
ConnectFuture { inner }
|
||||
}
|
||||
|
||||
fn new(connected: mio::net::TcpStream) -> TcpStream {
|
||||
pub(crate) fn new(connected: mio::net::TcpStream) -> TcpStream {
|
||||
let io = PollEvented2::new(connected);
|
||||
TcpStream { io }
|
||||
}
|
||||
@@ -641,6 +445,7 @@ impl fmt::Debug for TcpStream {
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
impl Future for ConnectFuture {
|
||||
type Item = TcpStream;
|
||||
type Error = io::Error;
|
||||
@@ -692,19 +497,13 @@ impl Future for ConnectFutureState {
|
||||
#[cfg(all(unix, not(target_os = "fuchsia")))]
|
||||
mod sys {
|
||||
use std::os::unix::prelude::*;
|
||||
use super::{TcpStream, TcpListener};
|
||||
use super::TcpStream;
|
||||
|
||||
impl AsRawFd for TcpStream {
|
||||
fn as_raw_fd(&self) -> RawFd {
|
||||
self.io.get_ref().as_raw_fd()
|
||||
}
|
||||
}
|
||||
|
||||
impl AsRawFd for TcpListener {
|
||||
fn as_raw_fd(&self) -> RawFd {
|
||||
self.io.get_ref().as_raw_fd()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(windows)]
|
||||
@@ -712,17 +511,11 @@ mod sys {
|
||||
// TODO: let's land these upstream with mio and then we can add them here.
|
||||
//
|
||||
// use std::os::windows::prelude::*;
|
||||
// use super::{TcpStream, TcpListener};
|
||||
// use super::TcpStream;
|
||||
//
|
||||
// impl AsRawHandle for TcpStream {
|
||||
// fn as_raw_handle(&self) -> RawHandle {
|
||||
// self.io.get_ref().as_raw_handle()
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// impl AsRawHandle for TcpListener {
|
||||
// fn as_raw_handle(&self) -> RawHandle {
|
||||
// self.listener.io().as_raw_handle()
|
||||
// }
|
||||
// }
|
||||
}
|
||||
Reference in New Issue
Block a user