tdecore
TDEIOBufferBase Class Reference
base for I/O buffer implementation More...
#include <tdeiobuffer.h>
Public Member Functions | |
TDEIOBufferBase () | |
TDEIOBufferBase (const TDEIOBufferBase &) | |
virtual | ~TDEIOBufferBase () |
TDEIOBufferBase & | operator= (const TDEIOBufferBase &) |
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::TDEBufferedSocket and other buffering classes.
Definition at line 45 of file tdeiobuffer.h.
Constructor & Destructor Documentation
TDEIOBufferBase::TDEIOBufferBase | ( | ) | [inline] |
TDEIOBufferBase::TDEIOBufferBase | ( | const TDEIOBufferBase & | ) | [inline] |
virtual TDEIOBufferBase::~TDEIOBufferBase | ( | ) | [inline, virtual] |
Member Function Documentation
virtual bool TDEIOBufferBase::canReadLine | ( | ) | const [pure virtual] |
Returns true if a line can be read from the buffer.
virtual void TDEIOBufferBase::clear | ( | ) | [pure virtual] |
Clears the buffer.
virtual TQ_LONG TDEIOBufferBase::consumeBuffer | ( | char * | data, | |
TQ_LONG | maxlen, | |||
bool | discard = true | |||
) | [pure virtual] |
Consumes data from the beginning of the buffer.
- Parameters:
-
data where to copy the data to maxlen the maximum length to copy, in bytes discard if true, the bytes copied will be discarded
- Returns:
- the number of bytes copied from the buffer
virtual TQ_LONG TDEIOBufferBase::feedBuffer | ( | const char * | data, | |
TQ_LONG | len | |||
) | [pure virtual] |
Adds data to the end of the buffer.
- Parameters:
-
data the data to be added len the data length, in bytes
- Returns:
- the number of bytes added to the end of the buffer.
bool TDEIOBufferBase::isEmpty | ( | ) | const [inline] |
Returns true if the buffer is empty of data.
Definition at line 93 of file tdeiobuffer.h.
bool TDEIOBufferBase::isFull | ( | ) | const [inline] |
Returns true if the buffer is full (i.e., cannot receive more data).
Definition at line 107 of file tdeiobuffer.h.
virtual TQ_LONG TDEIOBufferBase::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
TDEIOBufferBase& TDEIOBufferBase::operator= | ( | const TDEIOBufferBase & | ) | [inline] |
virtual TQCString TDEIOBufferBase::readLine | ( | ) | [pure virtual] |
Reads a line from the buffer and discards it.
virtual bool TDEIOBufferBase::setSize | ( | TQ_LONG | size | ) | [pure virtual] |
Sets the size of the buffer, if allowed.
- Parameters:
-
size the 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
virtual TQ_LONG TDEIOBufferBase::size | ( | ) | const [pure virtual] |
The documentation for this class was generated from the following file: