UDPLink.h 6.64 KB
Newer Older
pixhawk's avatar
pixhawk committed
1 2
/*=====================================================================

pixhawk's avatar
pixhawk committed
3
QGroundControl Open Source Ground Control Station
pixhawk's avatar
pixhawk committed
4

5
(c) 2009 - 2015 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
pixhawk's avatar
pixhawk committed
6

pixhawk's avatar
pixhawk committed
7
This file is part of the QGROUNDCONTROL project
pixhawk's avatar
pixhawk committed
8

pixhawk's avatar
pixhawk committed
9
    QGROUNDCONTROL is free software: you can redistribute it and/or modify
pixhawk's avatar
pixhawk committed
10 11 12 13
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

pixhawk's avatar
pixhawk committed
14
    QGROUNDCONTROL is distributed in the hope that it will be useful,
pixhawk's avatar
pixhawk committed
15 16 17 18 19
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
pixhawk's avatar
pixhawk committed
20
    along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
pixhawk's avatar
pixhawk committed
21 22 23

======================================================================*/

24
/*!
pixhawk's avatar
pixhawk committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38
 * @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>
39 40 41
#include <QMutexLocker>
#include <QQueue>
#include <QByteArray>
42

43 44 45 46
#if defined(QGC_ZEROCONF_ENABLED)
#include <dns_sd.h>
#endif

47
#include "QGCConfig.h"
48 49
#include "LinkManager.h"

50 51
#define QGC_UDP_LOCAL_PORT  14550
#define QGC_UDP_TARGET_PORT 14555
52 53 54

class UDPConfiguration : public LinkConfiguration
{
Don Gagne's avatar
Don Gagne committed
55 56
    Q_OBJECT

57 58
public:

59 60 61
    Q_PROPERTY(quint16      localPort   READ localPort  WRITE setLocalPort  NOTIFY localPortChanged)
    Q_PROPERTY(QStringList  hostList    READ hostList                       NOTIFY  hostListChanged)

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
    /*!
     * @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
     */
117
    Q_INVOKABLE void addHost (const QString host);
118 119 120 121 122 123 124 125 126 127 128 129 130 131

    /*!
     * @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
     */
132
    Q_INVOKABLE void removeHost  (const QString host);
133 134 135 136 137 138 139 140

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

141 142 143 144 145
    /*!
     * @brief QML Interface
     */
    QStringList hostList    () { return _hostList; }

146
    /// From LinkConfiguration
147 148 149 150 151 152
    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"; }
153

154 155 156 157 158 159 160
signals:
    void localPortChanged   ();
    void hostListChanged    ();

private:
    void _updateHostList    ();

161 162 163 164
private:
    QMutex _confMutex;
    QMap<QString, int>::iterator _it;
    QMap<QString, int> _hosts;  ///< ("host", port)
165
    QStringList _hostList;      ///< Exposed to QML
166 167
    quint16 _localPort;
};
pixhawk's avatar
pixhawk committed
168 169 170 171

class UDPLink : public LinkInterface
{
    Q_OBJECT
172

173
    friend class UDPConfiguration;
174
    friend class LinkManager;
175

pixhawk's avatar
pixhawk committed
176
public:
177
    void requestReset() { }
178 179
    bool isConnected() const;
    QString getName() const;
pixhawk's avatar
pixhawk committed
180

181 182 183 184
    // Extensive statistics for scientific purposes
    qint64 getConnectionSpeed() const;
    qint64 getCurrentInDataRate() const;
    qint64 getCurrentOutDataRate() const;
pixhawk's avatar
pixhawk committed
185 186

    void run();
187

188 189 190 191
    // 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
192

193 194
    LinkConfiguration* getLinkConfiguration() { return _config; }

pixhawk's avatar
pixhawk committed
195
public slots:
196 197 198 199 200

    /*! @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
201

202
    void readBytes();
203 204

    /*!
pixhawk's avatar
pixhawk committed
205 206 207 208 209 210 211 212 213
     * @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
     **/
    void writeBytes(const char* data, qint64 length);

protected:

214 215 216
    QUdpSocket*         _socket;
    UDPConfiguration*   _config;
    bool                _connectState;
pixhawk's avatar
pixhawk committed
217

oberion's avatar
oberion committed
218
private:
219 220 221
    // Links are only created/destroyed by LinkManager so constructor/destructor is not public
    UDPLink(UDPConfiguration* config);
    ~UDPLink();
222

223 224
    // From LinkInterface
    virtual bool _connect(void);
Don Gagne's avatar
Don Gagne committed
225
    virtual void _disconnect(void);
226

227 228
    bool _hardwareConnect();
    void _restartConnection();
oberion's avatar
oberion committed
229

230 231
    void _registerZeroconf(uint16_t port, const std::string& regType);
    void _deregisterZeroconf();
Gus Grubba's avatar
Gus Grubba committed
232 233

#if defined(QGC_ZEROCONF_ENABLED)
234 235 236
    DNSServiceRef  _dnssServiceRef;
#endif

237 238 239 240
    bool                _running;
    QMutex              _mutex;
    QQueue<QByteArray*> _outQueue;

241 242
    bool _dequeBytes    ();
    void _sendBytes     (const char* data, qint64 size);
pixhawk's avatar
pixhawk committed
243 244 245 246

};

#endif // UDPLINK_H