UDPLink.h 5.89 KB
Newer Older
1 2 3 4 5 6 7 8
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/
pixhawk's avatar
pixhawk committed
9 10


11
/*!
pixhawk's avatar
pixhawk committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25
 * @file
 *   @brief UDP connection (server) for unmanned vehicles
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */

#ifndef UDPLINK_H
#define UDPLINK_H

#include <QString>
#include <QList>
#include <QMap>
#include <QMutex>
#include <QUdpSocket>
26 27 28
#include <QMutexLocker>
#include <QQueue>
#include <QByteArray>
29

30 31 32 33
#if defined(QGC_ZEROCONF_ENABLED)
#include <dns_sd.h>
#endif

34
#include "QGCConfig.h"
35 36
#include "LinkManager.h"

37 38
#define QGC_UDP_LOCAL_PORT  14550
#define QGC_UDP_TARGET_PORT 14555
39 40 41

class UDPConfiguration : public LinkConfiguration
{
Don Gagne's avatar
Don Gagne committed
42 43
    Q_OBJECT

44 45
public:

46 47 48
    Q_PROPERTY(quint16      localPort   READ localPort  WRITE setLocalPort  NOTIFY localPortChanged)
    Q_PROPERTY(QStringList  hostList    READ hostList                       NOTIFY  hostListChanged)

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
    /*!
     * @brief Regular constructor
     *
     * @param[in] name Configuration (user friendly) name
     */
    UDPConfiguration(const QString& name);

    /*!
     * @brief Copy contructor
     *
     * When manipulating data, you create a copy of the configuration, edit it
     * and then transfer its content to the original (using copyFrom() below). Use this
     * contructor to create an editable copy.
     *
     * @param[in] source Original configuration
     */
    UDPConfiguration(UDPConfiguration* source);

    /*!
     * @brief Begin iteration through the list of target hosts
     *
     * @param[out] host Host name
     * @param[out] port Port number
     * @return Returns false if list is empty
     */
    bool firstHost      (QString& host, int& port);

    /*!
     * @brief Continues iteration through the list of target hosts
     *
     * @param[out] host Host name
     * @param[out] port Port number
     * @return Returns false if reached the end of the list (in which case, both host and port are unchanged)
     */
    bool nextHost       (QString& host, int& port);

    /*!
     * @brief Get the number of target hosts
     *
     * @return Number of hosts in list
     */
    int hostCount       () { return _hosts.count(); }

    /*!
     * @brief The UDP port we bind to
     *
     * @return Port number
     */
    quint16 localPort   () { return _localPort; }

    /*!
     * @brief Add a target host
     *
     * @param[in] host Host name in standard formatt, e.g. localhost:14551 or 192.168.1.1:14551
     */
104
    Q_INVOKABLE void addHost (const QString host);
105 106 107 108 109 110 111 112 113 114 115 116 117 118

    /*!
     * @brief Add a target host
     *
     * @param[in] host Host name, e.g. localhost or 192.168.1.1
     * @param[in] port Port number
     */
    void addHost        (const QString& host, int port);

    /*!
     * @brief Remove a target host from the list
     *
     * @param[in] host Host name, e.g. localhost or 192.168.1.1
     */
119
    Q_INVOKABLE void removeHost  (const QString host);
120 121 122 123 124 125 126 127

    /*!
     * @brief Set the UDP port we bind to
     *
     * @param[in] port Port number
     */
    void setLocalPort   (quint16 port);

128 129 130 131 132
    /*!
     * @brief QML Interface
     */
    QStringList hostList    () { return _hostList; }

133
    /// From LinkConfiguration
134 135 136 137 138 139
    LinkType    type            () { return LinkConfiguration::TypeUdp; }
    void        copyFrom        (LinkConfiguration* source);
    void        loadSettings    (QSettings& settings, const QString& root);
    void        saveSettings    (QSettings& settings, const QString& root);
    void        updateSettings  ();
    QString     settingsURL     () { return "UdpSettings.qml"; }
140

141 142 143 144 145 146 147
signals:
    void localPortChanged   ();
    void hostListChanged    ();

private:
    void _updateHostList    ();

148 149 150 151
private:
    QMutex _confMutex;
    QMap<QString, int>::iterator _it;
    QMap<QString, int> _hosts;  ///< ("host", port)
152
    QStringList _hostList;      ///< Exposed to QML
153 154
    quint16 _localPort;
};
pixhawk's avatar
pixhawk committed
155 156 157 158

class UDPLink : public LinkInterface
{
    Q_OBJECT
159

160
    friend class UDPConfiguration;
161
    friend class LinkManager;
162

pixhawk's avatar
pixhawk committed
163
public:
164
    void requestReset() { }
165 166
    bool isConnected() const;
    QString getName() const;
pixhawk's avatar
pixhawk committed
167

168 169 170 171
    // Extensive statistics for scientific purposes
    qint64 getConnectionSpeed() const;
    qint64 getCurrentInDataRate() const;
    qint64 getCurrentOutDataRate() const;
pixhawk's avatar
pixhawk committed
172 173

    void run();
174

175 176 177 178
    // These are left unimplemented in order to cause linker errors which indicate incorrect usage of
    // connect/disconnect on link directly. All connect/disconnect calls should be made through LinkManager.
    bool connect(void);
    bool disconnect(void);
pixhawk's avatar
pixhawk committed
179

180 181
    LinkConfiguration* getLinkConfiguration() { return _config; }

pixhawk's avatar
pixhawk committed
182
public slots:
183 184 185 186 187

    /*! @brief Add a new host to broadcast messages to */
    void addHost    (const QString& host);
    /*! @brief Remove a host from broadcasting messages to */
    void removeHost (const QString& host);
pixhawk's avatar
pixhawk committed
188

189
    void readBytes();
190

191
private slots:
192
    /*!
pixhawk's avatar
pixhawk committed
193 194 195 196 197
     * @brief Write a number of bytes to the interface.
     *
     * @param data Pointer to the data byte array
     * @param size The size of the bytes array
     **/
198
    void _writeBytes(const QByteArray data);
pixhawk's avatar
pixhawk committed
199 200 201

protected:

202 203 204
    QUdpSocket*         _socket;
    UDPConfiguration*   _config;
    bool                _connectState;
pixhawk's avatar
pixhawk committed
205

oberion's avatar
oberion committed
206
private:
207 208 209
    // Links are only created/destroyed by LinkManager so constructor/destructor is not public
    UDPLink(UDPConfiguration* config);
    ~UDPLink();
210

211 212
    // From LinkInterface
    virtual bool _connect(void);
Don Gagne's avatar
Don Gagne committed
213
    virtual void _disconnect(void);
214

215 216
    bool _hardwareConnect();
    void _restartConnection();
oberion's avatar
oberion committed
217

218 219
    void _registerZeroconf(uint16_t port, const std::string& regType);
    void _deregisterZeroconf();
Gus Grubba's avatar
Gus Grubba committed
220 221

#if defined(QGC_ZEROCONF_ENABLED)
222 223 224
    DNSServiceRef  _dnssServiceRef;
#endif

225
    bool                _running;
pixhawk's avatar
pixhawk committed
226 227 228
};

#endif // UDPLINK_H