cxSocketConnection.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.
                 
Copyright (c) SINTEF Department of Medical Technology.
All rights reserved.
                 
CustusX is released under a BSD 3-Clause license.
                 
See Lisence.txt (https://github.com/SINTEFMedtek/CustusX/blob/master/License.txt) for details.
=========================================================================*/

#ifndef CXSOCKETCONNECTION_H
#define CXSOCKETCONNECTION_H

#include <QPointer>
#include <QTcpServer>
#include <QMutex>
#include "cxEnumConverter.h"
#include "boost/shared_ptr.hpp"

namespace cx {
enum CX_SOCKETCONNECTION_STATE
{
    scsINACTIVE,
    scsCONNECTED,
    scsLISTENING,
    scsCONNECTING,
    scsCOUNT
};
} // namespace cx

SNW_DECLARE_ENUM_STRING_CONVERTERS(cxResource_EXPORT, cx, CX_SOCKETCONNECTION_STATE);

#define assertRunningInObjectThread() \
{ \
    if (QThread::currentThread()!=this->thread()) \
    { \
        CX_LOG_ERROR() \
            << QString("Method should be called in the object's thread [%1] only, current thread = [%2]") \
            .arg(this->thread()->objectName()) \
            .arg(QThread::currentThread()->objectName()); \
    }           \
} \



namespace cx {

typedef boost::shared_ptr<class SocketConnector> SocketConnectorPtr;

class cxResource_EXPORT SocketConnection : public QObject
{
    Q_OBJECT
public:
    explicit SocketConnection(QObject *parent = 0);

    struct cxResource_EXPORT ConnectionInfo
    {
        QString role;
        QString protocol;
        QString host;
        int port;

        bool operator==(const ConnectionInfo& rhs) const;
        bool isServer() const;
        bool isClient() const;
        bool isLocalhostConnection() const;
        QString getDescription() const;
    };

    ConnectionInfo getConnectionInfo(); 
    CX_SOCKETCONNECTION_STATE getState(); 
    virtual void setConnectionInfo(ConnectionInfo info); 

    virtual void requestConnect(); 
    virtual void requestDisconnect(); 

public slots:
    bool sendData(const char* data, qint64 maxSize); 

signals:
    void connectionInfoChanged();
    void stateChanged(CX_SOCKETCONNECTION_STATE status);
    void connected();
    void disconnected();
    void error();

private slots:
    void internalConnected();
    void internalDisconnected();
    void internalError(QAbstractSocket::SocketError socketError);
    virtual void internalDataAvailable() = 0;

protected:
    virtual void setProtocol(QString protocolname) = 0;
    SocketConnectorPtr createConnector(ConnectionInfo info);
    bool socketIsConnected();
    bool enoughBytesAvailableOnSocket(int bytes) const;
    bool socketReceive(void *packPointer, int packSize) const;
    QStringList getAllServerHostnames();
    void setCurrentConnectionInfo();
    void stateChange(CX_SOCKETCONNECTION_STATE newState);
    CX_SOCKETCONNECTION_STATE computeState();

    QTcpSocket* mSocket;

    CX_SOCKETCONNECTION_STATE mCurrentState;
    QMutex mNextConnectionInfoMutex;
    ConnectionInfo mNextConnectionInfo; 

protected:
    SocketConnectorPtr mConnector;
};

} //namespace cx

#endif // CXSOCKETCONNECTION_H