-
Notifications
You must be signed in to change notification settings - Fork 640
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
inactivity_timeout is triggered regardless of having received pings #2716
Comments
I made a somewhat-minimal reproduction at https://gist.github.com/xim/06d60c455363fbb764c14f21d7705c40 Compiled and run by running each in a separate terminal:
|
What are you using as the tcp stream? Are you calling async_read perpetually? |
As shown in the gist, I made a somewhat-minimal reproduction with the example websocket_client_async.cpp as a base. It's a |
Full code instead of patch at https://gist.github.com/xim/97874f6d7e27402f26228a0da6448236 Here, the server sends pings ever 1s and the client has a 5s timeout. Client output:
Server output:
|
If the stream is receiving control packets like ping, don't count it as idle. This means you can enable `timeout_opt.keep_alive_ping` on only one side to get heartbeat. Addresses issue boostorg#2716
Made a PR. If you want this to be configurable, I can have a stab at that as well. |
I couldn't find any indication in RFC 6455 that either permits or prohibits the counting of control frames as a form of activity. Considering that this approach could potentially eliminate the need for extra ping-pong messages every n seconds for clients with enabled keep_alive_pings, introducing an additional parameter to the configuration could unnecessarily complicate matters for a feature that might see very limited use. The only plausible options appear to be either counting pings as activity (assuming the standard allows for it), or maintaining the status quo. Users could opt to utilize the low-level API and manually implement ping-pong if they wish to minimize the transmission of extra ping-pong messages. |
Agree, the most precise is the phrasing IMHO it makes sense for control frames to count as activity.
Exactly, good summary there.
My vote is on the former =) |
Without thinking about it too much, I believe received pings should reset the timer, as they represent activity. Regardless of what is changed, the library documentation should be updated to describe either the current or the new behavior of received pings with respect to timeouts if it is not already explained. |
The specifications say nothing about what counts as idle activity. Ideally Beast would have great defaults that work for most people, while also allowing for the caller to have perfect control over customizing that behavior. However Beast has reaching close to the end of what can be done without incurring technical debt, so this ideal will likely only be approached in a new websocket library which will replace beast (this work has not started yet). |
Does that mean we should proceed towards merging the PR, @vinniefalco? I can make additional adjustments or try to document more inline if you wish! |
@xim It would be great if you could add the relevant test cases to the PR; This is the appropriate location for including them: https://github.com/boostorg/beast/blob/develop/test/beast/websocket/ping.cpp. |
I don't see how I can test this without actually waiting for timers to expire. I mean, this test passes, but sleeping in the test like this is probably not OK? echo_server es{log};
error_code ec;
stream<test::stream> ws{ioc_};
ws.set_option(stream_base::timeout{
stream_base::none(),
std::chrono::milliseconds(100),
false
});
ws.next_layer().connect(es.stream());
ws.handshake("localhost", "/");
flat_buffer b;
bool got_timeout = false;
ws.async_read(b,
[&](error_code ec, std::size_t)
{
std::cerr << ec.message() << std::endl;
if(ec != beast::error::timeout)
BOOST_THROW_EXCEPTION(
system_error{ec});
got_timeout = true;
});
BEAST_EXPECT(ws.impl_->idle_counter == 0);
ioc_.run_for(std::chrono::milliseconds(60));
ioc_.restart();
BEAST_EXPECT(ws.impl_->idle_counter == 1);
ws.ping("", ec);
if(ec)
BOOST_THROW_EXCEPTION(
system_error{ec});
ioc_.run_for(std::chrono::milliseconds(10));
ioc_.restart();
BEAST_EXPECT(ws.impl_->idle_counter == 0);
BEAST_EXPECT(!got_timeout);
ioc_.run_for(std::chrono::milliseconds(100));
ioc_.restart();
BEAST_EXPECT(got_timeout); |
It seems this how is how timeout cases are tested in the entire code base (searching for |
If the stream is receiving control packets like ping, don't count it as idle. This means you can enable `timeout_opt.keep_alive_ping` on only one side to get heartbeat. Addresses issue boostorg#2716
If the stream is receiving control packets like ping, don't count it as idle. This means you can enable `timeout_opt.keep_alive_ping` on only one side to get heartbeat. Addresses issue boostorg#2716
If the stream is receiving control packets like ping, don't count it as idle. This means you can enable `timeout_opt.keep_alive_ping` on only one side to get heartbeat. Addresses issue boostorg#2716
If the stream is receiving control packets like ping, don't count it as idle. This means you can enable `timeout_opt.keep_alive_ping` on only one side to get heartbeat. Make tests that verify current behaviour. Update documentation to match changes in PR boostorg#2718. Addresses issue boostorg#2716
If the stream is receiving control packets like ping, don't count it as idle. This means you can enable `timeout_opt.keep_alive_ping` on only one side to get heartbeat. Make tests that verify current behaviour. Update documentation to match changes in PR boostorg#2718. Addresses issue boostorg#2716
If the stream is receiving control packets like ping, don't count it as idle. This means you can enable `timeout_opt.keep_alive_ping` on only one side to get heartbeat. Make tests that verify current behaviour. Update documentation to match changes in PR boostorg#2718. Addresses issue boostorg#2716
Version of Beast
347
Steps necessary to reproduce the problem
I'm using plain, async
boost::beast::websocket
for a server and a client.I have a server that's sending ping packets at a 15s interval and keeping the connection alive correctly. I have verified that the client receives these and responds with pongs.
Since I have these ping packets going, I've added a timeout in the client to try to detect if the connection goes down:
ws_.set_option(boost::beast::websocket::stream_base::timeout{ 60s, 30s, false });
I had assumed that this would be kept alive by the ping packets sent from the server, but it isn't. The client disconnects with the message
The socket was closed due to a timeout
.Setting the final flag (keep_alive_pings) to
true
makes the client keep the connection alive by doing the same as the server's already doing. Given the server set to send ping frames at 15s intervals, this setting on the client:ws_.set_option(boost::beast::websocket::stream_base::timeout{ 60s, 80s, true });
Means I'll get this behaviour:
I feel is the desired behaviour would be to count incoming ping frames as activity. If that can't be made the default behaviour, could we try to add it as a config on
boost::beast::websocket::stream_base::timeout
?The text was updated successfully, but these errors were encountered: