client.cpp Example File

ipc/localfortuneclient/client.cpp

  /****************************************************************************
  **
  ** Copyright (C) 2016 The Qt Company Ltd.
  ** Contact: https://www.qt.io/licensing/
  **
  ** This file is part of the examples of the Qt Toolkit.
  **
  ** $QT_BEGIN_LICENSE:BSD$
  ** Commercial License Usage
  ** Licensees holding valid commercial Qt licenses may use this file in
  ** accordance with the commercial license agreement provided with the
  ** Software or, alternatively, in accordance with the terms contained in
  ** a written agreement between you and The Qt Company. For licensing terms
  ** and conditions see https://www.qt.io/terms-conditions. For further
  ** information use the contact form at https://www.qt.io/contact-us.
  **
  ** BSD License Usage
  ** Alternatively, 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$
  **
  ****************************************************************************/

  #include <QtWidgets>
  #include <QtNetwork>

  #include "client.h"

  Client::Client(QWidget *parent)
      : QDialog(parent),
        hostLineEdit(new QLineEdit("fortune")),
        getFortuneButton(new QPushButton(tr("Get Fortune"))),
        statusLabel(new QLabel(tr("This examples requires that you run the "
                                  "Local Fortune Server example as well."))),
        socket(new QLocalSocket(this))
  {
      setWindowFlags(windowFlags() & ~Qt::WindowContextHelpButtonHint);
      QLabel *hostLabel = new QLabel(tr("&Server name:"));
      hostLabel->setBuddy(hostLineEdit);

      statusLabel->setWordWrap(true);

      getFortuneButton->setDefault(true);
      QPushButton *quitButton = new QPushButton(tr("Quit"));

      QDialogButtonBox *buttonBox = new QDialogButtonBox;
      buttonBox->addButton(getFortuneButton, QDialogButtonBox::ActionRole);
      buttonBox->addButton(quitButton, QDialogButtonBox::RejectRole);

      in.setDevice(socket);
      in.setVersion(QDataStream::Qt_5_10);

      connect(hostLineEdit, &QLineEdit::textChanged,
              this, &Client::enableGetFortuneButton);
      connect(getFortuneButton, &QPushButton::clicked,
              this, &Client::requestNewFortune);
      connect(quitButton, &QPushButton::clicked, this, &Client::close);
      connect(socket, &QLocalSocket::readyRead, this, &Client::readFortune);
      connect(socket, QOverload<QLocalSocket::LocalSocketError>::of(&QLocalSocket::error),
              this, &Client::displayError);

      QGridLayout *mainLayout = new QGridLayout(this);
      mainLayout->addWidget(hostLabel, 0, 0);
      mainLayout->addWidget(hostLineEdit, 0, 1);
      mainLayout->addWidget(statusLabel, 2, 0, 1, 2);
      mainLayout->addWidget(buttonBox, 3, 0, 1, 2);

      setWindowTitle(QGuiApplication::applicationDisplayName());
      hostLineEdit->setFocus();
  }

  void Client::requestNewFortune()
  {
      getFortuneButton->setEnabled(false);
      blockSize = 0;
      socket->abort();
      socket->connectToServer(hostLineEdit->text());
  }

  void Client::readFortune()
  {
      if (blockSize == 0) {
          // Relies on the fact that QDataStream serializes a quint32 into
          // sizeof(quint32) bytes
          if (socket->bytesAvailable() < (int)sizeof(quint32))
              return;
          in >> blockSize;
      }

      if (socket->bytesAvailable() < blockSize || in.atEnd())
          return;

      QString nextFortune;
      in >> nextFortune;

      if (nextFortune == currentFortune) {
          QTimer::singleShot(0, this, &Client::requestNewFortune);
          return;
      }

      currentFortune = nextFortune;
      statusLabel->setText(currentFortune);
      getFortuneButton->setEnabled(true);
  }

  void Client::displayError(QLocalSocket::LocalSocketError socketError)
  {
      switch (socketError) {
      case QLocalSocket::ServerNotFoundError:
          QMessageBox::information(this, tr("Local Fortune Client"),
                                   tr("The host was not found. Please make sure "
                                      "that the server is running and that the "
                                      "server name is correct."));
          break;
      case QLocalSocket::ConnectionRefusedError:
          QMessageBox::information(this, tr("Local Fortune Client"),
                                   tr("The connection was refused by the peer. "
                                      "Make sure the fortune server is running, "
                                      "and check that the server name "
                                      "is correct."));
          break;
      case QLocalSocket::PeerClosedError:
          break;
      default:
          QMessageBox::information(this, tr("Local Fortune Client"),
                                   tr("The following error occurred: %1.")
                                   .arg(socket->errorString()));
      }

      getFortuneButton->setEnabled(true);
  }

  void Client::enableGetFortuneButton()
  {
      getFortuneButton->setEnabled(!hostLineEdit->text().isEmpty());
  }