provide ctors allowing to specify the non-default buffer size for buffered streams and wxStreamBuffer itself

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56583 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-10-29 16:42:45 +00:00
parent 187c2f81bc
commit f42c1512dd
3 changed files with 157 additions and 48 deletions

View File

@@ -60,12 +60,34 @@ class wxBufferedInputStream : public wxFilterInputStream
{
public:
/**
Constructor.
If a non @NULL buffer is given to the stream, it will be deleted by it.
Constructor using the provided buffer or default.
@param stream
The associated low-level stream.
@param buffer
The buffer to use if non-@NULL. Notice that the ownership of this
buffer is taken by the stream, i.e. it will delete it. If this
parameter is @NULL a default 1KB buffer is used.
*/
wxBufferedInputStream(wxInputStream& stream,
wxStreamBuffer *buffer = NULL);
/**
Constructor allowing to specify the size of the buffer.
This is just a more convenient alternative to creating a wxStreamBuffer
of the given size and using the other overloaded constructor of this
class.
@param stream
The associated low-level stream.
@param bufsize
The size of the buffer, in bytes.
@since 2.9.0
*/
wxBufferedInputStream(wxInputStream& stream, size_t bufsize);
/**
Destructor.
*/
@@ -112,6 +134,26 @@ public:
*/
wxStreamBuffer(wxStreamBase& stream, BufMode mode);
/**
Constructor for an input buffer of the specified size.
Using it is equivalent to using the constructor above with read mode
and calling SetBufferIO() but is more convenient.
@since 2.9.0
*/
wxStreamBuffer(wxInputStream& stream, size_t bufsize);
/**
Constructor for an output buffer of the specified size.
Using it is equivalent to using the constructor above with write mode
and calling SetBufferIO() but is more convenient.
@since 2.9.0
*/
wxStreamBuffer(wxOutputStream& stream, size_t bufsize);
/**
Constructor; creates a new empty stream buffer which won't flush any data
to a stream. mode specifies the type of the buffer (read, write, read_write).
@@ -130,7 +172,7 @@ public:
wxStreamBuffer(BufMode mode);
/**
Constructor.
Copy constructor.
This method initializes the stream buffer with the data of the specified
stream buffer. The new stream buffer has the same attributes, size, position
@@ -670,10 +712,34 @@ class wxBufferedOutputStream : public wxFilterOutputStream
{
public:
/**
@todo WRITE DESCRIPTION
Constructor using the provided buffer or default.
@param stream
The associated low-level stream.
@param buffer
The buffer to use if non-@NULL. Notice that the ownership of this
buffer is taken by the stream, i.e. it will delete it. If this
parameter is @NULL a default 1KB buffer is used.
*/
wxBufferedOutputStream(wxOutputStream& stream,
wxStreamBuffer *buffer = NULL);
/**
Constructor allowing to specify the size of the buffer.
This is just a more convenient alternative to creating a wxStreamBuffer
of the given size and using the other overloaded constructor of this
class.
@param stream
The associated low-level stream.
@param bufsize
The size of the buffer, in bytes.
@since 2.9.0
*/
wxBufferedOutputStream(wxOutputStream& stream, size_t bufsize);
/**
Destructor. Calls Sync() and destroys the internal buffer.
*/