\inmodule QtCore More...

#include <qnoncontiguousbytedevice_p.h>

Inheritance diagram for QNonContiguousByteDevice:

Collaboration diagram for QNonContiguousByteDevice:

Signals
void	readyRead ()
	Emitted when there is data available.

void	readProgress (qint64 current, qint64 total)
	Emitted when data has been "read" by advancing the read pointer.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
virtual const char *	readPointer (qint64 maximumLength, qint64 &len)=0
	Return a byte pointer for at most maximumLength bytes of that device.

virtual bool	advanceReadPointer (qint64 amount)=0
	will advance the internal read pointer by amount bytes.

virtual bool	atEnd () const =0
	Returns `true` if everything has been read and the read pointer cannot be advanced anymore.

virtual qint64	pos () const

virtual bool	reset ()=0
	Moves the internal read pointer back to the beginning.

virtual qint64	size () const =0
	Returns the size of the complete device or -1 if unknown.

virtual	~QNonContiguousByteDevice ()

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Protected Member Functions
	QNonContiguousByteDevice ()

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtCore

A QNonContiguousByteDevice is a representation of a file, array or buffer that allows access with a read pointer.

Since: 4.6

The goal of this class is to have a data representation that allows us to avoid doing a memcpy as we have to do with QIODevice.

See also: QNonContiguousByteDeviceFactory

Definition at line 28 of file qnoncontiguousbytedevice_p.h.

Constructor & Destructor Documentation

◆ ~QNonContiguousByteDevice()

QNonContiguousByteDevice::~QNonContiguousByteDevice ( )

virtual

Definition at line 98 of file qnoncontiguousbytedevice.cpp.

◆ QNonContiguousByteDevice()

QNonContiguousByteDevice::QNonContiguousByteDevice ( )

protected

Definition at line 94 of file qnoncontiguousbytedevice.cpp.

Member Function Documentation

◆ advanceReadPointer()

bool QNonContiguousByteDevice::advanceReadPointer ( qint64 amount )

pure virtual

will advance the internal read pointer by amount bytes.

The old readPointer is invalid after this call.

See also: readPointer()

Implemented in QNonContiguousByteDeviceThreadForwardImpl, QNonContiguousByteDeviceByteArrayImpl, QNonContiguousByteDeviceRingBufferImpl, QNonContiguousByteDeviceIoDeviceImpl, and QNonContiguousByteDeviceBufferImpl.

Referenced by QByteDeviceWrappingIoDevice::readData(), and QHttpProtocolHandler::sendRequest().

Here is the caller graph for this function:

◆ atEnd()

bool QNonContiguousByteDevice::atEnd ( ) const

pure virtual

Returns true if everything has been read and the read pointer cannot be advanced anymore.

See also: readPointer(), advanceReadPointer(), reset()

Implemented in QNonContiguousByteDeviceByteArrayImpl, QNonContiguousByteDeviceRingBufferImpl, QNonContiguousByteDeviceIoDeviceImpl, QNonContiguousByteDeviceBufferImpl, and QNonContiguousByteDeviceThreadForwardImpl.

Referenced by QByteDeviceWrappingIoDevice::atEnd().

Here is the caller graph for this function:

◆ pos()

virtual qint64 QNonContiguousByteDevice::pos ( ) const

inlinevirtual

Reimplemented in QNonContiguousByteDeviceByteArrayImpl, QNonContiguousByteDeviceRingBufferImpl, QNonContiguousByteDeviceIoDeviceImpl, and QNonContiguousByteDeviceThreadForwardImpl.

Definition at line 35 of file qnoncontiguousbytedevice_p.h.

Referenced by QHttpProtocolHandler::sendRequest().

Here is the caller graph for this function:

◆ readPointer()

const char * QNonContiguousByteDevice::readPointer	(	qint64	maximumLength,
		qint64 &	len
	)

pure virtual

Return a byte pointer for at most maximumLength bytes of that device.

if maximumLength is -1, the caller does not care about the length and the device may return what it desires to. The actual number of bytes the pointer is valid for is returned in the len variable. len will be -1 if EOF or an error occurs. If it was really EOF can then afterwards be checked with atEnd() Returns 0 if it is not possible to read at that position.