Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial work on listener configuration #823

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/listener/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ pub use to_listener::ToListener;
#[cfg(feature = "h1-server")]
pub(crate) use parsed_listener::ParsedListener;
#[cfg(feature = "h1-server")]
pub(crate) use tcp_listener::TcpListener;
pub use tcp_listener::TcpListener;
#[cfg(all(unix, feature = "h1-server"))]
pub(crate) use unix_listener::UnixListener;
pub use unix_listener::UnixListener;

/// The Listener trait represents an implementation of http transport for a tide
/// application. In order to provide a Listener to tide, you will also need to
Expand Down
97 changes: 88 additions & 9 deletions src/listener/tcp_listener.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,96 @@ use crate::listener::Listener;
use crate::{log, Server};

use std::fmt::{self, Display, Formatter};
use std::str::FromStr;

use std::net::ToSocketAddrs;

use async_std::net::{self, SocketAddr, TcpStream};
use async_std::prelude::*;
use async_std::{io, task};
use http_types::Url;

/// This represents a tide [Listener](crate::listener::Listener) that
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this block of documentation is many commits out of date and needs to be updated before merge

/// wraps an [async_std::net::TcpListener]. It is implemented as an
/// enum in order to allow creation of a tide::listener::TcpListener
/// from a SocketAddr spec that has not yet been bound OR from a bound
/// TcpListener.
///
/// This is currently crate-visible only, and tide users are expected
/// to create these through [ToListener](crate::ToListener) conversions.
/// ```rust,no_run
/// # async_std::task::block_on(async {
/// tide::new().listen(
/// TcpListener::new("localhost:8080")
/// .with_nodelay(true)
/// .with_ttl(100)
/// ).await
/// # });
/// ```
pub struct TcpListener<State> {
addrs: Option<Vec<SocketAddr>>,
listener: Option<net::TcpListener>,
server: Option<Server<State>>,
info: Option<ListenInfo>,
tcp_nodelay: Option<bool>,
tcp_ttl: Option<u32>,
}

impl<State> TcpListener<State> {
pub fn from_addrs(addrs: Vec<SocketAddr>) -> Self {
Self {
addrs: Some(addrs),
impl<S> Default for TcpListener<S> {
fn default() -> Self {
TcpListener {
addrs: None,
listener: None,
server: None,
info: None,
tcp_nodelay: None,
tcp_ttl: None,
}
}
}

impl<State> TcpListener<State> {
pub fn new(s: &str) -> crate::Result<Self> {
Self::from_str(s)
}

pub fn from_addrs(addrs: impl std::net::ToSocketAddrs) -> crate::Result<Self> {
Ok(Self {
addrs: Some(addrs.to_socket_addrs()?.collect()),
..Default::default()
})
}

pub fn from_listener(tcp_listener: impl Into<net::TcpListener>) -> Self {
Self {
addrs: None,
listener: Some(tcp_listener.into()),
server: None,
info: None,
..Default::default()
}
}

pub fn set_nodelay(&mut self, nodelay: bool) {
self.tcp_nodelay = Some(nodelay);
}

pub fn nodelay(&self) -> Option<bool> {
self.tcp_nodelay
}

pub fn with_nodelay(mut self, nodelay: bool) -> Self {
self.set_nodelay(nodelay);
self
}

pub fn set_ttl(&mut self, ttl: u32) {
self.tcp_ttl = Some(ttl);
}

pub fn ttl(&self) -> Option<u32> {
self.tcp_ttl
}

pub fn with_ttl(mut self, ttl: u32) -> Self {
self.set_ttl(ttl);
self
}
}

fn handle_tcp<State: Clone + Send + Sync + 'static>(app: Server<State>, stream: TcpStream) {
Expand All @@ -61,6 +113,25 @@ fn handle_tcp<State: Clone + Send + Sync + 'static>(app: Server<State>, stream:
});
}

impl<State> FromStr for TcpListener<State> {
type Err = crate::Error;

fn from_str(s: &str) -> Result<Self, Self::Err> {
if let Ok(addrs) = s.to_socket_addrs() {
Self::from_addrs(addrs.collect::<Vec<_>>().as_slice())
} else {
let url = Url::parse(s)?;
if url.scheme() == "http" {
Self::from_addrs(url.socket_addrs(|| None)?.as_slice())
} else {
Err(crate::http::format_err!(
"tcp listener must be used with a http scheme"
))
}
}
}
}

#[async_trait::async_trait]
impl<State> Listener<State> for TcpListener<State>
where
Expand Down Expand Up @@ -111,6 +182,14 @@ where
}

Ok(stream) => {
if let Some(nodelay) = self.tcp_nodelay {
stream.set_nodelay(nodelay)?;
}

if let Some(ttl) = self.tcp_ttl {
stream.set_ttl(ttl)?;
}

handle_tcp(server.clone(), stream);
}
};
Expand Down
20 changes: 12 additions & 8 deletions src/listener/to_listener_impls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@ where
}
}

"tcp" | "http" => Ok(ParsedListener::Tcp(TcpListener::from_addrs(
self.socket_addrs(|| Some(80))?,
))),
"tcp" | "http" => Ok(ParsedListener::Tcp(
TcpListener::from_addrs(self.socket_addrs(|| None)?.as_slice())
.map_err(|e| io::Error::new(io::ErrorKind::Other, e.to_string()))?,
)),

"tls" | "ssl" | "https" => Err(io::Error::new(
io::ErrorKind::Other,
Expand Down Expand Up @@ -79,9 +80,10 @@ where

fn to_listener(self) -> io::Result<Self::Listener> {
if let Ok(socket_addrs) = self.to_socket_addrs() {
Ok(ParsedListener::Tcp(TcpListener::from_addrs(
socket_addrs.collect(),
)))
Ok(ParsedListener::Tcp(
TcpListener::from_addrs(socket_addrs.collect::<Vec<_>>().as_slice())
.map_err(|e| io::Error::new(io::ErrorKind::Other, e.to_string()))?,
))
} else if let Ok(url) = Url::parse(self) {
ToListener::<State>::to_listener(url)
} else {
Expand Down Expand Up @@ -162,7 +164,8 @@ where
type Listener = TcpListener<State>;

fn to_listener(self) -> io::Result<Self::Listener> {
Ok(TcpListener::from_addrs(self.to_socket_addrs()?.collect()))
TcpListener::from_addrs(self)
.map_err(|e| io::Error::new(io::ErrorKind::Other, e.to_string()))
}
}

Expand Down Expand Up @@ -245,7 +248,8 @@ where
{
type Listener = TcpListener<State>;
fn to_listener(self) -> io::Result<Self::Listener> {
Ok(TcpListener::from_addrs(vec![self]))
TcpListener::from_addrs(self)
.map_err(|e| io::Error::new(io::ErrorKind::Other, e.to_string()))
}
}

Expand Down