#include <kbufferedsocket.h>

Signals | |
void | bytesWritten (int bytes) |
Public Member Functions | |
TDEBufferedSocket (const TQString &node=TQString::null, const TQString &service=TQString::null, TQObject *parent=0L, const char *name=0L) | |
virtual | ~TDEBufferedSocket () |
virtual void | setSocketDevice (TDESocketDevice *device) |
virtual void | close () |
virtual TQ_LONG | waitForMore (int msecs, bool *timeout=0L) |
virtual TQT_TQIO_LONG | tqreadBlock (char *data, TQT_TQIO_ULONG maxlen) |
virtual TQT_TQIO_LONG | tqreadBlock (char *data, TQT_TQIO_ULONG maxlen, TDESocketAddress &from) |
virtual TQ_LONG | peekBlock (char *data, TQ_ULONG maxlen) |
virtual TQ_LONG | peekBlock (char *data, TQ_ULONG maxlen, TDESocketAddress &from) |
virtual TQT_TQIO_LONG | tqwriteBlock (const char *data, TQT_TQIO_ULONG len) |
virtual TQT_TQIO_LONG | tqwriteBlock (const char *data, TQT_TQIO_ULONG len, const TDESocketAddress &to) |
virtual void | enableRead (bool enable) |
virtual void | enableWrite (bool enable) |
void | setInputBuffering (bool enable) |
TDEIOBufferBase * | inputBuffer () |
void | setOutputBuffering (bool enable) |
TDEIOBufferBase * | outputBuffer () |
virtual void | closeNow () |
bool | canReadLine () const |
TQCString | readLine () |
void | waitForConnect () |
Protected Slots | |
virtual void | slotReadActivity () |
virtual void | slotWriteActivity () |
Protected Member Functions | |
virtual bool | setSocketOptions (int opts) |
virtual void | stateChanging (SocketState newState) |
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 TQSocketNotifier. If you want to use a socket in an auxiliary thread, please use KStreamSocket.
Definition at line 58 of file kbufferedsocket.h.
Constructor & Destructor Documentation
TDEBufferedSocket::TDEBufferedSocket | ( | const TQString & | node = TQString::null , |
const TQString & | service = TQString::null , |
||
TQObject * | parent = 0L , |
||
const char * | name = 0L |
||
) |
Default constructor.
- Parameters:
-
node destination host service destination service to connect to parent the parent object for this object name the internal name for this object
Definition at line 50 of file kbufferedsocket.cpp.
TDEBufferedSocket::~TDEBufferedSocket | ( | ) | [virtual] |
Destructor.
Definition at line 59 of file kbufferedsocket.cpp.
Member Function Documentation
void KNetwork::TDEBufferedSocket::bytesWritten | ( | int | bytes | ) | [signal] |
This signal is emitted whenever data is written.
bool KNetwork::TDEBufferedSocket::canReadLine | ( | ) | const |
Returns true if a line can be read with readLine.
void TDEBufferedSocket::close | ( | ) | [virtual] |
Closes the socket for new data, but allow data that had been buffered for output with writeBlock to be still be written.
- See also:
- closeNow
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 82 of file kbufferedsocket.cpp.
virtual void KNetwork::TDEBufferedSocket::closeNow | ( | ) | [virtual] |
Returns the length of the output buffer.
Closes the socket and discards any output data that had been buffered with writeBlock but that had not yet been written.
- See also:
- close
void TDEBufferedSocket::enableRead | ( | bool | enable | ) | [virtual] |
Catch changes.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 202 of file kbufferedsocket.cpp.
void TDEBufferedSocket::enableWrite | ( | bool | enable | ) | [virtual] |
Catch changes.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 219 of file kbufferedsocket.cpp.
Retrieves the input buffer object.
Definition at line 263 of file kbufferedsocket.cpp.
Retrieves the output buffer object.
Definition at line 282 of file kbufferedsocket.cpp.
TQ_LONG TDEBufferedSocket::peekBlock | ( | char * | data, |
TQ_ULONG | maxlen | ||
) | [virtual] |
Peeks data from the socket.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 143 of file kbufferedsocket.cpp.
TQ_LONG TDEBufferedSocket::peekBlock | ( | char * | data, |
TQ_ULONG | maxlen, | ||
TDESocketAddress & | from | ||
) | [virtual] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Peeks data from the socket.
The from
parameter is always set to peerAddress()
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 159 of file kbufferedsocket.cpp.
Reads a line of data from the socket buffers.
void TDEBufferedSocket::setInputBuffering | ( | bool | enable | ) |
Sets the use of input buffering.
Definition at line 249 of file kbufferedsocket.cpp.
void TDEBufferedSocket::setOutputBuffering | ( | bool | enable | ) |
Sets the use of output buffering.
Definition at line 268 of file kbufferedsocket.cpp.
void TDEBufferedSocket::setSocketDevice | ( | TDESocketDevice * | device | ) | [virtual] |
Be sure to catch new devices.
Definition at line 67 of file kbufferedsocket.cpp.
bool TDEBufferedSocket::setSocketOptions | ( | int | opts | ) | [protected, virtual] |
Buffered sockets can only operate in non-blocking mode.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 73 of file kbufferedsocket.cpp.
virtual void KNetwork::TDEBufferedSocket::slotReadActivity | ( | ) | [protected, virtual, slot] |
Slot called when there's read activity.
Reimplemented from KNetwork::KClientSocketBase.
virtual void KNetwork::TDEBufferedSocket::slotWriteActivity | ( | ) | [protected, virtual, slot] |
Slot called when there's write activity.
Reimplemented from KNetwork::KClientSocketBase.
void TDEBufferedSocket::stateChanging | ( | SocketState | newState | ) | [protected, virtual] |
Catch connection to clear the buffers.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 231 of file kbufferedsocket.cpp.
TQT_TQIO_LONG TDEBufferedSocket::tqreadBlock | ( | char * | data, |
TQT_TQIO_ULONG | maxlen | ||
) | [virtual] |
Reads data from the socket.
Make use of buffers.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 121 of file kbufferedsocket.cpp.
TQT_TQIO_LONG TDEBufferedSocket::tqreadBlock | ( | char * | data, |
TQT_TQIO_ULONG | maxlen, | ||
TDESocketAddress & | from | ||
) | [virtual] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Reads data from a socket.
The from
parameter is always set to peerAddress()
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 137 of file kbufferedsocket.cpp.
TQT_TQIO_LONG TDEBufferedSocket::tqwriteBlock | ( | const char * | data, |
TQT_TQIO_ULONG | len | ||
) | [virtual] |
Writes data to the socket.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 165 of file kbufferedsocket.cpp.
TQT_TQIO_LONG TDEBufferedSocket::tqwriteBlock | ( | const char * | data, |
TQT_TQIO_ULONG | len, | ||
const TDESocketAddress & | to | ||
) | [virtual] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Writes data to the socket.
The to
parameter is discarded.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 195 of file kbufferedsocket.cpp.
Blocks until the connection is either established, or completely failed.
TQ_LONG TDEBufferedSocket::waitForMore | ( | int | msecs, |
bool * | timeout = 0L |
||
) | [virtual] |
Make use of the buffers.
Make use of buffers.
Reimplemented from KNetwork::KClientSocketBase.
Definition at line 109 of file kbufferedsocket.cpp.
The documentation for this class was generated from the following files: