KDECore
#include <k3bufferedsocket.h>
Public Member Functions | |
KBufferedSocket (const QString &node=QString(), const QString &service=QString(), QObject *parent=0L) | |
virtual | ~KBufferedSocket () |
virtual qint64 | bytesAvailable () const |
virtual qint64 | bytesToWrite () const |
virtual bool | canReadLine () const |
virtual void | close () |
virtual void | closeNow () |
virtual void | enableRead (bool enable) |
virtual void | enableWrite (bool enable) |
void | setInputBuffering (bool enable) |
void | setOutputBuffering (bool enable) |
virtual void | setSocketDevice (KSocketDevice *device) |
void | waitForConnect () |
virtual qint64 | waitForMore (int msecs, bool *timeout=0L) |
Public Member Functions inherited from KNetwork::KStreamSocket | |
KStreamSocket (const QString &node=QString(), const QString &service=QString(), QObject *parent=0L) | |
virtual | ~KStreamSocket () |
virtual bool | bind (const QString &node=QString(), const QString &service=QString()) |
virtual bool | bind (const KResolverEntry &entry) |
virtual bool | connect (const QString &node=QString(), const QString &service=QString(), OpenMode mode=ReadWrite) |
virtual bool | connect (const KResolverEntry &entry, OpenMode mode=ReadWrite) |
int | remainingTimeout () const |
void | setTimeout (int msecs) |
int | timeout () const |
Public Member Functions inherited from KNetwork::KClientSocketBase | |
KClientSocketBase (QObject *parent) | |
virtual | ~KClientSocketBase () |
virtual bool | disconnect () |
bool | emitsReadyRead () const |
bool | emitsReadyWrite () const |
virtual bool | flush () |
virtual KSocketAddress | localAddress () const |
KResolver & | localResolver () const |
const KResolverResults & | localResults () const |
virtual bool | lookup () |
virtual bool | open (OpenMode mode) |
virtual KSocketAddress | peerAddress () const |
KResolver & | peerResolver () const |
const KResolverResults & | peerResults () const |
void | setFamily (int families) |
void | setResolutionEnabled (bool enable) |
SocketState | state () const |
Public Member Functions inherited from KNetwork::KActiveSocketBase | |
KActiveSocketBase (QObject *parent) | |
virtual | ~KActiveSocketBase () |
virtual bool | atEnd () const |
QString | errorString () const |
virtual bool | isSequential () const |
qint64 | peek (char *data, qint64 maxlen) |
qint64 | peek (char *data, qint64 maxlen, KSocketAddress &from) |
virtual qint64 | pos () const |
qint64 | read (char *data, qint64 maxlen) |
QByteArray | read (qint64 len) |
qint64 | read (char *data, qint64 maxlen, KSocketAddress &from) |
virtual bool | seek (qint64) |
virtual qint64 | size () const |
void | ungetChar (char) |
qint64 | write (const char *data, qint64 len) |
qint64 | write (const QByteArray &data) |
qint64 | write (const char *data, qint64 len, const KSocketAddress &to) |
Public Member Functions inherited from QIODevice | |
QIODevice () | |
QIODevice (QObject *parent) | |
virtual | ~QIODevice () |
void | aboutToClose () |
Offset | at () const |
bool | at (Offset offset) |
void | bytesWritten (qint64 bytes) |
QString | errorString () const |
int | flags () const |
int | getch () |
bool | getChar (char *c) |
bool | isAsynchronous () const |
bool | isBuffered () const |
bool | isCombinedAccess () const |
bool | isDirectAccess () const |
bool | isInactive () const |
bool | isOpen () const |
bool | isRaw () const |
bool | isReadable () const |
bool | isSequentialAccess () const |
bool | isSynchronous () const |
bool | isTextModeEnabled () const |
bool | isTranslated () const |
bool | isWritable () const |
int | mode () const |
virtual bool | open (QFlags< QIODevice::OpenModeFlag > mode) |
OpenMode | openMode () const |
qint64 | peek (char *data, qint64 maxSize) |
QByteArray | peek (qint64 maxSize) |
int | putch (int ch) |
bool | putChar (char c) |
qint64 | read (char *data, qint64 maxSize) |
QByteArray | read (qint64 maxSize) |
QByteArray | readAll () |
qint64 | readBlock (char *data, quint64 size) |
void | readChannelFinished () |
QByteArray | readLine (qint64 maxSize) |
qint64 | readLine (char *data, qint64 maxSize) |
void | readyRead () |
virtual bool | reset () |
void | resetStatus () |
void | setTextModeEnabled (bool enabled) |
int | state () const |
Status | status () const |
int | ungetch (int ch) |
void | ungetChar (char c) |
virtual bool | waitForBytesWritten (int msecs) |
virtual bool | waitForReadyRead (int msecs) |
qint64 | write (const char *data) |
qint64 | write (const char *data, qint64 maxSize) |
qint64 | write (const QByteArray &byteArray) |
qint64 | writeBlock (const QByteArray &data) |
qint64 | writeBlock (const char *data, quint64 size) |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
virtual | ~QObject () |
bool | blockSignals (bool block) |
QObject * | child (const char *objName, const char *inheritsClass, bool recursiveSearch) const |
const QObjectList & | children () const |
const char * | className () const |
bool | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const QObject *receiver, const char *method) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
void | dumpObjectInfo () |
void | dumpObjectTree () |
QList< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) const |
QList< T > | findChildren (const QString &name) const |
bool | inherits (const char *className) const |
void | insertChild (QObject *object) |
void | installEventFilter (QObject *filterObj) |
bool | isA (const char *className) const |
bool | isWidgetType () const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () const |
QVariant | property (const char *name) const |
void | removeChild (QObject *object) |
void | removeEventFilter (QObject *obj) |
void | setName (const char *name) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const |
int | startTimer (int interval) |
QThread * | thread () const |
Public Member Functions inherited from KNetwork::KSocketBase | |
KSocketBase () | |
virtual | ~KSocketBase () |
bool | addressReuseable () const |
bool | blocking () const |
bool | broadcast () const |
SocketError | error () const |
QString | errorString () const |
bool | isIPv6Only () const |
QMutex * | mutex () const |
bool | noDelay () const |
virtual bool | setAddressReuseable (bool enable) |
virtual bool | setBlocking (bool enable) |
virtual bool | setBroadcast (bool enable) |
virtual bool | setIPv6Only (bool enable) |
virtual bool | setNoDelay (bool enable) |
int | setRequestedCapabilities (int add, int remove=0) |
KSocketDevice * | socketDevice () const |
Protected Slots | |
virtual void | slotReadActivity () |
virtual void | slotWriteActivity () |
Protected Slots inherited from KNetwork::KClientSocketBase | |
virtual void | slotReadActivity () |
virtual void | slotWriteActivity () |
Protected Member Functions | |
virtual qint64 | peekData (char *data, qint64 maxlen, KSocketAddress *from) |
virtual qint64 | readData (char *data, qint64 maxlen, KSocketAddress *from) |
virtual qint64 | readLineData (char *data, qint64 maxSize) |
virtual bool | setSocketOptions (int opts) |
virtual void | stateChanging (SocketState newState) |
virtual qint64 | writeData (const char *data, qint64 len, const KSocketAddress *to) |
Protected Member Functions inherited from KNetwork::KClientSocketBase | |
void | copyError () |
void | setState (SocketState state) |
Protected Member Functions inherited from KNetwork::KActiveSocketBase | |
virtual qint64 | readData (char *data, qint64 len) |
void | resetError () |
void | setError (SocketError error) |
virtual qint64 | writeData (const char *data, qint64 len) |
Protected Member Functions inherited from QIODevice | |
virtual qint64 | readData (char *data, qint64 maxSize)=0 |
void | setErrorString (const QString &str) |
void | setOpenMode (QFlags< QIODevice::OpenModeFlag > openMode) |
virtual qint64 | writeData (const char *data, qint64 maxSize)=0 |
Protected Member Functions inherited from QObject | |
bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const char *signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const char *signal) |
int | receivers (const char *signal) const |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Protected Member Functions inherited from KNetwork::KSocketBase | |
bool | hasDevice () const |
void | resetError () |
void | setError (SocketError error) |
virtual int | socketOptions () const |
Additional Inherited Members | |
Public Types inherited from KNetwork::KClientSocketBase | |
enum | SocketState { Idle, HostLookup, HostFound, Bound, Connecting, Open, Closing, Unconnected = Bound, Connected = Open, Connection = Open } |
Public Types inherited from KNetwork::KSocketBase | |
enum | SocketError { NoError = 0, LookupFailure, AddressInUse, AlreadyCreated, AlreadyBound, AlreadyConnected, NotConnected, NotBound, NotCreated, WouldBlock, ConnectionRefused, ConnectionTimedOut, InProgress, NetFailure, NotSupported, Timeout, UnknownError, RemotelyDisconnected } |
enum | SocketOptions { Blocking = 0x01, AddressReuseable = 0x02, IPv6Only = 0x04, Keepalive = 0x08, Broadcast = 0x10, NoDelay = 0x20 } |
Signals inherited from KNetwork::KStreamSocket | |
void | timedOut () |
Signals inherited from KNetwork::KClientSocketBase | |
void | aboutToConnect (const KNetwork::KResolverEntry &remote, bool &skip) |
void | bound (const KNetwork::KResolverEntry &local) |
void | closed () |
void | connected (const KNetwork::KResolverEntry &remote) |
void | gotError (int code) |
void | hostFound () |
void | readyWrite () |
void | stateChanged (int newstate) |
Static Public Member Functions inherited from QObject | |
bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
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) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Static Public Member Functions inherited from KNetwork::KSocketBase | |
static QString | errorString (SocketError code) |
static bool | isFatalError (int code) |
Public Attributes inherited from QIODevice | |
typedef | Offset |
typedef | OpenMode |
typedef | Status |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Properties inherited from QObject | |
objectName | |
Detailed Description
Buffered stream sockets.
This class allows the user to create and operate buffered stream sockets such as those used in most Internet connections. This class is also the one that resembles the most to the old QSocket implementation.
Objects of this type operate only in non-blocking mode. A call to setBlocking(true) will result in an error.
- Note
- Buffered sockets only make sense if you're using them from the main (event-loop) thread. This is actually a restriction imposed by Qt's QSocketNotifier. If you want to use a socket in an auxiliary thread, please use KStreamSocket.
- Deprecated:
- Use KSocketFactory or KLocalSocket instead
Definition at line 58 of file k3bufferedsocket.h.
Constructor & Destructor Documentation
|
explicit |
Default constructor.
- Parameters
-
node destination host service destination service to connect to parent the parent object for this object
Definition at line 52 of file k3bufferedsocket.cpp.
|
virtual |
Destructor.
Definition at line 61 of file k3bufferedsocket.cpp.
Member Function Documentation
|
virtual |
Make use of the buffers.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 99 of file k3bufferedsocket.cpp.
|
virtual |
Returns the length of the output buffer.
Reimplemented from QIODevice.
Definition at line 258 of file k3bufferedsocket.cpp.
|
virtual |
Returns true if a line can be read with readLine()
Reimplemented from QIODevice.
Definition at line 273 of file k3bufferedsocket.cpp.
|
virtual |
Closes the socket for new data, but allow data that had been buffered for output with writeData() to be still be written.
- See also
- closeNow
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 85 of file k3bufferedsocket.cpp.
|
virtual |
Closes the socket and discards any output data that had been buffered with writeData() but that had not yet been written.
- See also
- close
Definition at line 266 of file k3bufferedsocket.cpp.
|
virtual |
Catch changes.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 183 of file k3bufferedsocket.cpp.
|
virtual |
Catch changes.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 200 of file k3bufferedsocket.cpp.
|
protectedvirtual |
Peeks data from the socket.
The from
parameter is always set to peerAddress()
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 135 of file k3bufferedsocket.cpp.
|
protectedvirtual |
Reads data from a socket.
The from
parameter is always set to peerAddress()
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 119 of file k3bufferedsocket.cpp.
Improve the readLine performance.
Reimplemented from QIODevice.
Definition at line 281 of file k3bufferedsocket.cpp.
void KBufferedSocket::setInputBuffering | ( | bool | enable | ) |
Sets the use of input buffering.
Definition at line 230 of file k3bufferedsocket.cpp.
void KBufferedSocket::setOutputBuffering | ( | bool | enable | ) |
Sets the use of output buffering.
Definition at line 244 of file k3bufferedsocket.cpp.
|
virtual |
Be sure to catch new devices.
Reimplemented from KNetwork::KActiveSocketBase.
Definition at line 69 of file k3bufferedsocket.cpp.
|
protectedvirtual |
Buffered sockets can only operate in non-blocking mode.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 76 of file k3bufferedsocket.cpp.
|
protectedvirtualslot |
Slot called when there's read activity.
Definition at line 296 of file k3bufferedsocket.cpp.
|
protectedvirtualslot |
Slot called when there's write activity.
Definition at line 343 of file k3bufferedsocket.cpp.
|
protectedvirtual |
Catch connection to clear the buffers.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 212 of file k3bufferedsocket.cpp.
void KBufferedSocket::waitForConnect | ( | ) |
Blocks until the connection is either established, or completely failed.
Definition at line 286 of file k3bufferedsocket.cpp.
Make use of buffers.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 107 of file k3bufferedsocket.cpp.
|
protectedvirtual |
Writes data to the socket.
The to
parameter is discarded.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 151 of file k3bufferedsocket.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:22:14 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.