feat: split WebSocket #48
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bartlomieju
approved these changes
Oct 30, 2023
|
@mmastrac Code looks good but this example server is not working: use fastwebsockets::upgrade;
use fastwebsockets::OpCode;
use fastwebsockets::WebSocketError;
use hyper::server::conn::Http;
use hyper::service::service_fn;
use hyper::Body;
use hyper::Request;
use hyper::Response;
use tokio::net::TcpListener;
async fn handle_client(fut: upgrade::UpgradeFut) -> Result<(), WebSocketError> {
let ws = fut.await?;
let (mut rx, mut tx) = ws.split(|ws| tokio::io::split(ws));
loop {
// Empty send_fn is fine because the benchmark does not create obligated writes.
let frame = rx.read_frame(&mut move |_| async { Ok::<_, WebSocketError>(()) }).await?;
match frame.opcode {
OpCode::Close => break,
OpCode::Text | OpCode::Binary => {
tx.write_frame(frame).await?;
}
_ => {}
}
}
Ok(())
}
async fn server_upgrade(
mut req: Request<Body>,
) -> Result<Response<Body>, WebSocketError> {
let (response, fut) = upgrade::upgrade(&mut req)?;
tokio::task::spawn(async move {
if let Err(e) = tokio::task::unconstrained(handle_client(fut)).await {
eprintln!("Error in websocket connection: {}", e);
}
});
Ok(response)
}
fn main() -> Result<(), WebSocketError> {
let rt = tokio::runtime::Builder::new_current_thread()
.enable_io()
.build()
.unwrap();
rt.block_on(async move {
let listener = TcpListener::bind("127.0.0.1:8080").await?;
println!("Server started, listening on {}", "127.0.0.1:8080");
loop {
let (stream, _) = listener.accept().await?;
println!("Client connected");
tokio::spawn(async move {
let conn_fut = Http::new()
.serve_connection(stream, service_fn(server_upgrade))
.with_upgrades();
if let Err(e) = conn_fut.await {
println!("An error occurred: {:?}", e);
}
});
}
})
}Running load_test: |
|
I can repro that problem here. Digging into it. |
|
@littledivy Ah. It's because there wasn't a fragment collector on the read half. I will add some documentation around this. |
|
Ran the two benchmarks and it looks pretty good: Split: Unsplit |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #40. Working on this in concert with denoland/deno#20579 and #49
This API is not final
To create a split WebSocket, you can either call:
WebSocket::split, passing a function that can split a stream into read and write halves (tokio::io::splitis suitable for this, as well asTcpStream::into_splithttps://docs.rs/tokio/latest/tokio/net/struct.TcpStream.html#method.into_split), orafter_handshake_split, passing read and write streams.From the
WebSocketReadandWebSocketWritehalves, you'll need to ensure that obligated writes fromWebSocketRead::read_frameare passed towrite_frame. This is done by passing a closure that returns a future.Note that a
FragmentCollectorReadmay be created from aWebSocketReadin the same way thatFragmentCollectormay be created from aWebSocket.In the case of Deno's split socket, the read process looks like this: