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

indentation / comestic changes

Browse Source
This commit is contained in:
Benjamin Sergeant 2019-04-19 16:57:38 -07:00
parent 0dfc66f1c7
commit d48bf9249b
6 changed files with 41 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ixwebsocket/IXWebSocket.cpp
View File

@ -130,7 +130,7 @@ namespace ix
std::lock_guard<std::mutex> lock(_configMutex); std::lock_guard<std::mutex> lock(_configMutex);
_enablePong = false; _enablePong = false;
} }
void WebSocket::start() void WebSocket::start()
{ {
if (_thread.joinable()) return; // we've already been started if (_thread.joinable()) return; // we've already been started
@ -188,7 +188,7 @@ namespace ix
{ {
std::lock_guard<std::mutex> lock(_configMutex); std::lock_guard<std::mutex> lock(_configMutex);
_ws.configure(_perMessageDeflateOptions, _ws.configure(_perMessageDeflateOptions,
_enablePong, _enablePong,
_pingIntervalSecs, _pingIntervalSecs,
_pingTimeoutSecs); _pingTimeoutSecs);
} }

2
ixwebsocket/IXWebSocket.h
View File

@ -94,7 +94,7 @@ namespace ix
void setPingTimeout(int pingTimeoutSecs); void setPingTimeout(int pingTimeoutSecs);
void enablePong(); void enablePong();
void disablePong(); void disablePong();
// Run asynchronously, by calling start and stop. // Run asynchronously, by calling start and stop.
void start(); void start();
void stop(); void stop();

23
ixwebsocket/IXWebSocketTransport.cpp
View File

@ -100,7 +100,8 @@ namespace ix
void WebSocketTransport::configure(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions, void WebSocketTransport::configure(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions,
bool enablePong, bool enablePong,
int pingIntervalSecs, int pingTimeoutSecs) int pingIntervalSecs,
int pingTimeoutSecs)
{ {
_perMessageDeflateOptions = perMessageDeflateOptions; _perMessageDeflateOptions = perMessageDeflateOptions;
_enablePerMessageDeflate = _perMessageDeflateOptions.enabled(); _enablePerMessageDeflate = _perMessageDeflateOptions.enabled();
@ -109,11 +110,18 @@ namespace ix
_pingTimeoutSecs = pingTimeoutSecs; _pingTimeoutSecs = pingTimeoutSecs;
if (pingIntervalSecs > 0 && pingTimeoutSecs > 0) if (pingIntervalSecs > 0 && pingTimeoutSecs > 0)
_pingIntervalOrTimeoutGCDSecs = greatestCommonDivisor(pingIntervalSecs, pingTimeoutSecs); {
_pingIntervalOrTimeoutGCDSecs = greatestCommonDivisor(pingIntervalSecs,
pingTimeoutSecs);
}
else if (_pingTimeoutSecs > 0) else if (_pingTimeoutSecs > 0)
{
_pingIntervalOrTimeoutGCDSecs = pingTimeoutSecs; _pingIntervalOrTimeoutGCDSecs = pingTimeoutSecs;
}
else else
{
_pingIntervalOrTimeoutGCDSecs = pingIntervalSecs; _pingIntervalOrTimeoutGCDSecs = pingIntervalSecs;
}
} }
// Client // Client
@ -236,13 +244,13 @@ namespace ix
if (_readyState == OPEN) if (_readyState == OPEN)
{ {
// if (1) ping timeout is enabled and (2) duration since last received ping response (PONG) // if (1) ping timeout is enabled and (2) duration since last received
// exceeds the maximum delay, then close the connection // ping response (PONG) exceeds the maximum delay, then close the connection
if (pingTimeoutExceeded()) if (pingTimeoutExceeded())
{ {
close(kInternalErrorCode, kPingTimeoutMessage); close(kInternalErrorCode, kPingTimeoutMessage);
} }
// If (1) ping is enabled and no ping has been sent for a duration // If ping is enabled and no ping has been sent for a duration
// exceeding our ping interval, send a ping to the server. // exceeding our ping interval, send a ping to the server.
else if (pingIntervalExceeded()) else if (pingIntervalExceeded())
{ {
@ -786,10 +794,9 @@ namespace ix
WebSocketSendInfo WebSocketTransport::sendPing(const std::string& message) WebSocketSendInfo WebSocketTransport::sendPing(const std::string& message)
{ {
bool compress = false; bool compress = false;
WebSocketSendInfo info = sendData(wsheader_type::PING, message, compress); WebSocketSendInfo info = sendData(wsheader_type::PING, message, compress);
if(info.success) if (info.success)
{ {
std::lock_guard<std::mutex> lck(_lastSendPingTimePointMutex); std::lock_guard<std::mutex> lck(_lastSendPingTimePointMutex);
_lastSendPingTimePoint = std::chrono::steady_clock::now(); _lastSendPingTimePoint = std::chrono::steady_clock::now();
@ -851,7 +858,7 @@ namespace ix
// See list of close events here: // See list of close events here:
// https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent // https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent
int codeLength = 2; int codeLength = 2;
std::string closure{(char)(code >> 8), (char)(code & 0xff)}; std::string closure{(char)(code >> 8), (char)(code & 0xff)};
closure.resize(codeLength + reason.size()); closure.resize(codeLength + reason.size());

23
ixwebsocket/IXWebSocketTransport.h
View File

@ -69,7 +69,8 @@ namespace ix
void configure(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions, void configure(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions,
bool enablePong, bool enablePong,
int pingIntervalSecs, int pingTimeoutSecs); int pingIntervalSecs,
int pingTimeoutSecs);
WebSocketInitResult connectToUrl(const std::string& url, // Client WebSocketInitResult connectToUrl(const std::string& url, // Client
int timeoutSecs); int timeoutSecs);
@ -162,24 +163,26 @@ namespace ix
// Constants for dealing with closing conneections // Constants for dealing with closing conneections
static const uint16_t kInternalErrorCode; static const uint16_t kInternalErrorCode;
static const uint16_t kAbnormalCloseCode; static const uint16_t kAbnormalCloseCode;
const static std::string kInternalErrorMessage; static const std::string kInternalErrorMessage;
const static std::string kAbnormalCloseMessage; static const std::string kAbnormalCloseMessage;
const static std::string kPingTimeoutMessage; static const std::string kPingTimeoutMessage;
// enable auto response to ping // enable auto response to ping
bool _enablePong; bool _enablePong;
static const bool kDefaultEnablePong; static const bool kDefaultEnablePong;
// Optional ping and pong timeout // Optional ping and pong timeout
// if both ping interval and timeout are set (> 0),
// then use GCD of these value to wait for the lowest time
int _pingIntervalSecs; int _pingIntervalSecs;
int _pingTimeoutSecs; int _pingTimeoutSecs;
int _pingIntervalOrTimeoutGCDSecs; // if both ping interval and timeout are set (> 0), then use GCD of these value to wait for the lowest time int _pingIntervalOrTimeoutGCDSecs;
static const int kDefaultPingIntervalSecs; static const int kDefaultPingIntervalSecs;
static const int kDefaultPingTimeoutSecs; static const int kDefaultPingTimeoutSecs;
const static std::string kPingMessage; static const std::string kPingMessage;
// We record when ping are being sent so that we can know when to send the next one, periodically // We record when ping are being sent so that we can know when to send the next one
// We also record when pong are being sent as a reply to pings, to close the connections // We also record when pong are being sent as a reply to pings, to close the connections
// if no pong were received sufficiently fast. // if no pong were received sufficiently fast.
mutable std::mutex _lastSendPingTimePointMutex; mutable std::mutex _lastSendPingTimePointMutex;
@ -189,7 +192,7 @@ namespace ix
// If this function returns true, it is time to send a new ping // If this function returns true, it is time to send a new ping
bool pingIntervalExceeded(); bool pingIntervalExceeded();
// No PONG data was received through the socket for longer than ping timeout delay // No PONG data was received through the socket for longer than ping timeout delay
bool pingTimeoutExceeded(); bool pingTimeoutExceeded();

8
test/IXWebSocketPingTest.cpp
View File

@ -211,7 +211,7 @@ TEST_CASE("Websocket_ping_no_data_sent_setHeartBeatPeriod", "[setHeartBeatPeriod
webSocketClient.stop(); webSocketClient.stop();
// Here we test ping interval // Here we test ping interval
// -> expected ping messages == 1 as 1900 seconds, 1 ping sent every second // -> expected ping messages == 1 as 1900 seconds, 1 ping sent every second
REQUIRE(serverReceivedPingMessages == 1); REQUIRE(serverReceivedPingMessages == 1);
@ -257,7 +257,7 @@ TEST_CASE("Websocket_ping_data_sent_setHeartBeatPeriod", "[setHeartBeatPeriod]")
webSocketClient.stop(); webSocketClient.stop();
// Here we test ping interval // Here we test ping interval
// client has sent data, but ping should have been sent no matter what // client has sent data, but ping should have been sent no matter what
// -> expected ping messages == 2 as 900+900+1100 = 2900 seconds, 1 ping sent every second // -> expected ping messages == 2 as 900+900+1100 = 2900 seconds, 1 ping sent every second
REQUIRE(serverReceivedPingMessages == 2); REQUIRE(serverReceivedPingMessages == 2);
@ -301,7 +301,7 @@ TEST_CASE("Websocket_ping_no_data_sent_setPingInterval", "[setPingInterval]")
webSocketClient.stop(); webSocketClient.stop();
// Here we test ping interval // Here we test ping interval
// -> expected ping messages == 2 as 2100 seconds, 1 ping sent every second // -> expected ping messages == 2 as 2100 seconds, 1 ping sent every second
REQUIRE(serverReceivedPingMessages == 2); REQUIRE(serverReceivedPingMessages == 2);
@ -347,7 +347,7 @@ TEST_CASE("Websocket_ping_data_sent_setPingInterval", "[setPingInterval]")
webSocketClient.stop(); webSocketClient.stop();
// Here we test ping interval // Here we test ping interval
// client has sent data, but ping should have been sent no matter what // client has sent data, but ping should have been sent no matter what
// -> expected ping messages == 3 as 900+900+1300 = 3100 seconds, 1 ping sent every second // -> expected ping messages == 3 as 900+900+1300 = 3100 seconds, 1 ping sent every second
REQUIRE(serverReceivedPingMessages == 3); REQUIRE(serverReceivedPingMessages == 3);

12
test/IXWebSocketPingTimeoutTest.cpp
View File

@ -113,7 +113,7 @@ namespace
} }
_webSocket.disableAutomaticReconnection(); _webSocket.disableAutomaticReconnection();
} }
else if (messageType == ix::WebSocket_MessageType_Error) else if (messageType == ix::WebSocket_MessageType_Error)
{ {
@ -229,7 +229,7 @@ TEST_CASE("Websocket_ping_timeout_not_checked", "[setPingTimeout]")
ix::setupWebSocketTrafficTrackerCallback(); ix::setupWebSocketTrafficTrackerCallback();
int port = getFreePort(); int port = getFreePort();
ix::WebSocketServer server(port); ix::WebSocketServer server(port);
std::atomic<int> serverReceivedPingMessages(0); std::atomic<int> serverReceivedPingMessages(0);
bool enablePong = false; // Pong is disabled on Server bool enablePong = false; // Pong is disabled on Server
REQUIRE(startServer(server, serverReceivedPingMessages, enablePong)); REQUIRE(startServer(server, serverReceivedPingMessages, enablePong));
@ -282,7 +282,7 @@ TEST_CASE("Websocket_ping_no_timeout", "[setPingTimeout]")
ix::setupWebSocketTrafficTrackerCallback(); ix::setupWebSocketTrafficTrackerCallback();
int port = getFreePort(); int port = getFreePort();
ix::WebSocketServer server(port); ix::WebSocketServer server(port);
std::atomic<int> serverReceivedPingMessages(0); std::atomic<int> serverReceivedPingMessages(0);
bool enablePong = true; // Pong is enabled on Server bool enablePong = true; // Pong is enabled on Server
REQUIRE(startServer(server, serverReceivedPingMessages, enablePong)); REQUIRE(startServer(server, serverReceivedPingMessages, enablePong));
@ -335,7 +335,7 @@ TEST_CASE("Websocket_no_ping_but_timeout", "[setPingTimeout]")
ix::setupWebSocketTrafficTrackerCallback(); ix::setupWebSocketTrafficTrackerCallback();
int port = getFreePort(); int port = getFreePort();
ix::WebSocketServer server(port); ix::WebSocketServer server(port);
std::atomic<int> serverReceivedPingMessages(0); std::atomic<int> serverReceivedPingMessages(0);
bool enablePong = false; // Pong is disabled on Server bool enablePong = false; // Pong is disabled on Server
REQUIRE(startServer(server, serverReceivedPingMessages, enablePong)); REQUIRE(startServer(server, serverReceivedPingMessages, enablePong));
@ -388,7 +388,7 @@ TEST_CASE("Websocket_ping_timeout", "[setPingTimeout]")
ix::setupWebSocketTrafficTrackerCallback(); ix::setupWebSocketTrafficTrackerCallback();
int port = getFreePort(); int port = getFreePort();
ix::WebSocketServer server(port); ix::WebSocketServer server(port);
std::atomic<int> serverReceivedPingMessages(0); std::atomic<int> serverReceivedPingMessages(0);
bool enablePong = false; // Pong is disabled on Server bool enablePong = false; // Pong is disabled on Server
REQUIRE(startServer(server, serverReceivedPingMessages, enablePong)); REQUIRE(startServer(server, serverReceivedPingMessages, enablePong));
@ -439,7 +439,7 @@ TEST_CASE("Websocket_ping_long_timeout", "[setPingTimeout]")
ix::setupWebSocketTrafficTrackerCallback(); ix::setupWebSocketTrafficTrackerCallback();
int port = getFreePort(); int port = getFreePort();
ix::WebSocketServer server(port); ix::WebSocketServer server(port);
std::atomic<int> serverReceivedPingMessages(0); std::atomic<int> serverReceivedPingMessages(0);
bool enablePong = false; // Pong is disabled on Server bool enablePong = false; // Pong is disabled on Server
REQUIRE(startServer(server, serverReceivedPingMessages, enablePong)); REQUIRE(startServer(server, serverReceivedPingMessages, enablePong));