QCA::QPipeDevice
#include <QtCrypto>
Public Types | |
enum | Type { Read , Write } |
Public Types inherited from QObject | |
typedef | QObjectList |
Signals | |
void | notify () |
Public Member Functions | |
QPipeDevice (QObject *parent=nullptr) | |
int | bytesAvailable () const |
void | close () |
void | enable () |
Q_PIPE_ID | id () const |
int | idAsInt () const |
bool | isValid () const |
int | read (char *data, int maxsize) |
void | release () |
bool | setInheritable (bool enabled) |
void | take (Q_PIPE_ID id, Type t) |
Type | type () const |
int | write (const char *data, int size) |
int | writeResult (int *written) const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () 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 () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
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 | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () 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 *context, Functor functor, 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) |
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
Unbuffered direct pipe.
This class is not usually required except for very low level operations. You should use QPipe and QPipeEnd for most applications.
Member Enumeration Documentation
◆ Type
Constructor & Destructor Documentation
◆ QPipeDevice()
QCA::QPipeDevice::QPipeDevice | ( | QObject * | parent = nullptr | ) |
Standard constructor.
- Parameters
-
parent the parent object to this object
Member Function Documentation
◆ bytesAvailable()
int QCA::QPipeDevice::bytesAvailable | ( | ) | const |
Obtain the number of bytes available to be read.
◆ close()
void QCA::QPipeDevice::close | ( | ) |
Close the pipe end.
◆ enable()
void QCA::QPipeDevice::enable | ( | ) |
Enable the pipe for reading or writing (depending on Type)
◆ id()
Q_PIPE_ID QCA::QPipeDevice::id | ( | ) | const |
The low level identification for this pipe.
On Windows, this is a HANDLE. On Unix, this is a file descriptor (i.e. integer).
Code using this method should be carefully tested for portability.
- See also
- idAsInt
◆ idAsInt()
int QCA::QPipeDevice::idAsInt | ( | ) | const |
The low level identification for this pipe, returned as an integer.
Code using this method should be carefully tested for portability.
- See also
- id().
◆ isValid()
bool QCA::QPipeDevice::isValid | ( | ) | const |
Test whether this object corresponds to a valid pipe.
◆ notify
|
signal |
Emitted when the pipe end can be read from or written to (depending on its Type).
◆ read()
int QCA::QPipeDevice::read | ( | char * | data, |
int | maxsize ) |
Read from the pipe end.
- Parameters
-
data where to put the data that has been read maxsize the maximum number of bytes to be read.
- Returns
- the actual number of bytes read, 0 on end-of-file, or -1 on error.
◆ release()
void QCA::QPipeDevice::release | ( | ) |
Release the pipe end, but do not close it.
◆ setInheritable()
bool QCA::QPipeDevice::setInheritable | ( | bool | enabled | ) |
Set the pipe end to be inheritable.
- Note
- On Windows, this operation changes the pipe end id value.
- Parameters
-
enabled whether the pipe is inheritable (true) or not (false)
◆ take()
void QCA::QPipeDevice::take | ( | Q_PIPE_ID | id, |
Type | t ) |
Take over an existing pipe id, closing the old pipe if any.
- Parameters
-
id the identification of the pipe end to take over. t the type of pipe end (read or write).
◆ type()
Type QCA::QPipeDevice::type | ( | ) | const |
The Type of the pipe device (that is, read or write)
◆ write()
int QCA::QPipeDevice::write | ( | const char * | data, |
int | size ) |
Write to the pipe end.
- Parameters
-
data the source of the data to be written size the number of bytes in the data to be written
- Note
- the data source must remain valid
- Returns
- the number of bytes written, or -1 on error.
◆ writeResult()
int QCA::QPipeDevice::writeResult | ( | int * | written | ) | const |
The result of a write operation.
- Parameters
-
written if not null, this will be set to the number of bytes written in the last operation.
- Returns
- 0 on success (all data written), or -1 on error
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 29 2024 11:48:56 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.