Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QNetworkInformationBackend Class Referenceabstract

QNetworkInformationBackend provides the interface with which QNetworkInformation does all of its actual work. More...

#include <qnetworkinformation_p.h>

+ Inheritance diagram for QNetworkInformationBackend:
+ Collaboration diagram for QNetworkInformationBackend:

Signals

void reachabilityChanged (Reachability reachability)
 You should not emit this signal manually, call setReachability() instead which will emit this signal when the value changes.
 
void behindCaptivePortalChanged (bool behindPortal)
 
void transportMediumChanged (TransportMedium medium)
 
void isMeteredChanged (bool isMetered)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QNetworkInformationBackend ()=default
 
 ~QNetworkInformationBackend () override
 
virtual QString name () const =0
 Backend name, return the same in QNetworkInformationBackendFactory::name().
 
virtual QNetworkInformation::Features featuresSupported () const =0
 Features supported, return the same in QNetworkInformationBackendFactory::featuresSupported().
 
Reachability reachability () const
 
bool behindCaptivePortal () const
 
TransportMedium transportMedium () const
 
bool isMetered () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Static Public Attributes

static const char16_t PluginNames [4][22]
 
static constexpr int PluginNamesWindowsIndex = 0
 
static constexpr int PluginNamesAppleIndex = 1
 
static constexpr int PluginNamesAndroidIndex = 2
 
static constexpr int PluginNamesLinuxIndex = 3
 

Protected Member Functions

void setReachability (QNetworkInformation::Reachability reachability)
 Call this when reachability has changed.
 
void setBehindCaptivePortal (bool behindPortal)
 
void setTransportMedium (TransportMedium medium)
 
void setMetered (bool isMetered)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Friends

class QNetworkInformation
 
class QNetworkInformationPrivate
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

QNetworkInformationBackend provides the interface with which QNetworkInformation does all of its actual work.

(Semi-private)

Deriving from and implementing this class makes it a candidate for use with QNetworkInformation. The derived class must, on updates, call setters in the QNetworkInformationBackend which will update the values and emit signals if the value has changed.

See also
QNetworkInformationBackendFactory

Definition at line 27 of file qnetworkinformation_p.h.

Constructor & Destructor Documentation

◆ QNetworkInformationBackend()

QNetworkInformationBackend::QNetworkInformationBackend ( )
default

◆ ~QNetworkInformationBackend()

QNetworkInformationBackend::~QNetworkInformationBackend ( )
overridedefault

Destroys base backend class.

Member Function Documentation

◆ behindCaptivePortal()

bool QNetworkInformationBackend::behindCaptivePortal ( ) const
inline

Definition at line 58 of file qnetworkinformation_p.h.

◆ behindCaptivePortalChanged

void QNetworkInformationBackend::behindCaptivePortalChanged ( bool behindPortal)
signal

◆ featuresSupported()

QNetworkInformation::Features QNetworkInformationBackend::featuresSupported ( ) const
pure virtual

Features supported, return the same in QNetworkInformationBackendFactory::featuresSupported().

Implemented in QNetworkInformationDummyBackend, QAndroidNetworkInformationBackend, QGlibNetworkInformationBackend, QNetworkListManagerNetworkInformationBackend, QNetworkManagerNetworkInformationBackend, and QSCNetworkReachabilityNetworkInformationBackend.

Referenced by QNetworkInformation::supports().

+ Here is the caller graph for this function:

◆ isMetered()

bool QNetworkInformationBackend::isMetered ( ) const
inline

Definition at line 70 of file qnetworkinformation_p.h.

◆ isMeteredChanged

void QNetworkInformationBackend::isMeteredChanged ( bool isMetered)
signal

◆ name()

◆ reachability()

Reachability QNetworkInformationBackend::reachability ( ) const
inline

Definition at line 52 of file qnetworkinformation_p.h.

◆ reachabilityChanged

void QNetworkInformationBackend::reachabilityChanged ( Reachability reachability)
signal

You should not emit this signal manually, call setReachability() instead which will emit this signal when the value changes.

See also
setReachability

◆ setBehindCaptivePortal()

void QNetworkInformationBackend::setBehindCaptivePortal ( bool behindPortal)
inlineprotected

Definition at line 93 of file qnetworkinformation_p.h.

References emit.

Referenced by QAndroidNetworkInformationBackend::QAndroidNetworkInformationBackend(), and QNetworkManagerNetworkInformationBackend::onConnectivityChanged().

+ Here is the caller graph for this function:

◆ setMetered()

void QNetworkInformationBackend::setMetered ( bool isMetered)
inlineprotected

Definition at line 113 of file qnetworkinformation_p.h.

References emit.

Referenced by QAndroidNetworkInformationBackend::QAndroidNetworkInformationBackend(), QNetworkListManagerNetworkInformationBackend::QNetworkListManagerNetworkInformationBackend(), and QNetworkManagerNetworkInformationBackend::onMeteredChanged().

+ Here is the caller graph for this function:

◆ setReachability()

void QNetworkInformationBackend::setReachability ( QNetworkInformation::Reachability reachability)
inlineprotected

Call this when reachability has changed.

It will automatically emit reachabilityChanged().

See also
setReachability

Definition at line 83 of file qnetworkinformation_p.h.

References emit.

Referenced by QAndroidNetworkInformationBackend::QAndroidNetworkInformationBackend(), and QNetworkManagerNetworkInformationBackend::onStateChanged().

+ Here is the caller graph for this function:

◆ setTransportMedium()

void QNetworkInformationBackend::setTransportMedium ( TransportMedium medium)
inlineprotected

Definition at line 103 of file qnetworkinformation_p.h.

References emit, and transportMediumChanged().

Referenced by QNetworkListManagerNetworkInformationBackend::QNetworkListManagerNetworkInformationBackend(), and QNetworkManagerNetworkInformationBackend::onDeviceTypeChanged().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ transportMedium()

TransportMedium QNetworkInformationBackend::transportMedium ( ) const
inline

Definition at line 64 of file qnetworkinformation_p.h.

◆ transportMediumChanged

void QNetworkInformationBackend::transportMediumChanged ( TransportMedium medium)
signal

Friends And Related Symbol Documentation

◆ QNetworkInformation

friend class QNetworkInformation
friend

Definition at line 131 of file qnetworkinformation_p.h.

◆ QNetworkInformationPrivate

friend class QNetworkInformationPrivate
friend

Definition at line 132 of file qnetworkinformation_p.h.

Member Data Documentation

◆ PluginNames

const char16_t QNetworkInformationBackend::PluginNames[4][22]
inlinestatic
Initial value:
= {
{ u"networklistmanager" },
{ u"scnetworkreachability" },
{ u"android" },
{ u"networkmanager" },
}

Definition at line 35 of file qnetworkinformation_p.h.

Referenced by backendName(), backendName(), backendName(), backendName(), and QNetworkInformation::loadDefaultBackend().

◆ PluginNamesAndroidIndex

constexpr int QNetworkInformationBackend::PluginNamesAndroidIndex = 2
staticconstexpr

Definition at line 43 of file qnetworkinformation_p.h.

Referenced by backendName(), and QNetworkInformation::loadDefaultBackend().

◆ PluginNamesAppleIndex

constexpr int QNetworkInformationBackend::PluginNamesAppleIndex = 1
staticconstexpr

Definition at line 42 of file qnetworkinformation_p.h.

Referenced by backendName(), and QNetworkInformation::loadDefaultBackend().

◆ PluginNamesLinuxIndex

constexpr int QNetworkInformationBackend::PluginNamesLinuxIndex = 3
staticconstexpr

Definition at line 44 of file qnetworkinformation_p.h.

Referenced by backendName(), and QNetworkInformation::loadDefaultBackend().

◆ PluginNamesWindowsIndex

constexpr int QNetworkInformationBackend::PluginNamesWindowsIndex = 0
staticconstexpr

Definition at line 41 of file qnetworkinformation_p.h.

Referenced by backendName(), and QNetworkInformation::loadDefaultBackend().


The documentation for this class was generated from the following files: