Rename write methods

Renamed the write methods to sendTextMessage
and sendBinaryMessage respectively. This makes
the code more readable.

Change-Id: Ie49abf07a37f54c84bd01c5c788d2e42b28bcfdd
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>

diff --git a/examples/echoclient/echoclient.cpp b/examples/echoclient/echoclient.cpp
index 0c9bef8..c1ef7ed 100644 (file)
--- a/examples/echoclient/echoclient.cpp
+++ b/examples/echoclient/echoclient.cpp
@@ -61,7 +61,7 @@ void EchoClient::onConnected()
     qDebug() << "Websocket connected";
     connect(&m_webSocket, &QWebSocket::textMessageReceived,
             this, &EchoClient::onTextMessageReceived);
-    qint64 bytesWritten = m_webSocket.write(QStringLiteral("Hello, world!"));
+    qint64 bytesWritten = m_webSocket.sendTextMessage(QStringLiteral("Hello, world!"));
     Q_UNUSED(bytesWritten);
 }
 //! [onConnected]

diff --git a/examples/echoserver/echoserver.cpp b/examples/echoserver/echoserver.cpp
index c094cb6..a3465c0 100644 (file)
--- a/examples/echoserver/echoserver.cpp
+++ b/examples/echoserver/echoserver.cpp
@@ -88,7 +88,7 @@ void EchoServer::processMessage(QString message)
 {
     QWebSocket *pClient = qobject_cast<QWebSocket *>(sender());
     if (pClient) {
-        qint64 bytesWritten = pClient->write(message);
+        qint64 bytesWritten = pClient->sendTextMessage(message);
         Q_UNUSED(bytesWritten);
     }
     m_pWebSocketServer->close();
@@ -100,7 +100,7 @@ void EchoServer::processBinaryMessage(QByteArray message)
 {
     QWebSocket *pClient = qobject_cast<QWebSocket *>(sender());
     if (pClient) {
-        qint64 bytesWritten = pClient->write(message);
+        qint64 bytesWritten = pClient->sendBinaryMessage(message);
         Q_UNUSED(bytesWritten);
     }
 }

diff --git a/examples/simplechat/chatserver.cpp b/examples/simplechat/chatserver.cpp
index f7ad006..ffb4fad 100644 (file)
--- a/examples/simplechat/chatserver.cpp
+++ b/examples/simplechat/chatserver.cpp
@@ -83,7 +83,7 @@ void ChatServer::processMessage(QString message)
     {
         if (pClient != pSender) //don't echo message back to sender
         {
-            qint64 bytesWritten = pClient->write(message);
+            qint64 bytesWritten = pClient->sendTextMessage(message);
             Q_UNUSED(bytesWritten);
         }
     }

diff --git a/examples/sslechoclient/sslechoclient.cpp b/examples/sslechoclient/sslechoclient.cpp
index 9807719..73e6910 100644 (file)
--- a/examples/sslechoclient/sslechoclient.cpp
+++ b/examples/sslechoclient/sslechoclient.cpp
@@ -59,7 +59,7 @@ void SslEchoClient::onConnected()
     qDebug() << "Websocket connected";
     connect(&m_webSocket, &QWebSocket::textMessageReceived,
             this, &SslEchoClient::onTextMessageReceived);
-    qint64 bytesWritten = m_webSocket.write(QStringLiteral("Hello, world!"));
+    qint64 bytesWritten = m_webSocket.sendTextMessage(QStringLiteral("Hello, world!"));
     Q_UNUSED(bytesWritten);
 }
 //! [onConnected]

diff --git a/examples/sslechoserver/sslechoserver.cpp b/examples/sslechoserver/sslechoserver.cpp
index c6bca2f..db44af6 100644 (file)
--- a/examples/sslechoserver/sslechoserver.cpp
+++ b/examples/sslechoserver/sslechoserver.cpp
@@ -105,7 +105,7 @@ void SslEchoServer::processMessage(QString message)
     QWebSocket *pClient = qobject_cast<QWebSocket *>(sender());
     if (pClient)
     {
-        qint64 bytesWritten = pClient->write(message);
+        qint64 bytesWritten = pClient->sendTextMessage(message);
         Q_UNUSED(bytesWritten);
     }
 }
@@ -117,7 +117,7 @@ void SslEchoServer::processBinaryMessage(QByteArray message)
     QWebSocket *pClient = qobject_cast<QWebSocket *>(sender());
     if (pClient)
     {
-        qint64 bytesWritten = pClient->write(message);
+        qint64 bytesWritten = pClient->sendBinaryMessage(message);
         Q_UNUSED(bytesWritten);
     }
 }

diff --git a/src/imports/qmlwebsockets/qqmlwebsocket.cpp b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
index 7ba03c0..f58c8d0 100644 (file)
--- a/src/imports/qmlwebsockets/qqmlwebsocket.cpp
+++ b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
@@ -126,7 +126,7 @@ qint64 QQmlWebSocket::sendTextMessage(const QString &message)
         setStatus(Error);
         return 0;
     }
-    return m_webSocket->write(message);
+    return m_webSocket->sendTextMessage(message);
 }
 
 QUrl QQmlWebSocket::url() const

diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp
index ada9799..c08aed3 100644 (file)
--- a/src/websockets/qwebsocket.cpp
+++ b/src/websockets/qwebsocket.cpp
@@ -330,21 +330,25 @@ bool QWebSocket::flush()
 /*!
     \brief Sends the given \a message over the socket as a text message and
     returns the number of bytes actually sent.
+
+    \sa sendBinaryMessage()
  */
