The QNativeSocketEngine class provides low level access to a socket. More...

#include <qnativesocketengine_p.h>

Inheritance diagram for QNativeSocketEngine:

Collaboration diagram for QNativeSocketEngine:

Public Slots
void	connectionNotification ()
	If there's a connection activity on the socket, process it.

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
	QNativeSocketEngine (QObject *parent=nullptr)
	Constructs a QNativeSocketEngine.

	~QNativeSocketEngine ()
	Destructs a QNativeSocketEngine.

bool	initialize (QAbstractSocket::SocketType type, QAbstractSocket::NetworkLayerProtocol protocol=QAbstractSocket::IPv4Protocol) override
	Initializes a QNativeSocketEngine by creating a new socket of type socketType and network layer protocol protocol.

bool	initialize (qintptr socketDescriptor, QAbstractSocket::SocketState socketState=QAbstractSocket::ConnectedState) override
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Initializes the socket using socketDescriptor instead of creating a new one.

qintptr	socketDescriptor () const override
	Returns the native socket descriptor.

bool	isValid () const override
	Returns `true` if the socket is valid; otherwise returns `false`.

bool	connectToHost (const QHostAddress &address, quint16 port) override
	Connects to the IP address and port specified by address and port.

bool	connectToHostByName (const QString &name, quint16 port) override
	Connects to the remote host name given by name on port port.

bool	bind (const QHostAddress &address, quint16 port) override
	Binds the socket to the address address and port port.

bool	listen (int backlog) override
	Prepares a TCP server for accepting incoming connections.

qintptr	accept () override
	Accepts a pending connection from the socket, which must be in ListeningState, and returns its socket descriptor.

void	close () override
	Closes the socket.

qint64	bytesAvailable () const override
	Returns the number of bytes that are currently available for reading.

qint64	read (char *data, qint64 maxlen) override
	Reads up to maxSize bytes into data from the socket.

qint64	write (const char *data, qint64 len) override
	Writes a block of size bytes from data to the socket.

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
	Returns `true` if there is at least one datagram pending.

qint64	pendingDatagramSize () const override
	Returns the size of the pending datagram, or -1 if no datagram is pending.

qint64	readDatagram (char data, qint64 maxlen, QIpPacketHeader =nullptr, PacketHeaderOptions=WantNone) override
	Reads up to maxSize bytes of a datagram from the socket, stores it in data and returns the number of bytes read.

qint64	writeDatagram (const char *data, qint64 len, const QIpPacketHeader &) override
	Writes a datagram of size size bytes to the socket from data to the destination contained in header, and returns the number of bytes written, or -1 if an error occurred.

qint64	bytesToWrite () const override

int	option (SocketOption option) const override
	Returns the value of the option socketOption.

bool	setOption (SocketOption option, int value) override
	Sets the option option to the value value.

bool	waitForRead (int msecs=30000, bool *timedOut=nullptr) override
	Waits for msecs milliseconds or until the socket is ready for reading.

bool	waitForWrite (int msecs=30000, bool *timedOut=nullptr) override
	Waits for msecs milliseconds or until the socket is ready for writing.

bool	waitForReadOrWrite (bool readyToRead, bool readyToWrite, bool checkRead, bool checkWrite, int msecs=30000, bool *timedOut=nullptr) override

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)

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 (int msecs=30000, bool *timedOut=nullptr)=0

virtual bool	waitForWrite (int msecs=30000, bool *timedOut=nullptr)=0

