QCA::ConsoleReference Class Reference

#include <QtCrypto>

Inheritance diagram for QCA::ConsoleReference:

Public Types
enum	SecurityMode { SecurityDisabled , SecurityEnabled }

Signals
void	bytesWritten (int bytes)
void	inputClosed ()
void	outputClosed ()
void	readyRead ()

Public Member Functions
	ConsoleReference (QObject *parent=nullptr)
int	bytesAvailable () const
int	bytesToWrite () const
void	closeOutput ()
Console *	console () const
QByteArray	read (int bytes=-1)
SecureArray	readSecure (int bytes=-1)
SecurityMode	securityMode () const
bool	start (Console *console, SecurityMode mode=SecurityDisabled)
void	stop ()
void	write (const QByteArray &a)
void	writeSecure (const SecureArray &a)
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)
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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Manager for a Console.

Note

Only one ConsoleReference object can be active at a time

Definition at line 692 of file qca_support.h.

Member Enumeration Documentation

SecurityMode

enum QCA::ConsoleReference::SecurityMode

The security setting to use for the Console being managed.

Definition at line 699 of file qca_support.h.

Constructor & Destructor Documentation

ConsoleReference()

QCA::ConsoleReference::ConsoleReference

(

QObject *

parent = nullptr

)

Standard constructor.

Parameters

parent

the parent object for this object

Member Function Documentation

bytesAvailable()

int QCA::ConsoleReference::bytesAvailable

(

)

const

The number of bytes available to read from the Console being managed.

bytesToWrite()

int QCA::ConsoleReference::bytesToWrite

(

)

const

The number of bytes remaining to be written to the Console being managed.

bytesWritten

void QCA::ConsoleReference::bytesWritten ( int bytes )

signal

Emitted when bytes are written to the Console.

Parameters

bytes

the number of bytes that were written

See also

bytesAvailable()

closeOutput()

void QCA::ConsoleReference::closeOutput

(

)

Close the write channel.

You only need to call this if writing is enabled on the Console being managed.

console()

Console * QCA::ConsoleReference::console

(

)

const

The Console object managed by this object.

See also

start() to set the Console to be managed

inputClosed

void QCA::ConsoleReference::inputClosed ( )

signal

Emitted when the console input is closed.

outputClosed

void QCA::ConsoleReference::outputClosed ( )

signal

Emitted when the console output is closed.

read()

QByteArray QCA::ConsoleReference::read

(

int

bytes = -1

)

Read data from the Console.

Parameters

bytes

the number of bytes to read. The default is to read all available bytes

See also

readSecure() for a method suitable for reading sensitive data.

readSecure()

SecureArray QCA::ConsoleReference::readSecure

(

int

bytes = -1

)

Read secure data from the Console.

Parameters

bytes

the number of bytes to read. The default is to read all available bytes

See also

read() which is suitable for non-sensitive data

readyRead

void QCA::ConsoleReference::readyRead ( )

signal

Emitted when there are bytes available to read from the Console being managed.

securityMode()

SecurityMode QCA::ConsoleReference::securityMode

(

)

const

The security mode setting for the Console object managed by this object.

See also

start() to set the SecurityMode

start()

bool QCA::ConsoleReference::start	(	Console *	console,
		SecurityMode	mode = SecurityDisabled )

Set the Console object to be managed, and start processing.

You typically want to use Console::ttyInstance() or Console::stdioInstance() to obtain the required Console reference.

Parameters

console	reference to the Console to be managed
mode	the SecurityMode to use for this Console.

See also

QCA::Console for more information on how to handle the console aspects of your application or library code.

stop()

void QCA::ConsoleReference::stop

(

)

Stop processing, and release the Console.

write()

void QCA::ConsoleReference::write

(

const QByteArray &

a

)

Write data to the Console.

Parameters

a	the array of data to write to the Console

See also

writeSecure() for a method suitable for writing sensitive data.

writeSecure()

void QCA::ConsoleReference::writeSecure

(

const SecureArray &

a

)

Write secure data to the Console.

Parameters

a	the array of data to write to the Console

See also

write() which is suitable for non-sensitive data

---

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

• qca_support.h