KNetwork::KBufferedSocket Class Reference

#include <k3bufferedsocket.h>

Inheritance diagram for KNetwork::KBufferedSocket:

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 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 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 KNetwork::KSocketBase
static QString	errorString (SocketError code)
static bool	isFatalError (int code)

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.

See also

KNetwork::KStreamSocket, KNetwork::KServerSocket

Author

Thiago Macieira thiag.nosp@m.o@kd.nosp@m.e.org

Deprecated:

Use KSocketFactory or KLocalSocket instead

Definition at line 58 of file k3bufferedsocket.h.

Constructor & Destructor Documentation

KBufferedSocket::KBufferedSocket ( const QString &  node = QString(), const QString &  service = QString(), QObject *  parent = 0L  )

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::~KBufferedSocket ( )

virtual

Destructor.

Definition at line 61 of file k3bufferedsocket.cpp.

Member Function Documentation

qint64 KBufferedSocket::bytesAvailable ( ) const

virtual

Make use of the buffers.

Reimplemented from KNetwork::KClientSocketBase.

Definition at line 99 of file k3bufferedsocket.cpp.

qint64 KBufferedSocket::bytesToWrite ( ) const

virtual

Returns the length of the output buffer.

Definition at line 258 of file k3bufferedsocket.cpp.

bool KBufferedSocket::canReadLine ( ) const

virtual

Returns true if a line can be read with readLine()

Definition at line 273 of file k3bufferedsocket.cpp.

void KBufferedSocket::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.

void KBufferedSocket::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.

void KBufferedSocket::enableRead ( bool  enable )

virtual

Catch changes.

Reimplemented from KNetwork::KClientSocketBase.

Definition at line 183 of file k3bufferedsocket.cpp.

void KBufferedSocket::enableWrite ( bool  enable )

virtual

Catch changes.

Reimplemented from KNetwork::KClientSocketBase.

Definition at line 200 of file k3bufferedsocket.cpp.

qint64 KBufferedSocket::peekData ( char *  data, qint64  maxlen, KSocketAddress *  from  )

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.

qint64 KBufferedSocket::readData ( char *  data, qint64  maxlen, KSocketAddress *  from  )

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.

qint64 KBufferedSocket::readLineData ( char *  data, qint64  maxSize  )

protectedvirtual

Improve the readLine performance.

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.

void KBufferedSocket::setSocketDevice ( KSocketDevice *  device )

virtual

Be sure to catch new devices.

Reimplemented from KNetwork::KActiveSocketBase.

Definition at line 69 of file k3bufferedsocket.cpp.

bool KBufferedSocket::setSocketOptions ( int  opts )

protectedvirtual

Buffered sockets can only operate in non-blocking mode.

Reimplemented from KNetwork::KClientSocketBase.

Definition at line 76 of file k3bufferedsocket.cpp.

void KBufferedSocket::slotReadActivity ( )

protectedvirtualslot

Slot called when there's read activity.

Definition at line 296 of file k3bufferedsocket.cpp.

void KBufferedSocket::slotWriteActivity ( )

protectedvirtualslot

Slot called when there's write activity.

Definition at line 343 of file k3bufferedsocket.cpp.

void KBufferedSocket::stateChanging ( SocketState  newState )

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.

qint64 KBufferedSocket::waitForMore ( int  msecs, bool *  timeout = 0L  )

virtual

Make use of buffers.

Reimplemented from KNetwork::KClientSocketBase.

Definition at line 107 of file k3bufferedsocket.cpp.

qint64 KBufferedSocket::writeData ( const char *  data, qint64  len, const KSocketAddress *  to  )

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:

• k3bufferedsocket.h
• k3bufferedsocket.cpp