connection.h

Go to the documentation of this file.

/* Copyright 2014 - 2015 CyberTech Labs Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. */

#pragma once

#include <QtCore/QObject>
#include <QtCore/QScopedPointer>
#include <QtCore/QTimer>
#include <QtNetwork/QTcpSocket>
#include <QtNetwork/QHostAddress>

#include "declSpec.h"

namespace trikNetwork {

enum class Protocol
{
    messageLength

    , endOfLineSeparator
};

enum class Heartbeat
{
    use

    , dontUse
};

class TRIKNETWORK_EXPORT Connection : public QObject
{
    Q_OBJECT

public:
    explicit Connection(Protocol connectionProtocol, Heartbeat useHeartbeat);

    bool isConnected() const;

    bool isValid() const;

    QHostAddress peerAddress() const;

    int peerPort() const;

    Q_INVOKABLE void init(qintptr socketDescriptor);

    Q_INVOKABLE void send(const QByteArray &data);
signals:
    void disconnected(trikNetwork::Connection *self);

    void connected(trikNetwork::Connection *self);

protected:
    void init(const QHostAddress &ip, int port);

private slots:
    void onReadyRead();

    void onConnect();

    void onDisconnect();

    void onError(QAbstractSocket::SocketError error);

    void keepAlive();

    void onHeartbeatTimeout();

private:
    virtual void processData(const QByteArray &data) = 0;

    void handleIncomingData(const QByteArray &data);

    void connectSlots();

    void processBuffer();

    void doDisconnect();

    void initKeepalive();

    QByteArray mBuffer;

    int mExpectedBytes = 0;

    Protocol mProtocol;

    QScopedPointer<QTimer> mKeepAliveTimer;

    QScopedPointer<QTimer> mHeartbeatTimer;

    bool mDisconnectReported = false;

    bool mUseHeartbeat = false;

    QScopedPointer<QTcpSocket> mSocket;
};

}