Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QHttpSocketEngine Class Reference

#include <qhttpsocketengine_p.h>

Inheritance diagram for QHttpSocketEngine:
Collaboration diagram for QHttpSocketEngine:

Public Types

enum  HttpState {
  None , ConnectSent , Connected , SendAuthentication ,
  ReadResponseContent , ReadResponseHeader
}
Public Types inherited from QAbstractSocketEngine
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 slotSocketConnected ()
void slotSocketDisconnected ()
void slotSocketReadNotification ()
void slotSocketBytesWritten ()
void slotSocketError (QAbstractSocket::SocketError error)
void slotSocketStateChanged (QAbstractSocket::SocketState state)
Public Slots inherited from QAbstractSocketEngine
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

 QHttpSocketEngine (QObject *parent=nullptr)
 ~QHttpSocketEngine ()
bool initialize (QAbstractSocket::SocketType type, QAbstractSocket::NetworkLayerProtocol protocol=QAbstractSocket::IPv4Protocol) override
bool initialize (qintptr socketDescriptor, QAbstractSocket::SocketState socketState=QAbstractSocket::ConnectedState) override
void setProxy (const QNetworkProxy &networkProxy)
qintptr socketDescriptor () const override
bool isValid () const override
bool connectInternal ()
bool connectToHost (const QHostAddress &address, quint16 port) override
bool connectToHostByName (const QString &name, quint16 port) override
bool bind (const QHostAddress &address, quint16 port) override
bool listen (int backlog) override
qintptr accept () override
void close () override
qint64 bytesAvailable () const override
qint64 read (char *data, qint64 maxlen) override
qint64 write (const char *data, qint64 len) override
bool joinMulticastGroup (const QHostAddress &groupAddress, const QNetworkInterface &iface) override
bool leaveMulticastGroup (const QHostAddress &groupAddress, const QNetworkInterface &iface) override
QNetworkInterface multicastInterface () const override
bool setMulticastInterface (const QNetworkInterface &iface) override
bool hasPendingDatagrams () const override
qint64 pendingDatagramSize () const override
qint64 readDatagram (char *data, qint64 maxlen, QIpPacketHeader *, PacketHeaderOptions) override
qint64 writeDatagram (const char *data, qint64 len, const QIpPacketHeader &) override
qint64 bytesToWrite () const override
int option (SocketOption option) const override
bool setOption (SocketOption option, int value) override
bool waitForRead (QDeadlineTimer deadline=QDeadlineTimer{DefaultTimeout}, bool *timedOut=nullptr) override
bool waitForWrite (QDeadlineTimer deadline=QDeadlineTimer{DefaultTimeout}, bool *timedOut=nullptr) override
bool waitForReadOrWrite (bool *readyToRead, bool *readyToWrite, bool checkRead, bool checkWrite, QDeadlineTimer deadline=QDeadlineTimer{DefaultTimeout}, bool *timedOut=nullptr) override
void waitForProtocolHandshake (QDeadlineTimer deadline) const
bool isReadNotificationEnabled () const override
void setReadNotificationEnabled (bool enable) override
bool isWriteNotificationEnabled () const override
void setWriteNotificationEnabled (bool enable) override
bool isExceptionNotificationEnabled () const override
void setExceptionNotificationEnabled (bool enable) override
Public Member Functions inherited from QAbstractSocketEngine
 QAbstractSocketEngine (QObject *parent=nullptr)
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
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< 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 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).
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.

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.
Static Public Member Functions inherited from QAbstractSocketEngine
static QAbstractSocketEnginecreateSocketEngine (QAbstractSocket::SocketType socketType, const QNetworkProxy &, QObject *parent)
static QAbstractSocketEnginecreateSocketEngine (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 inherited from QAbstractSocketEngine
 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
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)
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 37 of file qhttpsocketengine_p.h.

Member Enumeration Documentation

◆ HttpState

Enumerator
None 
ConnectSent 
Connected 
SendAuthentication 
ReadResponseContent 
ReadResponseHeader 