-qint64 QWebSocket::write(const QString &message)
+qint64 QWebSocket::sendTextMessage(const QString &message)
 {
     Q_D(QWebSocket);
-    return d->write(message);
+    return d->sendTextMessage(message);
 }
 
 /*!
     \brief Sends the given \a data over the socket as a binary message and
     returns the number of bytes actually sent.
+
+    \sa sendTextMessage()
  */
-qint64 QWebSocket::write(const QByteArray &data)
+qint64 QWebSocket::sendBinaryMessage(const QByteArray &data)
 {
     Q_D(QWebSocket);
-    return d->write(data);
+    return d->sendBinaryMessage(data);
 }
 
 /*!

diff --git a/src/websockets/qwebsocket.h b/src/websockets/qwebsocket.h
index 18f8994..7f4131e 100644 (file)
--- a/src/websockets/qwebsocket.h
+++ b/src/websockets/qwebsocket.h
@@ -104,8 +104,8 @@ public:
     QWebSocketProtocol::CloseCode closeCode() const;
     QString closeReason() const;
 
-    qint64 write(const QString &message) Q_REQUIRED_RESULT;
-    qint64 write(const QByteArray &data) Q_REQUIRED_RESULT;
+    qint64 sendTextMessage(const QString &message) Q_REQUIRED_RESULT;
+    qint64 sendBinaryMessage(const QByteArray &data) Q_REQUIRED_RESULT;
 
 #ifndef QT_NO_SSL
     void ignoreSslErrors(const QList<QSslError> &errors);

diff --git a/src/websockets/qwebsocket_p.cpp b/src/websockets/qwebsocket_p.cpp
index bd4d1c1..5d775ef 100644 (file)
--- a/src/websockets/qwebsocket_p.cpp
+++ b/src/websockets/qwebsocket_p.cpp
@@ -210,7 +210,7 @@ bool QWebSocketPrivate::flush()
 /*!
     \internal
  */
-qint64 QWebSocketPrivate::write(const QString &message)
+qint64 QWebSocketPrivate::sendTextMessage(const QString &message)
 {
     return doWriteFrames(message.toUtf8(), false);
 }
@@ -218,7 +218,7 @@ qint64 QWebSocketPrivate::write(const QString &message)
 /*!
     \internal
  */
-qint64 QWebSocketPrivate::write(const QByteArray &data)
+qint64 QWebSocketPrivate::sendBinaryMessage(const QByteArray &data)
 {
     return doWriteFrames(data, true);
 }

diff --git a/src/websockets/qwebsocket_p.h b/src/websockets/qwebsocket_p.h
index 611c817..d3f13e2 100644 (file)
--- a/src/websockets/qwebsocket_p.h
+++ b/src/websockets/qwebsocket_p.h
@@ -140,8 +140,8 @@ public:
     QWebSocketProtocol::CloseCode closeCode() const;
     QString closeReason() const;
 
-    qint64 write(const QString &message) Q_REQUIRED_RESULT;
-    qint64 write(const QByteArray &data) Q_REQUIRED_RESULT;    //send data as binary
+    qint64 sendTextMessage(const QString &message) Q_REQUIRED_RESULT;
+    qint64 sendBinaryMessage(const QByteArray &data) Q_REQUIRED_RESULT;
 
 #ifndef QT_NO_SSL
     void ignoreSslErrors(const QList<QSslError> &errors);

diff --git a/tests/manual/compliance/tst_compliance.cpp b/tests/manual/compliance/tst_compliance.cpp
index 5c2115c..114428b 100644 (file)
--- a/tests/manual/compliance/tst_compliance.cpp
+++ b/tests/manual/compliance/tst_compliance.cpp
@@ -105,10 +105,10 @@ void tst_ComplianceTest::runTestCase(int nbr, int total)
     //ws://ipaddress:port/runCase?case=<number>&agent=<agentname>
     //where agent name will be QWebSocket
     QObject::connect(pWebSocket, &QWebSocket::textMessageReceived, [=](QString message) {
-        pWebSocket->write(message);
+        pWebSocket->sendTextMessage(message);
     });
     QObject::connect(pWebSocket, &QWebSocket::binaryMessageReceived, [=](QByteArray message) {
-        pWebSocket->write(message);
+        pWebSocket->sendBinaryMessage(message);
     });
 
     qDebug() << "Executing test" << (nbr + 1) << "/" << total;

diff --git a/tests/manual/websockets/tst_websockets.cpp b/tests/manual/websockets/tst_websockets.cpp
index 978520d..b4bf4e4 100644 (file)
--- a/tests/manual/websockets/tst_websockets.cpp
+++ b/tests/manual/websockets/tst_websockets.cpp
@@ -134,7 +134,7 @@ void tst_WebSocketsTest::testTextMessage()
 
     QSignalSpy spy(m_pWebSocket, SIGNAL(textMessageReceived(QString)));
 
-    QCOMPARE(m_pWebSocket->write(message), qint64(message.length()));
+    QCOMPARE(m_pWebSocket->sendTextMessage(message), qint64(message.length()));
     QTRY_VERIFY_WITH_TIMEOUT(spy.count() != 0, 1000);
     QCOMPARE(spy.count(), 1);
     QCOMPARE(spy.at(0).count(), 1);
@@ -147,7 +147,7 @@ void tst_WebSocketsTest::testBinaryMessage()
 
     QByteArray data("Hello world!");
 
-    QCOMPARE(m_pWebSocket->write(data), qint64(data.size()));
+    QCOMPARE(m_pWebSocket->sendBinaryMessage(data), qint64(data.size()));
 
     QTRY_VERIFY_WITH_TIMEOUT(spy.count() != 0, 1000);
     QCOMPARE(spy.count(), 1);