summaryrefslogtreecommitdiffstats
path: root/src/network/kernel/qnetconmonitor_p.h
blob: dd34c3e2889e25b1d133e03046aafae10c088cc3 (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
/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtNetwork module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
******************************************************************************/

#ifndef QNETCONMONITOR_P_H
#define QNETCONMONITOR_P_H

#include <private/qtnetworkglobal_p.h>

#include <QtCore/qloggingcategory.h>
#include <QtNetwork/qhostaddress.h>
#include <QtCore/qglobal.h>
#include <QtCore/qobject.h>

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

QT_BEGIN_NAMESPACE

class QNetworkConnectionMonitorPrivate;
class Q_NETWORK_EXPORT QNetworkConnectionMonitor : public QObject
{
    Q_OBJECT

public:
    QNetworkConnectionMonitor();
    QNetworkConnectionMonitor(const QHostAddress &local, const QHostAddress &remote = {});
    ~QNetworkConnectionMonitor();

    bool setTargets(const QHostAddress &local, const QHostAddress &remote);
    bool isReachable();

    // Important: on Darwin you should not call isReachable() after
    // startMonitoring(), you have to listen to reachabilityChanged()
    // signal instead.
    bool startMonitoring();
    bool isMonitoring() const;
    void stopMonitoring();

    static bool isEnabled();

Q_SIGNALS:
    // Important: connect to this using QueuedConnection. On Darwin
    // callback is coming on a special dispatch queue.
    void reachabilityChanged(bool isOnline);

private:
    Q_DECLARE_PRIVATE(QNetworkConnectionMonitor)
    Q_DISABLE_COPY_MOVE(QNetworkConnectionMonitor)
};

Q_DECLARE_LOGGING_CATEGORY(lcNetMon)

QT_END_NAMESPACE

#endif // QNETCONMONITOR_P_H