KDECore
#include <k3bufferedsocket.h>

Protected Slots | |
virtual void | slotReadActivity () |
virtual void | slotWriteActivity () |
![]() | |
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) |
![]() | |
void | copyError () |
void | setState (SocketState state) |
![]() | |
virtual qint64 | readData (char *data, qint64 len) |
void | resetError () |
void | setError (SocketError error) |
virtual qint64 | writeData (const char *data, qint64 len) |
![]() | |
bool | hasDevice () const |
void | resetError () |
void | setError (SocketError error) |
virtual int | socketOptions () const |
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
◆ KBufferedSocket()
|
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.
◆ ~KBufferedSocket()
|
virtual |
Destructor.
Definition at line 61 of file k3bufferedsocket.cpp.
Member Function Documentation
◆ bytesAvailable()
|
virtual |
Make use of the buffers.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 99 of file k3bufferedsocket.cpp.
◆ bytesToWrite()
|
virtual |
Returns the length of the output buffer.
Definition at line 258 of file k3bufferedsocket.cpp.
◆ canReadLine()
|
virtual |
Returns true if a line can be read with readLine()
Definition at line 273 of file k3bufferedsocket.cpp.
◆ close()
|
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.
◆ closeNow()
|
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.
◆ enableRead()
Catch changes.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 183 of file k3bufferedsocket.cpp.
◆ enableWrite()
Catch changes.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 200 of file k3bufferedsocket.cpp.
◆ peekData()
|
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.
◆ readData()
|
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.
◆ readLineData()
Improve the readLine performance.
Definition at line 281 of file k3bufferedsocket.cpp.
◆ setInputBuffering()
Sets the use of input buffering.
Definition at line 230 of file k3bufferedsocket.cpp.
◆ setOutputBuffering()
Sets the use of output buffering.
Definition at line 244 of file k3bufferedsocket.cpp.
◆ setSocketDevice()
|
virtual |
Be sure to catch new devices.
Reimplemented from KNetwork::KActiveSocketBase.
Definition at line 69 of file k3bufferedsocket.cpp.
◆ setSocketOptions()
|
protectedvirtual |
Buffered sockets can only operate in non-blocking mode.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 76 of file k3bufferedsocket.cpp.
◆ slotReadActivity
|
protectedvirtualslot |
Slot called when there's read activity.
Definition at line 296 of file k3bufferedsocket.cpp.
◆ slotWriteActivity
|
protectedvirtualslot |
Slot called when there's write activity.
Definition at line 343 of file k3bufferedsocket.cpp.
◆ stateChanging()
|
protectedvirtual |
Catch connection to clear the buffers.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 212 of file k3bufferedsocket.cpp.
◆ waitForConnect()
void KBufferedSocket::waitForConnect | ( | ) |
Blocks until the connection is either established, or completely failed.
Definition at line 286 of file k3bufferedsocket.cpp.
◆ waitForMore()
Make use of buffers.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 107 of file k3bufferedsocket.cpp.
◆ writeData()
|
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-2023 The KDE developers.
Generated on Thu Jul 20 2023 00:00:00 by doxygen 1.9.8 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.