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
Signals | Public Member Functions | Protected Member Functions | List of all members
QWindowsPipeWriter Class Reference

#include <qwindowspipewriter_p.h>

+ Inheritance diagram for QWindowsPipeWriter:
+ Collaboration diagram for QWindowsPipeWriter:

Signals

void bytesWritten (qint64 bytes)
 
void writeFailed ()
 
- 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

 QWindowsPipeWriter (HANDLE pipeWriteEnd, QObject *parent=nullptr)
 
 ~QWindowsPipeWriter ()
 
void setHandle (HANDLE hPipeWriteEnd)
 Assigns the handle to this writer.
 
void write (const QByteArray &ba)
 Writes a shallow copy of ba to the internal buffer.
 
void write (const char *data, qint64 size)
 Writes data to the internal buffer.
 
void stop ()
 Stops the asynchronous write sequence.
 
bool checkForWrite ()
 
qint64 bytesToWrite () const
 Returns the number of bytes that are waiting to be written.
 
bool isWriteOperationActive () const
 Returns true if async operation is in progress.
 
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 write 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
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 27 of file qwindowspipewriter_p.h.

Constructor & Destructor Documentation

◆ QWindowsPipeWriter()

QT_BEGIN_NAMESPACE QWindowsPipeWriter::QWindowsPipeWriter ( HANDLE pipeWriteEnd,
QObject * parent = nullptr )
explicit

Definition at line 12 of file qwindowspipewriter.cpp.

References qErrnoWarning().

+ Here is the call graph for this function:

◆ ~QWindowsPipeWriter()

QWindowsPipeWriter::~QWindowsPipeWriter ( )

Definition at line 33 of file qwindowspipewriter.cpp.

References stop().

+ Here is the call graph for this function:

Member Function Documentation

◆ bytesToWrite()

qint64 QWindowsPipeWriter::bytesToWrite ( ) const

Returns the number of bytes that are waiting to be written.

Definition at line 86 of file qwindowspipewriter.cpp.

Referenced by isWriteOperationActive().

+ Here is the caller graph for this function:

◆ bytesWritten

void QWindowsPipeWriter::bytesWritten ( qint64 bytes)
signal

◆ checkForWrite()

bool QWindowsPipeWriter::checkForWrite ( )
inline

Definition at line 38 of file qwindowspipewriter_p.h.

◆ event()

bool QWindowsPipeWriter::event ( QEvent * e)
overrideprotectedvirtual

Receives notification that the write operation has completed.

Reimplemented from QObject.

Definition at line 259 of file qwindowspipewriter.cpp.

References QObject::event(), QEvent::type(), and QEvent::WinEventAct.

+ Here is the call graph for this function:

◆ isWriteOperationActive()

bool QWindowsPipeWriter::isWriteOperationActive ( ) const

Returns true if async operation is in progress.

Definition at line 95 of file qwindowspipewriter.cpp.

References bytesToWrite().

+ Here is the call graph for this function:

◆ setHandle()

void QWindowsPipeWriter::setHandle ( HANDLE hPipeWriteEnd)

Assigns the handle to this writer.

The handle must be valid. Call this function if data was buffered before getting the handle.

Definition at line 45 of file qwindowspipewriter.cpp.

References Q_ASSERT.

◆ stop()

void QWindowsPipeWriter::stop ( )

Stops the asynchronous write sequence.

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

Definition at line 58 of file qwindowspipewriter.cpp.

References QMutex::lock(), qErrnoWarning(), and QMutex::unlock().

Referenced by ~QWindowsPipeWriter().

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

◆ syncEvent()

HANDLE QWindowsPipeWriter::syncEvent ( ) const
inline

Definition at line 41 of file qwindowspipewriter_p.h.

◆ write() [1/2]

void QWindowsPipeWriter::write ( const char * data,
qint64 size )

Writes data to the internal buffer.

Definition at line 112 of file qwindowspipewriter.cpp.

◆ write() [2/2]

void QWindowsPipeWriter::write ( const QByteArray & ba)

Writes a shallow copy of ba to the internal buffer.

Definition at line 103 of file qwindowspipewriter.cpp.

References ba.

◆ writeFailed

void QWindowsPipeWriter::writeFailed ( )
signal
The documentation for this class was generated from the following files: