Qt 4.8
Signals | Public Functions | Protected Functions | Protected Variables | List of all members
QNonContiguousByteDevice Class Referenceabstract

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

#include <qnoncontiguousbytedevice_p.h>

Inheritance diagram for QNonContiguousByteDevice:
QObject QNonContiguousByteDeviceBufferImpl QNonContiguousByteDeviceByteArrayImpl QNonContiguousByteDeviceIoDeviceImpl QNonContiguousByteDeviceRingBufferImpl QNonContiguousByteDeviceThreadForwardImpl

Signals

void readProgress (qint64 current, qint64 total)
 Emitted when data has been "read" by advancing the read pointer. More...
 
void readyRead ()
 Emitted when there is data available. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 

Public Functions

virtual bool advanceReadPointer (qint64 amount)=0
 The old readPointer is invalid after this call. More...
 
virtual bool atEnd ()=0
 Returns true if everything has been read and the read pointer cannot be advanced anymore. More...
 
void disableReset ()
 Disable the reset() call, e. More...
 
bool isResetDisabled ()
 
virtual const char * readPointer (qint64 maximumLength, qint64 &len)=0
 Return a byte pointer for at most maximumLength bytes of that device. More...
 
virtual bool reset ()=0
 Moves the internal read pointer back to the beginning. More...
 
virtual qint64 size ()=0
 Returns the size of the complete device or -1 if unknown. More...
 
virtual ~QNonContiguousByteDevice ()
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool event (QEvent *)
 This virtual function receives events to an object and should return true if the event e was recognized and processed. More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) 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. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
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. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 

Protected Functions

 QNonContiguousByteDevice ()
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *)
 This event handler can be reimplemented in a subclass to receive timer events for the object. More...
 

Protected Variables

bool resetDisabled
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

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

Since
4.6
Attention
Module: QtCore

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
Warning
This function is not part of the public interface.

Definition at line 65 of file qnoncontiguousbytedevice_p.h.

Constructors and Destructors

◆ ~QNonContiguousByteDevice()

QNonContiguousByteDevice::~QNonContiguousByteDevice ( )
virtual

Definition at line 165 of file qnoncontiguousbytedevice.cpp.

166 {
167 }

◆ QNonContiguousByteDevice()

QNonContiguousByteDevice::QNonContiguousByteDevice ( )
protected

Definition at line 161 of file qnoncontiguousbytedevice.cpp.

161  : QObject((QObject*)0), resetDisabled(false)
162 {
163 }
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
Q_INVOKABLE QObject(QObject *parent=0)
Constructs an object with parent object parent.
Definition: qobject.cpp:753

Functions

◆ advanceReadPointer()

bool QNonContiguousByteDevice::advanceReadPointer ( qint64  amount)
pure virtual

◆ atEnd()

bool QNonContiguousByteDevice::atEnd ( )
pure virtual

◆ disableReset()

void QNonContiguousByteDevice::disableReset ( )

Disable the reset() call, e.

g. it will always do nothing and return false.

See also
reset()
Warning
This function is not part of the public interface.

Definition at line 169 of file qnoncontiguousbytedevice.cpp.

Referenced by QNetworkAccessHttpBackend::postRequest().

170 {
171  resetDisabled = true;
172 }

◆ isResetDisabled()

bool QNonContiguousByteDevice::isResetDisabled ( )
inline

◆ 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.

See also
atEnd()
Warning
This function is not part of the public interface.

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

Referenced by QByteDeviceWrappingIoDevice::readData(), QHttpNetworkConnectionChannel::sendRequest(), QNetworkAccessFileBackend::uploadReadyReadSlot(), and QNetworkAccessHttpBackend::wantUploadDataSlot().

◆ readProgress

void QNonContiguousByteDevice::readProgress ( qint64  current,
qint64  total 
)
signal

◆ readyRead

void QNonContiguousByteDevice::readyRead ( )
signal

Emitted when there is data available.

Warning
This function is not part of the public interface.

Referenced by QNonContiguousByteDeviceBufferImpl::QNonContiguousByteDeviceBufferImpl(), and QNonContiguousByteDeviceIoDeviceImpl::QNonContiguousByteDeviceIoDeviceImpl().

◆ reset()

bool QNonContiguousByteDevice::reset ( )
pure virtual

◆ size()

qint64 QNonContiguousByteDevice::size ( )
pure virtual

Properties

◆ resetDisabled

bool QNonContiguousByteDevice::resetDisabled
protected

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