QCA::QPipe

Search for usage in LXR

#include <QtCrypto>

Public Member Functions

 QPipe (QObject *parent=nullptr)
 
bool create ()
 
QPipeEndreadEnd ()
 
void reset ()
 
QPipeEndwriteEnd ()
 

Detailed Description

A FIFO buffer (named pipe) abstraction.

This class creates a full buffer, consisting of two ends (QPipeEnd). You can obtain each end (after calling create()) using readEnd() and writeEnd(), however you must call enable() on each end before using the pipe.

By default, the pipe ends are not inheritable by child processes. On Windows, the pipe is created with inheritability disabled. On Unix, the FD_CLOEXEC flag is set on each end's file descriptor.

Definition at line 478 of file qpipe.h.

Constructor & Destructor Documentation

◆ QPipe()

QCA::QPipe::QPipe ( QObject * parent = nullptr)

Standard constructor.

Note
You must call create() before using the pipe ends.
Parameters
parentthe parent object for this object

Member Function Documentation

◆ create()

bool QCA::QPipe::create ( )

Create the pipe.

◆ readEnd()

QPipeEnd & QCA::QPipe::readEnd ( )
inline

The read end of the pipe.

Definition at line 517 of file qpipe.h.

◆ reset()

void QCA::QPipe::reset ( )

Reset the pipe.

At this point, the readEnd() and writeEnd() calls will no longer be valid.

◆ writeEnd()

QPipeEnd & QCA::QPipe::writeEnd ( )
inline

The write end of the pipe.

Definition at line 525 of file qpipe.h.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 8 2024 11:53:14 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.