#include <qwindowspipereader_p.h>

Inheritance diagram for QWindowsPipeReader:

Collaboration diagram for QWindowsPipeReader:

Signals
void	winError (ulong, const QString &)

void	readyRead ()

void	pipeClosed ()

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
	QWindowsPipeReader (QObject *parent=nullptr)

	~QWindowsPipeReader ()

void	setHandle (HANDLE hPipeReadEnd)
	Sets the handle to read from.

void	startAsyncRead ()
	Starts an asynchronous read sequence on the pipe.

void	stop ()
	Stops the asynchronous read sequence.

void	drainAndStop ()
	Stops the asynchronous read sequence.

void	stopAndClear ()
	Stops the asynchronous read sequence.

void	setMaxReadBufferSize (qint64 size)
	Sets the size of internal read buffer.

qint64	maxReadBufferSize () const

bool	isPipeClosed () const

qint64	bytesAvailable () const
	Returns the number of bytes we've read so far.

qint64	read (char *data, qint64 maxlen)
	Copies at most {maxlen} bytes from the internal read buffer to {data}.

qint64	readLine (char *data, qint64 maxlen)
	Reads a line from the internal buffer, but no more than {maxlen} characters.

qint64	skip (qint64 maxlen)
	Skips up to {maxlen} bytes from the internal read buffer.

bool	canReadLine () const
	Returns `true` if a complete line of data can be read from the buffer.

DWORD	checkPipeState ()
	Returns the number of available bytes in the pipe.

bool	checkForReadyRead ()

bool	isReadOperationActive () const
	Returns `true` if async operation is in progress, there is pending data to read, or a read error is pending.

HANDLE	syncEvent () 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	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.

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

Protected Member Functions
bool	event (QEvent *e) override
	Receives notification that the read operation has completed.

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

Definition at line 27 of file qwindowspipereader_p.h.

Constructor & Destructor Documentation

◆ QWindowsPipeReader()

QWindowsPipeReader::QWindowsPipeReader ( QObject * parent = nullptr )

explicit

Definition at line 16 of file qwindowspipereader.cpp.

◆ ~QWindowsPipeReader()

QWindowsPipeReader::~QWindowsPipeReader ( )

Definition at line 39 of file qwindowspipereader.cpp.

Member Function Documentation

◆ bytesAvailable()

qint64 QWindowsPipeReader::bytesAvailable ( ) const

Returns the number of bytes we've read so far.

Definition at line 161 of file qwindowspipereader.cpp.

◆ canReadLine()

bool QWindowsPipeReader::canReadLine ( ) const

Returns true if a complete line of data can be read from the buffer.

Definition at line 239 of file qwindowspipereader.cpp.

◆ checkForReadyRead()

bool QWindowsPipeReader::checkForReadyRead ( )

inline

Definition at line 50 of file qwindowspipereader_p.h.

◆ checkPipeState()

DWORD QWindowsPipeReader::checkPipeState ( )

Returns the number of available bytes in the pipe.

Definition at line 489 of file qwindowspipereader.cpp.

◆ drainAndStop()

void QWindowsPipeReader::drainAndStop ( )

Stops the asynchronous read sequence.

Reads all pending bytes into the internal buffer.

Definition at line 80 of file qwindowspipereader.cpp.

◆ event()

bool QWindowsPipeReader::event ( QEvent * e )

overrideprotectedvirtual

Receives notification that the read operation has completed.

Reimplemented from QObject.

Definition at line 413 of file qwindowspipereader.cpp.

◆ isPipeClosed()

bool QWindowsPipeReader::isPipeClosed ( ) const

inline

Definition at line 43 of file qwindowspipereader_p.h.

◆ isReadOperationActive()

bool QWindowsPipeReader::isReadOperationActive ( ) const

Returns true if async operation is in progress, there is pending data to read, or a read error is pending.

Definition at line 151 of file qwindowspipereader.cpp.

◆ maxReadBufferSize()

qint64 QWindowsPipeReader::maxReadBufferSize ( ) const

inline

Definition at line 41 of file qwindowspipereader_p.h.

◆ pipeClosed

void QWindowsPipeReader::pipeClosed ( )

signal

◆ read()

qint64 QWindowsPipeReader::read	(	char *	data,
		qint64	maxlen )

Copies at most {maxlen} bytes from the internal read buffer to {data}.

Definition at line 169 of file qwindowspipereader.cpp.

◆ readLine()

qint64 QWindowsPipeReader::readLine	(	char *	data,
		qint64	maxlen )

Reads a line from the internal buffer, but no more than {maxlen} characters.

A terminating '\0' byte is always appended to {data}, so {maxlen} must be larger than 1.

Definition at line 198 of file qwindowspipereader.cpp.

◆ readyRead

void QWindowsPipeReader::readyRead ( )

signal

◆ setHandle()

void QWindowsPipeReader::setHandle ( HANDLE hPipeReadEnd )

Sets the handle to read from.

The handle must be valid. Do not call this function while the pipe is running.

Definition at line 55 of file qwindowspipereader.cpp.

◆ setMaxReadBufferSize()

void QWindowsPipeReader::setMaxReadBufferSize ( qint64 size )

Sets the size of internal read buffer.

Definition at line 141 of file qwindowspipereader.cpp.

◆ skip()

qint64 QWindowsPipeReader::skip ( qint64 maxlen )

Skips up to {maxlen} bytes from the internal read buffer.

Definition at line 220 of file qwindowspipereader.cpp.

◆ startAsyncRead()

void QWindowsPipeReader::startAsyncRead ( )

Starts an asynchronous read sequence on the pipe.

Definition at line 248 of file qwindowspipereader.cpp.

◆ stop()

void QWindowsPipeReader::stop ( )

Stops the asynchronous read sequence.

If the read sequence is running then the I/O operation is canceled.

Definition at line 70 of file qwindowspipereader.cpp.

◆ stopAndClear()

void QWindowsPipeReader::stopAndClear ( )

Stops the asynchronous read sequence.

Clears the internal buffer and discards any pending data.

Definition at line 90 of file qwindowspipereader.cpp.

◆ syncEvent()

HANDLE QWindowsPipeReader::syncEvent ( ) const

inline

Definition at line 53 of file qwindowspipereader_p.h.

◆ winError

void QWindowsPipeReader::winError	(	ulong	,
		const QString &	)

signal

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

qtbase/src/corelib/io/qwindowspipereader_p.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/corelib/io/qwindowspipereader.cpp (8fe793fe4b43c84f5d158e0d62fdd92ea4b2d851)

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QWindowsPipeReader()

◆ ~QWindowsPipeReader()

Member Function Documentation

◆ bytesAvailable()

◆ canReadLine()

◆ checkForReadyRead()

◆ checkPipeState()

◆ drainAndStop()

◆ event()

◆ isPipeClosed()

◆ isReadOperationActive()

◆ maxReadBufferSize()

◆ pipeClosed

◆ read()

◆ readLine()

◆ readyRead

◆ setHandle()

◆ setMaxReadBufferSize()

◆ skip()

◆ startAsyncRead()

◆ stop()

◆ stopAndClear()

◆ syncEvent()

◆ winError