summaryrefslogtreecommitdiffstats
path: root/src/jsonstream/qjsonclient.cpp
blob: 3ed44ced8cc1b9f289703e1b6d93b2fd1774a9bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtAddOn.JsonStream module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qjsonclient.h"
#include "qjsonstream.h"

#include <QLocalSocket>
#include <QTcpSocket>
#include <QCoreApplication>
#include <QFile>
#include <QtCore/qmetaobject.h>

QT_BEGIN_NAMESPACE_JSONSTREAM

/****************************************************************************/

class QJsonClientPrivate
{
public:
    QJsonClientPrivate()
        : mStream(0) {}

    QJsonClientPrivate(const QJsonObject& message)
        : mRegistrationMessage(message)
        , mStream(0) {}

    QJsonObject  mRegistrationMessage;
    QJsonStream   mStream;
};

/****************************************************************************/

/*!
    \class QJsonClient
    \brief The QJsonClient class is used to send jsons to the QJsonServer.

    Note: The QJsonClient is not thread safe.
*/

/*!
  Construct a new QJsonClient instance with \a registration token and optional \a parent.
  The token will be passed in \c{{"token": registration}}.  This constructor
  is designed to work with QJsonTokenAuthority.
 */
QJsonClient::QJsonClient(const QString& registration, QObject* parent)
    : QObject(parent),
      d_ptr(new QJsonClientPrivate())
{
    Q_D(QJsonClient);
    d->mRegistrationMessage.insert(QStringLiteral("token"), registration);
}

/*!
  Construct a new QJsonClient instance with registration \a message and optional \a parent.
 */
QJsonClient::QJsonClient(const QJsonObject& message, QObject *parent)
    : QObject(parent),
      d_ptr(new QJsonClientPrivate(message))
{
}

/*!
  Construct a new QJsonClient instance with an optional \a parent.
 */
QJsonClient::QJsonClient(QObject *parent)
    : QObject(parent),
      d_ptr(new QJsonClientPrivate())
{
}

/*!
  Destroy the QJsonClient and shut down any active stream.
 */
QJsonClient::~QJsonClient()
{
    // Variant streams don't own the socket
    Q_D(QJsonClient);
    QIODevice *device = d->mStream.device();
    d->mStream.setDevice(0);
    if (device)
        delete device;
}

/*!
  Connect to the QJsonServer over a TCP socket at \a hostname and \a port. Send the initial registration message.
  Return true if the connection is successful.
*/

bool QJsonClient::connectTCP(const QString& hostname, int port)
{
    QTcpSocket *socket = new QTcpSocket(this);
    socket->connectToHost(hostname, port);

    if (socket->waitForConnected()) {
        connect(socket, SIGNAL(disconnected()), SLOT(handleSocketDisconnected()));
        Q_D(QJsonClient);
        d->mStream.setDevice(socket);
        connect(&d->mStream, SIGNAL(readyReadMessage()), this, SLOT(processMessages()));

        return d->mStream.send(d->mRegistrationMessage);
    }

    return false;
}

/*!
  Connect to the QJsonServer over a Unix local socket to \a socketname and send the initial registration message.
  Return true if the connection is successful.
 */
bool QJsonClient::connectLocal(const QString& socketname)
{
    if (!QFile::exists(socketname)) {
        qWarning() << Q_FUNC_INFO << "socket does not exist";
        return false;
    }

    QLocalSocket *socket = new QLocalSocket(this);
    socket->setReadBufferSize(64*1024);
    socket->connectToServer(socketname);

    if (socket->waitForConnected()) {
        connect(socket, SIGNAL(disconnected()), SLOT(handleSocketDisconnected()));
        Q_D(QJsonClient);
        d->mStream.setDevice(socket);
        connect(&d->mStream, SIGNAL(readyReadMessage()), this, SLOT(processMessages()));
        // qDebug() << "Sending local socket registration message" << mRegistrationMessage;
        return d->mStream.send(d->mRegistrationMessage);
    }
    delete socket;
    return false;
}

/*!
  Send a \a message over the socket.
  Returns true if the entire message was send/buffered or false otherwise.
*/

bool QJsonClient::send(const QJsonObject &message)
{
    bool ret = false;
    Q_D(QJsonClient);
    if (d->mStream.isOpen()) {
        ret = d->mStream.send(message);
    } else {
        qCritical() << Q_FUNC_INFO << "stream socket is not available";
    }
    return ret;
}

/*!
  Set the current stream encoding \a format.
  This controls how messages will be sent
*/

void QJsonClient::setFormat( EncodingFormat format )
{
    Q_D(QJsonClient);
    d->mStream.setFormat(format);
}

/*!
  \internal
*/
void QJsonClient::handleSocketDisconnected()
{
    Q_D(QJsonClient);
    QIODevice *device = d->mStream.device();
    if (!device)
        return;

    d->mStream.setDevice(0);
    device->deleteLater();
    emit disconnected();
}


/*!
  \internal
*/
void QJsonClient::processMessages()
{
    Q_D(QJsonClient);
    while (d->mStream.messageAvailable()) {
        QJsonObject obj = d->mStream.readMessage();
        if (!obj.isEmpty())
            emit messageReceived(obj);
    }
}

/*!
    \fn void QJsonClient::messageReceived(const QJsonObject &message)
    This signal is emitted when a \a message is received from the server.
*/

/*!
    \fn void QJsonClient::disconnected()
    This signal is emitted when the client socket is disconnected.
*/

#include "moc_qjsonclient.cpp"

QT_END_NAMESPACE_JSONSTREAM