QCA::QPipeEnd

Search for usage in LXR

#include <QtCrypto>

Inheritance diagram for QCA::QPipeEnd:

Public Types

enum  Error { ErrorEOF, ErrorBroken }
 

Signals

void bytesWritten (int bytes)
 
void closed ()
 
void error (QCA::QPipeEnd::Error e)
 
void readyRead ()
 

Public Member Functions

 QPipeEnd (QObject *parent=nullptr)
 
int bytesAvailable () const
 
int bytesToWrite () const
 
void close ()
 
void enable ()
 
void finalize ()
 
void finalizeAndRelease ()
 
Q_PIPE_ID id () const
 
int idAsInt () const
 
bool isValid () const
 
QByteArray read (int bytes=-1)
 
void release ()
 
void reset ()
 
bool setInheritable (bool enabled)
 
void take (Q_PIPE_ID id, QPipeDevice::Type t)
 
QByteArray takeBytesToWrite ()
 
QPipeDevice::Type type () const
 
void write (const QByteArray &a)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

A buffered higher-level pipe end.

This is either the read end or write end of a QPipe.

Definition at line 217 of file qpipe.h.

Member Enumeration Documentation

The type of error.

Enumerator
ErrorEOF 

End of file error.

ErrorBroken 

Broken pipe error.

Definition at line 224 of file qpipe.h.

Constructor & Destructor Documentation

QCA::QPipeEnd::QPipeEnd ( QObject parent = nullptr)

Standard constructor.

Parameters
parentthe parent object for this object

Member Function Documentation

int QCA::QPipeEnd::bytesAvailable ( ) const

Determine how many bytes are available to be read.

This only makes sense at the read end of the pipe

See also
readyRead() for a signal that can be used to determine when there are bytes available to read.
int QCA::QPipeEnd::bytesToWrite ( ) const

Returns the number of bytes pending to write.

This only makes sense at the write end of the pipe

See also
bytesWritten() for a signal that can be used to determine when bytes have been written
void QCA::QPipeEnd::bytesWritten ( int  bytes)
signal

Emitted when bytes have been written to the write end of the pipe.

Parameters
bytesthe number of bytes written
void QCA::QPipeEnd::close ( )

Close the end of the pipe.

See also
closed()
void QCA::QPipeEnd::closed ( )
signal

Emitted when this end of the pipe is closed as a result of calling close()

If this is the write end of the pipe and there is data still pending to write, this signal will be emitted once all of the data has been written.

To be notified if the other end of the pipe has been closed, see error().

void QCA::QPipeEnd::enable ( )

Enable the endpoint for the pipe.

When an endpoint is created, it is not able to be used until it is enabled.

void QCA::QPipeEnd::error ( QCA::QPipeEnd::Error  e)
signal

Emitted when the pipe encounters an error trying to read or write, or if the other end of the pipe has been closed.

Parameters
ethe reason for error
void QCA::QPipeEnd::finalize ( )

Clear the contents of the pipe, and invalidate the pipe.

void QCA::QPipeEnd::finalizeAndRelease ( )

Clear the contents of the pipe, and release the pipe.

Q_PIPE_ID QCA::QPipeEnd::id ( ) const

Pipe identification.

int QCA::QPipeEnd::idAsInt ( ) const

Pipe identification.

bool QCA::QPipeEnd::isValid ( ) const

Determine whether the pipe end is valid.

Note
This does not mean the pipe is ready to be used - you may need to call enable() first
QByteArray QCA::QPipeEnd::read ( int  bytes = -1)

Read bytes from the pipe.

You can only call this on the read end of the pipe

If the pipe is using secure memory, you should use readSecure()

Parameters
bytesthe number of bytes to read (-1 for all content).
void QCA::QPipeEnd::readyRead ( )
signal

Emitted when there are bytes available to be read from the read end of the pipe.

See also
bytesAvailable()
void QCA::QPipeEnd::release ( )

Let go of the active pipe handle, but don't close it.

Use this before destructing QPipeEnd, if you don't want the pipe to automatically close.

void QCA::QPipeEnd::reset ( )

Reset the pipe end to an inactive state.

bool QCA::QPipeEnd::setInheritable ( bool  enabled)

Sets whether the pipe should be inheritable to child processes.

Returns true if inheritability was successfully changed, otherwise false.

Parameters
enabledwhether the pipe is inheritable (true) or not (false).
void QCA::QPipeEnd::take ( Q_PIPE_ID  id,
QPipeDevice::Type  t 
)

Take over an existing pipe handle.

Parameters
idthe pipe handle
tthe type of the pipe (read or write)
QByteArray QCA::QPipeEnd::takeBytesToWrite ( )

Returns any unsent bytes queued for writing.

If the pipe is using secure memory, you should use takeBytesToWriteSecure().

QPipeDevice::Type QCA::QPipeEnd::type ( ) const

The type of pipe end (either read or write)

void QCA::QPipeEnd::write ( const QByteArray a)

Write bytes to the pipe.

You can only call this on the write end of the pipe.

If the pipe is using secure memory, you should use writeSecure().

Parameters
athe array to write to the pipe

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Dec 6 2021 22:55:49 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.