Qt Reference Documentation

connection.h Example File

network/network-chat/connection.h
 /****************************************************************************
 **
 ** Copyright (C) 2015 The Qt Company Ltd.
 ** Contact: http://www.qt.io/licensing/
 **
 ** This file is part of the examples of the Qt Toolkit.
 **
 ** $QT_BEGIN_LICENSE:BSD$
 ** You may use this file under the terms of the BSD license as follows:
 **
 ** "Redistribution and use in source and binary forms, with or without
 ** modification, are permitted provided that the following conditions are
 ** met:
 **   * Redistributions of source code must retain the above copyright
 **     notice, this list of conditions and the following disclaimer.
 **   * Redistributions in binary form must reproduce the above copyright
 **     notice, this list of conditions and the following disclaimer in
 **     the documentation and/or other materials provided with the
 **     distribution.
 **   * Neither the name of The Qt Company Ltd nor the names of its
 **     contributors may be used to endorse or promote products derived
 **     from this software without specific prior written permission.
 **
 **
 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
 **
 ** $QT_END_LICENSE$
 **
 ****************************************************************************/

 #ifndef CONNECTION_H
 #define CONNECTION_H

 #include <QHostAddress>
 #include <QString>
 #include <QTcpSocket>
 #include <QTime>
 #include <QTimer>

 static const int MaxBufferSize = 1024000;

 class Connection : public QTcpSocket
 {
     Q_OBJECT

 public:
     enum ConnectionState {
         WaitingForGreeting,
         ReadingGreeting,
         ReadyForUse
     };
     enum DataType {
         PlainText,
         Ping,
         Pong,
         Greeting,
         Undefined
     };

     Connection(QObject *parent = 0);

     QString name() const;
     void setGreetingMessage(const QString &message);
     bool sendMessage(const QString &message);

 signals:
     void readyForUse();
     void newMessage(const QString &from, const QString &message);

 protected:
     void timerEvent(QTimerEvent *timerEvent);

 private slots:
     void processReadyRead();
     void sendPing();
     void sendGreetingMessage();

 private:
     int readDataIntoBuffer(int maxSize = MaxBufferSize);
     int dataLengthForCurrentDataType();
     bool readProtocolHeader();
     bool hasEnoughData();
     void processData();

     QString greetingMessage;
     QString username;
     QTimer pingTimer;
     QTime pongTime;
     QByteArray buffer;
     ConnectionState state;
     DataType currentDataType;
     int numBytesForCurrentDataType;
     int transferTimerId;
     bool isGreetingMessageSent;
 };

 #endif