Definition at line 41 of file qhttpsocketengine_p.h.

Constructor & Destructor Documentation

◆ QHttpSocketEngine()

QHttpSocketEngine::QHttpSocketEngine ( QObject * parent = nullptr)

Definition at line 23 of file qhttpsocketengine.cpp.

◆ ~QHttpSocketEngine()

QHttpSocketEngine::~QHttpSocketEngine ( )

Definition at line 28 of file qhttpsocketengine.cpp.

Member Function Documentation

◆ accept()

qintptr QHttpSocketEngine::accept ( )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 168 of file qhttpsocketengine.cpp.

◆ bind()

bool QHttpSocketEngine::bind ( const QHostAddress & address,
quint16 port )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 153 of file qhttpsocketengine.cpp.

◆ bytesAvailable()

qint64 QHttpSocketEngine::bytesAvailable ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 185 of file qhttpsocketengine.cpp.

◆ bytesToWrite()

qint64 QHttpSocketEngine::bytesToWrite ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 277 of file qhttpsocketengine.cpp.

◆ close()

void QHttpSocketEngine::close ( )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 175 of file qhttpsocketengine.cpp.

◆ connectInternal()

bool QHttpSocketEngine::connectInternal ( )

Definition at line 99 of file qhttpsocketengine.cpp.

◆ connectToHost()

bool QHttpSocketEngine::connectToHost ( const QHostAddress & address,
quint16 port )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 131 of file qhttpsocketengine.cpp.

◆ connectToHostByName()

bool QHttpSocketEngine::connectToHostByName ( const QString & name,
quint16 port )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 142 of file qhttpsocketengine.cpp.

◆ hasPendingDatagrams()

bool QHttpSocketEngine::hasPendingDatagrams ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 250 of file qhttpsocketengine.cpp.

◆ initialize() [1/2]

bool QHttpSocketEngine::initialize ( QAbstractSocket::SocketType type,
QAbstractSocket::NetworkLayerProtocol protocol = QAbstractSocket::IPv4Protocol )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 32 of file qhttpsocketengine.cpp.

◆ initialize() [2/2]

bool QHttpSocketEngine::initialize ( qintptr socketDescriptor,
QAbstractSocket::SocketState socketState = QAbstractSocket::ConnectedState )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 70 of file qhttpsocketengine.cpp.

◆ isExceptionNotificationEnabled()

bool QHttpSocketEngine::isExceptionNotificationEnabled ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 443 of file qhttpsocketengine.cpp.

◆ isReadNotificationEnabled()

bool QHttpSocketEngine::isReadNotificationEnabled ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 406 of file qhttpsocketengine.cpp.

◆ isValid()

bool QHttpSocketEngine::isValid ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 93 of file qhttpsocketengine.cpp.

◆ isWriteNotificationEnabled()

bool QHttpSocketEngine::isWriteNotificationEnabled ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 429 of file qhttpsocketengine.cpp.

◆ joinMulticastGroup()

bool QHttpSocketEngine::joinMulticastGroup ( const QHostAddress & groupAddress,
const QNetworkInterface & iface )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 221 of file qhttpsocketengine.cpp.

◆ leaveMulticastGroup()

bool QHttpSocketEngine::leaveMulticastGroup ( const QHostAddress & groupAddress,
const QNetworkInterface & iface )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 229 of file qhttpsocketengine.cpp.

◆ listen()

bool QHttpSocketEngine::listen ( int backlog)
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 160 of file qhttpsocketengine.cpp.

◆ multicastInterface()

QNetworkInterface QHttpSocketEngine::multicastInterface ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 237 of file qhttpsocketengine.cpp.

◆ option()

int QHttpSocketEngine::option ( SocketOption option) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 287 of file qhttpsocketengine.cpp.

◆ pendingDatagramSize()

qint64 QHttpSocketEngine::pendingDatagramSize ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 256 of file qhttpsocketengine.cpp.

◆ read()

qint64 QHttpSocketEngine::read ( char * data,
qint64 maxlen )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 191 of file qhttpsocketengine.cpp.

◆ readDatagram()

qint64 QHttpSocketEngine::readDatagram ( char * data,
qint64 maxlen,
QIpPacketHeader * ,
PacketHeaderOptions  )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 263 of file qhttpsocketengine.cpp.

◆ setExceptionNotificationEnabled()

void QHttpSocketEngine::setExceptionNotificationEnabled ( bool enable)
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 449 of file qhttpsocketengine.cpp.

◆ setMulticastInterface()

bool QHttpSocketEngine::setMulticastInterface ( const QNetworkInterface & iface)
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 242 of file qhttpsocketengine.cpp.

◆ setOption()

bool QHttpSocketEngine::setOption ( SocketOption option,
int value )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 300 of file qhttpsocketengine.cpp.

◆ setProxy()

void QHttpSocketEngine::setProxy ( const QNetworkProxy & networkProxy)

Definition at line 75 of file qhttpsocketengine.cpp.

◆ setReadNotificationEnabled()

void QHttpSocketEngine::setReadNotificationEnabled ( bool enable)
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 412 of file qhttpsocketengine.cpp.

◆ setWriteNotificationEnabled()

void QHttpSocketEngine::setWriteNotificationEnabled ( bool enable)
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 435 of file qhttpsocketengine.cpp.

◆ slotSocketBytesWritten

void QHttpSocketEngine::slotSocketBytesWritten ( )
slot

Definition at line 694 of file qhttpsocketengine.cpp.

◆ slotSocketConnected

void QHttpSocketEngine::slotSocketConnected ( )
slot

Definition at line 455 of file qhttpsocketengine.cpp.

◆ slotSocketDisconnected

void QHttpSocketEngine::slotSocketDisconnected ( )
slot

Definition at line 494 of file qhttpsocketengine.cpp.

◆ slotSocketError

void QHttpSocketEngine::slotSocketError ( QAbstractSocket::SocketError error)
slot

Definition at line 701 of file qhttpsocketengine.cpp.

◆ slotSocketReadNotification

void QHttpSocketEngine::slotSocketReadNotification ( )
slot

Definition at line 498 of file qhttpsocketengine.cpp.

◆ slotSocketStateChanged

void QHttpSocketEngine::slotSocketStateChanged ( QAbstractSocket::SocketState state)
slot

Definition at line 733 of file qhttpsocketengine.cpp.

◆ socketDescriptor()

qintptr QHttpSocketEngine::socketDescriptor ( ) const
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 87 of file qhttpsocketengine.cpp.

◆ waitForProtocolHandshake()

void QHttpSocketEngine::waitForProtocolHandshake ( QDeadlineTimer deadline) const

Definition at line 394 of file qhttpsocketengine.cpp.

◆ waitForRead()

bool QHttpSocketEngine::waitForRead ( QDeadlineTimer deadline = QDeadlineTimer{DefaultTimeout},
bool * timedOut = nullptr )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 314 of file qhttpsocketengine.cpp.

◆ waitForReadOrWrite()

bool QHttpSocketEngine::waitForReadOrWrite ( bool * readyToRead,
bool * readyToWrite,
bool checkRead,
bool checkWrite,
QDeadlineTimer deadline = QDeadlineTimer{DefaultTimeout},
bool * timedOut = nullptr )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 373 of file qhttpsocketengine.cpp.

◆ waitForWrite()

bool QHttpSocketEngine::waitForWrite ( QDeadlineTimer deadline = QDeadlineTimer{DefaultTimeout},
bool * timedOut = nullptr )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 345 of file qhttpsocketengine.cpp.

◆ write()

qint64 QHttpSocketEngine::write ( const char * data,
qint64 len )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 213 of file qhttpsocketengine.cpp.

◆ writeDatagram()

qint64 QHttpSocketEngine::writeDatagram ( const char * data,
qint64 len,
const QIpPacketHeader &  )
overridevirtual

Implements QAbstractSocketEngine.

Definition at line 270 of file qhttpsocketengine.cpp.


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