• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

Public Member Functions | List of all members
KIOBufferBase Class Referenceabstract

#include <kiobuffer.h>

Public Member Functions

 KIOBufferBase ()
 
 KIOBufferBase (const KIOBufferBase &)
 
virtual ~KIOBufferBase ()
 
KIOBufferBase & operator= (const KIOBufferBase &)
 
virtual bool canReadLine () const =0
 
virtual TQCString readLine ()=0
 
virtual TQ_LONG length () const =0
 
bool isEmpty () const
 
virtual TQ_LONG size () const =0
 
bool isFull () const
 
virtual bool setSize (TQ_LONG size)=0
 
virtual TQ_LONG feedBuffer (const char *data, TQ_LONG len)=0
 
virtual TQ_LONG consumeBuffer (char *data, TQ_LONG maxlen, bool discard=true)=0
 
virtual void clear ()=0
 

Detailed Description

base for I/O buffer implementation

This class declares the base methods to interface with an I/O buffer. Most applications will not need to access this class directly, since it is all handled by KNetwork::KBufferedSocket and other buffering classes.

Author
Thiago Macieira thiag.nosp@m.o.ma.nosp@m.cieir.nosp@m.a@kd.nosp@m.email.nosp@m..net

Definition at line 45 of file kiobuffer.h.

Constructor & Destructor Documentation

◆ KIOBufferBase() [1/2]

KIOBufferBase::KIOBufferBase ( )
inline

Default constructor.

Does nothing.

Definition at line 51 of file kiobuffer.h.

◆ KIOBufferBase() [2/2]

KIOBufferBase::KIOBufferBase ( const KIOBufferBase &  )
inline

Copy constructor.

Does nothing here.

Definition at line 57 of file kiobuffer.h.

◆ ~KIOBufferBase()

virtual KIOBufferBase::~KIOBufferBase ( )
inlinevirtual

Virtual destructor.

Does nothing.

Definition at line 63 of file kiobuffer.h.

Member Function Documentation

◆ canReadLine()

virtual bool KIOBufferBase::canReadLine ( ) const
pure virtual

Returns true if a line can be read from the buffer.

◆ clear()

virtual void KIOBufferBase::clear ( )
pure virtual

Clears the buffer.

◆ consumeBuffer()

virtual TQ_LONG KIOBufferBase::consumeBuffer ( char *  data,
TQ_LONG  maxlen,
bool  discard = true 
)
pure virtual

Consumes data from the beginning of the buffer.

Parameters
datawhere to copy the data to
maxlenthe maximum length to copy, in bytes
discardif true, the bytes copied will be discarded
Returns
the number of bytes copied from the buffer

◆ feedBuffer()

virtual TQ_LONG KIOBufferBase::feedBuffer ( const char *  data,
TQ_LONG  len 
)
pure virtual

Adds data to the end of the buffer.

Parameters
datathe data to be added
lenthe data length, in bytes
Returns
the number of bytes added to the end of the buffer.

◆ isEmpty()

bool KIOBufferBase::isEmpty ( ) const
inline

Returns true if the buffer is empty of data.

Definition at line 93 of file kiobuffer.h.

◆ isFull()

bool KIOBufferBase::isFull ( ) const
inline

Returns true if the buffer is full (i.e., cannot receive more data)

Definition at line 107 of file kiobuffer.h.

◆ length()

virtual TQ_LONG KIOBufferBase::length ( ) const
pure virtual

Returns the number of bytes in the buffer.

Note that this is not the size of the buffer.

See also
size

◆ operator=()

KIOBufferBase& KIOBufferBase::operator= ( const KIOBufferBase &  )
inline

Assignment operator.

Does nothing.

Definition at line 69 of file kiobuffer.h.

◆ readLine()

virtual TQCString KIOBufferBase::readLine ( )
pure virtual

Reads a line from the buffer and discards it.

◆ setSize()

virtual bool KIOBufferBase::setSize ( TQ_LONG  size)
pure virtual

Sets the size of the buffer, if allowed.

Parameters
sizethe maximum size, use -1 for unlimited.
Returns
true on success, false if an error occurred.
Note
if the new size is less than length(), the buffer will be truncated

◆ size()

virtual TQ_LONG KIOBufferBase::size ( ) const
pure virtual

Retrieves the buffer size.

The value of -1 indicates that the buffer has no defined upper limit.

See also
length for the length of the data stored

The documentation for this class was generated from the following file:
  • kiobuffer.h

kdecore

Skip menu "kdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.8.13
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |