![]() |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include <qabstractsocketengine_p.h>
Public Types | |
enum | SocketOption { NonBlockingSocketOption , BroadcastSocketOption , ReceiveBufferSocketOption , SendBufferSocketOption , AddressReusable , BindExclusively , ReceiveOutOfBandData , LowDelayOption , KeepAliveOption , MulticastTtlOption , MulticastLoopbackOption , TypeOfServiceOption , ReceivePacketInformation , ReceiveHopLimit , MaxStreamsSocketOption , PathMtuInformation , BindInterfaceIndex } |
enum | PacketHeaderOption { WantNone = 0 , WantDatagramSender = 0x01 , WantDatagramDestination = 0x02 , WantDatagramHopLimit = 0x04 , WantStreamNumber = 0x08 , WantEndOfRecord = 0x10 , WantAll = 0xff } |
Specifies which fields in the IP packet header are desired in the call to readDatagram(). More... |
Public Slots | |
void | readNotification () |
void | writeNotification () |
void | closeNotification () |
void | exceptionNotification () |
void | connectionNotification () |
void | proxyAuthenticationRequired (const QNetworkProxy &proxy, QAuthenticator *authenticator) |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe |
Public Member Functions | |
QAbstractSocketEngine (QObject *parent=nullptr) | |
virtual bool | initialize (QAbstractSocket::SocketType type, QAbstractSocket::NetworkLayerProtocol protocol=QAbstractSocket::IPv4Protocol)=0 |
virtual bool | initialize (qintptr socketDescriptor, QAbstractSocket::SocketState socketState=QAbstractSocket::ConnectedState)=0 |
virtual qintptr | socketDescriptor () const =0 |
virtual bool | isValid () const =0 |
virtual bool | connectToHost (const QHostAddress &address, quint16 port)=0 |
virtual bool | connectToHostByName (const QString &name, quint16 port)=0 |
virtual bool | bind (const QHostAddress &address, quint16 port)=0 |
virtual bool | listen (int backlog)=0 |
virtual qintptr | accept ()=0 |
virtual void | close ()=0 |
virtual qint64 | bytesAvailable () const =0 |
virtual qint64 | read (char *data, qint64 maxlen)=0 |
virtual qint64 | write (const char *data, qint64 len)=0 |
virtual bool | joinMulticastGroup (const QHostAddress &groupAddress, const QNetworkInterface &iface)=0 |
virtual bool | leaveMulticastGroup (const QHostAddress &groupAddress, const QNetworkInterface &iface)=0 |
virtual QNetworkInterface | multicastInterface () const =0 |
virtual bool | setMulticastInterface (const QNetworkInterface &iface)=0 |
virtual bool | hasPendingDatagrams () const =0 |
virtual qint64 | pendingDatagramSize () const =0 |
virtual qint64 | readDatagram (char *data, qint64 maxlen, QIpPacketHeader *header=nullptr, PacketHeaderOptions=WantNone)=0 |
virtual qint64 | writeDatagram (const char *data, qint64 len, const QIpPacketHeader &header)=0 |
virtual qint64 | bytesToWrite () const =0 |
virtual int | option (SocketOption option) const =0 |
virtual bool | setOption (SocketOption option, int value)=0 |
virtual bool | waitForRead (QDeadlineTimer deadline=QDeadlineTimer{DefaultTimeout}, bool *timedOut=nullptr)=0 |
virtual bool | waitForWrite (QDeadlineTimer deadline=QDeadlineTimer{DefaultTimeout}, bool *timedOut=nullptr)=0 |
virtual bool | waitForReadOrWrite (bool *readyToRead, bool *readyToWrite, bool checkRead, bool checkWrite, QDeadlineTimer deadline=QDeadlineTimer{DefaultTimeout}, bool *timedOut=nullptr)=0 |
QAbstractSocket::SocketError | error () const |
QString | errorString () const |
QAbstractSocket::SocketState | state () const |
QAbstractSocket::SocketType | socketType () const |
QAbstractSocket::NetworkLayerProtocol | protocol () const |
QHostAddress | localAddress () const |
quint16 | localPort () const |
QHostAddress | peerAddress () const |
quint16 | peerPort () const |
int | inboundStreamCount () const |
int | outboundStreamCount () const |
virtual bool | isReadNotificationEnabled () const =0 |
virtual void | setReadNotificationEnabled (bool enable)=0 |
virtual bool | isWriteNotificationEnabled () const =0 |
virtual void | setWriteNotificationEnabled (bool enable)=0 |
virtual bool | isExceptionNotificationEnabled () const =0 |
virtual void | setExceptionNotificationEnabled (bool enable)=0 |
void | setReceiver (QAbstractSocketEngineReceiver *receiver) |
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< QString > | bindableObjectName () |
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 | isQmlObjectType () const |
Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership(). | |
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). | |
QThread * | thread () 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> | |
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> | |
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 QObjectList & | children () 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< QByteArray > | dynamicPropertyNames () const |
QBindingStorage * | bindingStorage () |
const QBindingStorage * | bindingStorage () const |
QObject * | parent () 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 Member Functions | |
static QAbstractSocketEngine * | createSocketEngine (QAbstractSocket::SocketType socketType, const QNetworkProxy &, QObject *parent) |
static QAbstractSocketEngine * | createSocketEngine (qintptr socketDescriptor, QObject *parent) |
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 Member Functions | |
QAbstractSocketEngine (QAbstractSocketEnginePrivate &dd, QObject *parent=nullptr) | |
void | setError (QAbstractSocket::SocketError error, const QString &errorString) const |
void | setState (QAbstractSocket::SocketState state) |
void | setSocketType (QAbstractSocket::SocketType socketType) |
void | setProtocol (QAbstractSocket::NetworkLayerProtocol protocol) |
void | setLocalAddress (const QHostAddress &address) |
void | setLocalPort (quint16 port) |
void | setPeerAddress (const QHostAddress &address) |
void | setPeerPort (quint16 port) |
Protected Member Functions inherited from QObject | |
QObject * | sender () 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) |
Additional Inherited Members | |
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. | |
Protected Attributes inherited from QObject | |
QScopedPointer< QObjectData > | d_ptr |
Properties inherited from QObject | |
QString | objectName |
the name of this object | |
Related Symbols inherited from QObject | |
template< class T > T | qobject_cast (const QObject *object) |
Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
QObjectList | |
\macro Q_CLASSINFO(Name, Value) |
Definition at line 51 of file qabstractsocketengine_p.h.
Specifies which fields in the IP packet header are desired in the call to readDatagram().
\value WantNone caller isn't interested in the packet metadata \value WantDatagramSender caller wants the sender address and port number \value WantDatagramDestination caller wants the packet's destination address and port number (this option is useful to distinguish multicast packets from unicast) \value WantDatagramHopLimit caller wants the packet's remaining hop limit or time to live (this option is useful in IPv4 multicasting, where the TTL is used to indicate the realm) \value WantAll this is a catch-all value to indicate the caller is interested in all the available information
Enumerator | |
---|---|
WantNone | |
WantDatagramSender | |
WantDatagramDestination | |
WantDatagramHopLimit | |
WantStreamNumber | |
WantEndOfRecord | |
WantAll |
Definition at line 82 of file qabstractsocketengine_p.h.
Definition at line 62 of file qabstractsocketengine_p.h.
QAbstractSocketEngine::QAbstractSocketEngine | ( | QObject * | parent = nullptr | ) |
Definition at line 53 of file qabstractsocketengine.cpp.
|
protected |
Definition at line 58 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
slot |
Definition at line 136 of file qabstractsocketengine.cpp.
|
slot |
Definition at line 142 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
static |
Definition at line 63 of file qabstractsocketengine.cpp.
|
static |
Definition at line 86 of file qabstractsocketengine.cpp.
QAbstractSocket::SocketError QAbstractSocketEngine::error | ( | ) | const |
Definition at line 96 of file qabstractsocketengine.cpp.
QString QAbstractSocketEngine::errorString | ( | ) | const |
Definition at line 101 of file qabstractsocketengine.cpp.
|
slot |
Definition at line 130 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
int QAbstractSocketEngine::inboundStreamCount | ( | ) | const |
Definition at line 227 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
QHostAddress QAbstractSocketEngine::localAddress | ( | ) | const |
Definition at line 187 of file qabstractsocketengine.cpp.
quint16 QAbstractSocketEngine::localPort | ( | ) | const |
Definition at line 197 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
int QAbstractSocketEngine::outboundStreamCount | ( | ) | const |
Definition at line 232 of file qabstractsocketengine.cpp.
QHostAddress QAbstractSocketEngine::peerAddress | ( | ) | const |
Definition at line 207 of file qabstractsocketengine.cpp.
quint16 QAbstractSocketEngine::peerPort | ( | ) | const |
Definition at line 217 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
QAbstractSocket::NetworkLayerProtocol QAbstractSocketEngine::protocol | ( | ) | const |
Definition at line 177 of file qabstractsocketengine.cpp.
|
slot |
Definition at line 149 of file qabstractsocketengine.cpp.
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
slot |
Definition at line 118 of file qabstractsocketengine.cpp.
|
protected |
Definition at line 106 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
protected |
Definition at line 192 of file qabstractsocketengine.cpp.
Definition at line 202 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
protected |
Definition at line 212 of file qabstractsocketengine.cpp.
Definition at line 222 of file qabstractsocketengine.cpp.
|
protected |
Definition at line 182 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
void QAbstractSocketEngine::setReceiver | ( | QAbstractSocketEngineReceiver * | receiver | ) |
Definition at line 113 of file qabstractsocketengine.cpp.
|
protected |
Definition at line 172 of file qabstractsocketengine.cpp.
|
protected |
Definition at line 162 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
QAbstractSocket::SocketType QAbstractSocketEngine::socketType | ( | ) | const |
Definition at line 167 of file qabstractsocketengine.cpp.
QAbstractSocket::SocketState QAbstractSocketEngine::state | ( | ) | const |
Definition at line 157 of file qabstractsocketengine.cpp.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
pure virtual |
Implemented in QHttpSocketEngine, QNativeSocketEngine, and QSocks5SocketEngine.
|
slot |
Definition at line 124 of file qabstractsocketengine.cpp.