virtual bool	waitForReadOrWrite (bool readyToRead, bool readyToWrite, bool checkRead, bool checkWrite, int msecs=30000, 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	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.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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`.

Additional Inherited Members
Public Types inherited from QAbstractSocketEngine
enum	SocketOption { NonBlockingSocketOption , BroadcastSocketOption , ReceiveBufferSocketOption , SendBufferSocketOption , AddressReusable , BindExclusively , ReceiveOutOfBandData , LowDelayOption , KeepAliveOption , MulticastTtlOption , MulticastLoopbackOption , TypeOfServiceOption , ReceivePacketInformation , ReceiveHopLimit , MaxStreamsSocketOption , PathMtuInformation }

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...

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 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 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
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)

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)

Detailed Description

The QNativeSocketEngine class provides low level access to a socket.

\reentrant

\inmodule QtNetwork

QtSocketLayer provides basic socket functionality provided by the operating system. It also keeps track of what state the socket is in, and which errors that occur.

The classes QTcpSocket, QUdpSocket and QTcpServer provide a higher level API, and are in general more useful for the common application.

There are two main ways of initializing the a QNativeSocketEngine; either create a new socket by passing the socket type (TcpSocket or UdpSocket) and network layer protocol (IPv4Protocol or IPv6Protocol) to initialize(), or pass an existing socket descriptor and have QNativeSocketEngine determine the type and protocol itself. The native socket descriptor can later be fetched by calling socketDescriptor(). The socket is made non-blocking, but blocking behavior can still be achieved by calling waitForRead() and waitForWrite(). isValid() can be called to check if the socket has been successfully initialized and is ready to use.

To connect to a host, determine its address and pass this and the port number to connectToHost(). The socket can then be used as a TCP or UDP client. Otherwise; bind(), listen() and accept() are used to have the socket function as a TCP or UDP server. Call close() to close the socket.

bytesAvailable() is called to determine how much data is available for reading. read() and write() are used by both TCP and UDP clients to exchange data with the connected peer. UDP clients can also call hasMoreDatagrams(), nextDatagramSize(), readDatagram(), and writeDatagram().

Call state() to determine the state of the socket, for example, ListeningState or ConnectedState. socketType() tells whether the socket is a TCP socket or a UDP socket, or if the socket type is unknown. protocol() is used to determine the socket's network layer protocol.

localAddress(), localPort() are called to find the address and port that are currently bound to the socket. If the socket is connected, peerAddress() and peerPort() determine the address and port of the connected peer.

Finally, if any function should fail, error() and errorString() can be called to determine the cause of the error.

Definition at line 101 of file qnativesocketengine_p.h.

Constructor & Destructor Documentation

◆ QNativeSocketEngine()

QNativeSocketEngine::QNativeSocketEngine ( QObject * parent = nullptr )

Constructs a QNativeSocketEngine.

See also: initialize()

Definition at line 384 of file qnativesocketengine.cpp.

◆ ~QNativeSocketEngine()

QNativeSocketEngine::~QNativeSocketEngine ( )

Destructs a QNativeSocketEngine.

Definition at line 392 of file qnativesocketengine.cpp.

References close().

Here is the call graph for this function:

Member Function Documentation

◆ accept()

qintptr QNativeSocketEngine::accept ( )

overridevirtual

Accepts a pending connection from the socket, which must be in ListeningState, and returns its socket descriptor.

If no pending connections are available, -1 is returned.

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QNativeSocketEngine()

◆ ~QNativeSocketEngine()

Member Function Documentation

◆ accept()

◆ bind()

◆ bytesAvailable()

◆ bytesToWrite()

◆ close()

◆ connectionNotification

◆ connectToHost()

◆ connectToHostByName()

◆ hasPendingDatagrams()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ isExceptionNotificationEnabled()

◆ isReadNotificationEnabled()

◆ isValid()

◆ isWriteNotificationEnabled()

◆ joinMulticastGroup()

◆ leaveMulticastGroup()

◆ listen()

◆ multicastInterface()

◆ option()

◆ pendingDatagramSize()

◆ read()

◆ readDatagram()

◆ setExceptionNotificationEnabled()

◆ setMulticastInterface()

◆ setOption()

◆ setReadNotificationEnabled()

◆ setWriteNotificationEnabled()

◆ socketDescriptor()

◆ waitForRead()

◆ waitForReadOrWrite()

◆ waitForWrite()

◆ write()

◆ writeDatagram()