kapitan/IXWebSocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

setHeartBeatPeriod -> setPingInterval (in doc + disabled unittests)

Browse Source
This commit is contained in:
Benjamin Sergeant 2020-03-31 18:36:50 -07:00
parent bd44d32fdb
commit d81e4d4fc0
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/usage.md
View File

@ -35,7 +35,7 @@ webSocket.setUrl(url);
// Optional heart beat, sent every 45 seconds when there is not any traffic // 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. // 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 // Per message deflate connection is enabled by default. You can tweak its parameters or disable it
webSocket.disablePerMessageDeflate(); webSocket.disablePerMessageDeflate();
@ -174,7 +174,7 @@ when there is no any traffic to make sure that load balancers do not kill an
idle connection. idle connection.
```cpp ```cpp
webSocket.setHeartBeatPeriod(45); webSocket.setPingInterval(45);
``` ```
### Supply extra HTTP headers. ### Supply extra HTTP headers.

8
test/IXWebSocketPingTest.cpp
View File

@ -65,7 +65,7 @@ namespace
// Set a 1 second heartbeat with the setter method to test // Set a 1 second heartbeat with the setter method to test
if (_useHeartBeatMethod) if (_useHeartBeatMethod)
{ {
_webSocket.setHeartBeatPeriod(1); _webSocket.setPingInterval(1);
} }
else 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.") 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") SECTION("Make sure that ping messages are sent, even if other messages are sent")
{ {