KPtyDevice Class Reference

#include <kptydevice.h>

Inheritance diagram for KPtyDevice:

Signals
void	readEof ()

Public Member Functions
	KPtyDevice (QObject *parent=nullptr)
	~KPtyDevice () override
bool	atEnd () const override
qint64	bytesAvailable () const override
qint64	bytesToWrite () const override
bool	canReadLine () const override
void	close () override
bool	isSequential () const override
bool	isSuspended () const
bool	open (int fd, OpenMode mode=ReadWrite|Unbuffered)
bool	open (OpenMode mode=ReadWrite|Unbuffered) override
void	setSuspended (bool suspended)
bool	waitForBytesWritten (int msecs=-1) override
bool	waitForReadyRead (int msecs=-1) override
Public Member Functions inherited from QIODevice
	QIODevice (QObject *parent)
void	aboutToClose ()
void	bytesWritten (qint64 bytes)
void	channelBytesWritten (int channel, qint64 bytes)
void	channelReadyRead (int channel)
void	commitTransaction ()
int	currentReadChannel () const const
int	currentWriteChannel () const const
QString	errorString () const const
bool	getChar (char *c)
bool	isOpen () const const
bool	isReadable () const const
bool	isTextModeEnabled () const const
bool	isTransactionStarted () const const
bool	isWritable () const const
virtual bool	open (QIODevice::OpenMode mode)
QIODevice::OpenMode	openMode () const const
qint64	peek (char *data, qint64 maxSize)
QByteArray	peek (qint64 maxSize)
virtual qint64	pos () const const
bool	putChar (char c)
qint64	read (char *data, qint64 maxSize)
QByteArray	read (qint64 maxSize)
QByteArray	readAll ()
int	readChannelCount () const const
void	readChannelFinished ()
qint64	readLine (char *data, qint64 maxSize)
QByteArray	readLine (qint64 maxSize)
void	readyRead ()
virtual bool	reset ()
void	rollbackTransaction ()
virtual bool	seek (qint64 pos)
void	setCurrentReadChannel (int channel)
void	setCurrentWriteChannel (int channel)
void	setTextModeEnabled (bool enabled)
virtual qint64	size () const const
qint64	skip (qint64 maxSize)
void	startTransaction ()
void	ungetChar (char c)
qint64	write (const char *data)
qint64	write (const char *data, qint64 maxSize)
qint64	write (const QByteArray &byteArray)
int	writeChannelCount () const const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
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 ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
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 QRegExp &regExp, 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
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 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_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
T	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)
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	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)
QThread *	thread () const const
Public Member Functions inherited from KPty
	KPty ()
	KPty (const KPty &)=delete
	~KPty ()
void	close ()
void	closeSlave ()
void	login (const char *user=nullptr, const char *remotehost=nullptr)
void	logout ()
int	masterFd () const
bool	open ()
bool	open (int fd)
bool	openSlave ()
KPty &	operator= (const KPty &)=delete
void	setCTty ()
void	setCTtyEnabled (bool enable)
bool	setEcho (bool echo)
bool	setWinSize (int lines, int columns)
bool	setWinSize (int lines, int columns, int height, int width)
int	slaveFd () const
bool	tcGetAttr (struct ::termios *ttmode) const
bool	tcSetAttr (struct ::termios *ttmode)
const char *	ttyName () const

Protected Member Functions
qint64	readData (char *data, qint64 maxSize) override
qint64	readLineData (char *data, qint64 maxSize) override
qint64	writeData (const char *data, qint64 maxSize) override
Protected Member Functions inherited from QIODevice
void	setErrorString (const QString &str)
void	setOpenMode (QIODevice::OpenMode openMode)
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)
Protected Member Functions inherited from KPty
KPTY_NO_EXPORT	KPty (KPtyPrivate *d)

Additional Inherited Members
Public Types inherited from QIODevice
enum	OpenModeFlag
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)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QIODevice
	Append
	ExistingOnly
	NewOnly
	NotOpen
typedef	OpenMode
	ReadOnly
	ReadWrite
	Text
	Truncate
	Unbuffered
	WriteOnly
Public Attributes inherited from QObject
typedef	QObjectList
Protected Attributes inherited from KPty
const std::unique_ptr< KPtyPrivate >	d_ptr

Detailed Description

Encapsulates KPty into a QIODevice, so it can be used with Q*Stream, etc.

Definition at line 20 of file kptydevice.h.

Constructor & Destructor Documentation

KPtyDevice()

KPtyDevice::KPtyDevice ( QObject *  parent = nullptr )

explicit

Constructor.

Definition at line 444 of file kptydevice.cpp.

~KPtyDevice()

KPtyDevice::~KPtyDevice ( )

override

Destructor:

If the pty is still open, it will be closed. Note, however, that an utmp registration is not undone.

Definition at line 450 of file kptydevice.cpp.

Member Function Documentation

atEnd()

bool KPtyDevice::atEnd ( ) const

overridevirtual

Reimplemented from superclass.

Reimplemented from QIODevice.

Definition at line 514 of file kptydevice.cpp.

bytesAvailable()

qint64 KPtyDevice::bytesAvailable ( ) const

overridevirtual

Reimplemented from superclass.

Reimplemented from QIODevice.

Definition at line 520 of file kptydevice.cpp.

bytesToWrite()

qint64 KPtyDevice::bytesToWrite ( ) const

overridevirtual

Reimplemented from superclass.

Reimplemented from QIODevice.

Definition at line 526 of file kptydevice.cpp.

canReadLine()

bool KPtyDevice::canReadLine ( ) const

overridevirtual

Reimplemented from superclass.

Reimplemented from QIODevice.

Definition at line 508 of file kptydevice.cpp.

close()

void KPtyDevice::close ( )

overridevirtual

Close the pty master/slave pair.

Reimplemented from QIODevice.

Definition at line 487 of file kptydevice.cpp.

isSequential()

bool KPtyDevice::isSequential ( ) const

overridevirtual

Returns

always true

Reimplemented from QIODevice.

Definition at line 503 of file kptydevice.cpp.

isSuspended()

bool KPtyDevice::isSuspended

(

)

const

Returns true if the KPtyDevice is not monitoring the pty for incoming data.

Do not use on closed ptys.

See setSuspended()

Definition at line 550 of file kptydevice.cpp.

open() [1/2]

bool KPtyDevice::open	(	int	fd,
		OpenMode	mode = ReadWrite | Unbuffered
	)

Open using an existing pty master.

The ownership of the fd remains with the caller, i.e., close() will not close the fd.

This is useful if you wish to attach a secondary "controller" to an existing pty device such as a terminal widget. Note that you will need to use setSuspended() on both devices to control which one gets the incoming data from the pty.

Parameters

fd	an open pty master file descriptor.
mode	the device mode to open the pty with.

Returns

true if a pty pair was successfully opened

Definition at line 473 of file kptydevice.cpp.

open() [2/2]

bool KPtyDevice::open ( OpenMode  mode = ReadWrite | Unbuffered )

override

Create a pty master/slave pair.

Returns

true if a pty pair was successfully opened

Definition at line 455 of file kptydevice.cpp.

readEof

void KPtyDevice::readEof ( )

signal

Emitted when EOF is read from the PTY.

Data may still remain in the buffers.

setSuspended()

void KPtyDevice::setSuspended

(

bool

suspended

)

Sets whether the KPtyDevice monitors the pty for incoming data.

When the KPtyDevice is suspended, it will no longer attempt to buffer data that becomes available from the pty and it will not emit any signals.

Do not use on closed ptys. After a call to open(), the pty is not suspended. If you need to ensure that no data is read, call this function before the main loop is entered again (i.e., immediately after opening the pty).

Definition at line 544 of file kptydevice.cpp.

---

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

• kptydevice.h
• kptydevice.cpp