Namespaces
Variants
Views
Actions

std::strstreambuf::freeze

From cppreference.com
< cpp‎ | io‎ | strstreambuf
Revision as of 11:11, 28 August 2013 by Cubbi (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
void freeze(bool freezefl = true);

If the buffer uses dynamic allocation, sets the frozen status of the stream to freezefl.

While the stream is frozen, overflow() will not reallocate the buffer and the destructor will not deallocate the buffer (thereby causing a memory leak).

Contents

[edit] Parameters

freezefl - new value to set the freeze status to


[edit] Return value

(none)

[edit] Notes

Every call to str() freezes the stream to preserve the validity of the pointer it returns. To allow the destructor to deallocate the buffer, freeze(false) needs to be called explicitly.

[edit] Example

in this example, initial allocation of the underlying array was for 16 bytes

#include <strstream>
#include <iostream>
 
int main()
{
    {
        std::strstream dyn; // dynamically-allocated read/write buffer
        dyn << "Test: " << 1.23;
        std::cout << "dynamic buffer holds "
                  << dyn.pcount() << " characters: '" << dyn.str() << "'\n";
        // the buffer is now frozen, further output will not make the buffer grow
        dyn << "more output, hopefully enough to run out of the allocated space";
        std::cout << "After more output, it holds "
                  << dyn.pcount() << " characters: '" << dyn.str() << "'\n";
        dyn.freeze(false); // unfreeze before destructor
    } // memory freed by the destructor
 
    {
        char arr[20];
        std::ostrstream st(arr, sizeof arr); // fixed-size buffer
        st << 1.23;
        std::cout << "static buffer holds "
                  << st.pcount() << " characters: '";
        std::cout.write(st.str(), st.pcount());
        std::cout << "'\n";
        st << "more output, hopefully enough to run out of the allocated space";
        std::cout << "static buffer holds "
                  << st.pcount() << " characters: '";
        std::cout.write(st.str(), st.pcount());
        std::cout << "'\n";
    } // nothing to deallocate, no need to unfreeze,
}

Output:

dynamic buffer holds 10 characters: 'Test: 1.23'
After more output, it holds 16 characters: 'Test: 1.23more o'
static buffer holds 4 characters: '1.23'
static buffer holds 20 characters: '1.23more output, hop'

[edit] See also

disables/enables automatic reallocation
(public member function of std::strstream) [edit]
disables/enables automatic reallocation
(public member function of std::ostrstream) [edit]
[virtual]
destructs a strstreambuf object, optionally deallocating the character array
(virtual public member function) [edit]
[virtual]
appends a character to the output sequence, may reallocate or initially allocate the buffer if dynamic and not frozen
(virtual protected member function) [edit]