From d81e4d4fc04fef66de22c084dd80fa18eabdb261 Mon Sep 17 00:00:00 2001 From: Benjamin Sergeant Date: Tue, 31 Mar 2020 18:36:50 -0700 Subject: [PATCH] setHeartBeatPeriod -> setPingInterval (in doc + disabled unittests) --- docs/usage.md | 4 ++-- test/IXWebSocketPingTest.cpp | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index 4b0d71fd..c9d4d564 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -35,7 +35,7 @@ webSocket.setUrl(url); // Optional heart beat, sent every 45 seconds when there is not any traffic // to make sure that load balancers do not kill an idle connection. -webSocket.setHeartBeatPeriod(45); +webSocket.setPingInterval(45); // Per message deflate connection is enabled by default. You can tweak its parameters or disable it webSocket.disablePerMessageDeflate(); @@ -174,7 +174,7 @@ when there is no any traffic to make sure that load balancers do not kill an idle connection. ```cpp -webSocket.setHeartBeatPeriod(45); +webSocket.setPingInterval(45); ``` ### Supply extra HTTP headers. diff --git a/test/IXWebSocketPingTest.cpp b/test/IXWebSocketPingTest.cpp index b19e4302..b845345b 100644 --- a/test/IXWebSocketPingTest.cpp +++ b/test/IXWebSocketPingTest.cpp @@ -65,7 +65,7 @@ namespace // Set a 1 second heartbeat with the setter method to test if (_useHeartBeatMethod) { - _webSocket.setHeartBeatPeriod(1); + _webSocket.setPingInterval(1); } else { @@ -378,9 +378,9 @@ TEST_CASE("Websocket_ping_data_sent_setPingInterval_full", "[setPingInterval]") } } -// Using setHeartBeatPeriod +// Using setPingInterval -TEST_CASE("Websocket_ping_no_data_sent_setHeartBeatPeriod", "[setHeartBeatPeriod]") +TEST_CASE("Websocket_ping_no_data_sent_setHeartBeatPeriod", "[setPingInterval]") { SECTION("Make sure that ping messages are sent when no other data are sent.") { @@ -424,7 +424,7 @@ TEST_CASE("Websocket_ping_no_data_sent_setHeartBeatPeriod", "[setHeartBeatPeriod } } -TEST_CASE("Websocket_ping_data_sent_setHeartBeatPeriod", "[setHeartBeatPeriod]") +TEST_CASE("Websocket_ping_data_sent_setHeartBeatPeriod", "[setPingInterval]") { SECTION("Make sure that ping messages are sent, even if other messages are sent") {