Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::interprocess::basic_bufferbuf< CharT, CharTraits > Class Template Reference

A streambuf class that controls the transmission of elements to and from a basic_xbufferstream. More...

#include <bufferstream.hpp>

Inheritance diagram for boost::interprocess::basic_bufferbuf< CharT, CharTraits >:
Collaboration diagram for boost::interprocess::basic_bufferbuf< CharT, CharTraits >:

Public Types

typedef CharT char_type
 
typedef CharTraits::int_type int_type
 
typedef CharTraits::pos_type pos_type
 
typedef CharTraits::off_type off_type
 
typedef CharTraits traits_type
 
typedef std::basic_streambuf
< char_type, traits_type
base_t
 

Public Member Functions

 basic_bufferbuf (std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out)
 Constructor. More...
 
 basic_bufferbuf (CharT *buf, std::size_t length, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out)
 Constructor. More...
 
virtual ~basic_bufferbuf ()
 
std::pair< CharT *, std::size_t > buffer () const
 Returns the pointer and size of the internal buffer. More...
 
void buffer (CharT *buf, std::size_t length)
 Sets the underlying buffer to a new value Does not throw. More...
 

Protected Member Functions

virtual int_type underflow ()
 
virtual int_type pbackfail (int_type c=CharTraits::eof())
 
virtual int_type overflow (int_type c=CharTraits::eof())
 
virtual pos_type seekoff (off_type off, std::ios_base::seekdir dir, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out)
 
virtual pos_type seekpos (pos_type pos, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out)
 

Detailed Description

template<class CharT, class CharTraits>
class boost::interprocess::basic_bufferbuf< CharT, CharTraits >

A streambuf class that controls the transmission of elements to and from a basic_xbufferstream.

The elements are transmitted from a to a fixed size buffer

Member Typedef Documentation

template<class CharT , class CharTraits >
typedef std::basic_streambuf<char_type, traits_type> boost::interprocess::basic_bufferbuf< CharT, CharTraits >::base_t
template<class CharT , class CharTraits >
typedef CharT boost::interprocess::basic_bufferbuf< CharT, CharTraits >::char_type
template<class CharT , class CharTraits >
typedef CharTraits::int_type boost::interprocess::basic_bufferbuf< CharT, CharTraits >::int_type
template<class CharT , class CharTraits >
typedef CharTraits::off_type boost::interprocess::basic_bufferbuf< CharT, CharTraits >::off_type
template<class CharT , class CharTraits >
typedef CharTraits::pos_type boost::interprocess::basic_bufferbuf< CharT, CharTraits >::pos_type
template<class CharT , class CharTraits >
typedef CharTraits boost::interprocess::basic_bufferbuf< CharT, CharTraits >::traits_type

Constructor & Destructor Documentation

template<class CharT , class CharTraits >
boost::interprocess::basic_bufferbuf< CharT, CharTraits >::basic_bufferbuf ( std::ios_base::openmode  mode = std::ios_base::in | std::ios_base::out)
inlineexplicit

Constructor.

Does not throw.

template<class CharT , class CharTraits >
boost::interprocess::basic_bufferbuf< CharT, CharTraits >::basic_bufferbuf ( CharT *  buf,
std::size_t  length,
std::ios_base::openmode  mode = std::ios_base::in | std::ios_base::out 
)
inlineexplicit

Constructor.

Assigns formatting buffer. Does not throw.

template<class CharT , class CharTraits >
virtual boost::interprocess::basic_bufferbuf< CharT, CharTraits >::~basic_bufferbuf ( )
inlinevirtual

Member Function Documentation

template<class CharT , class CharTraits >
std::pair<CharT *, std::size_t> boost::interprocess::basic_bufferbuf< CharT, CharTraits >::buffer ( ) const
inline
template<class CharT , class CharTraits >
void boost::interprocess::basic_bufferbuf< CharT, CharTraits >::buffer ( CharT *  buf,
std::size_t  length 
)
inline

Sets the underlying buffer to a new value Does not throw.

template<class CharT , class CharTraits >
virtual int_type boost::interprocess::basic_bufferbuf< CharT, CharTraits >::overflow ( int_type  c = CharTraits::eof())
inlineprotectedvirtual
template<class CharT , class CharTraits >
virtual int_type boost::interprocess::basic_bufferbuf< CharT, CharTraits >::pbackfail ( int_type  c = CharTraits::eof())
inlineprotectedvirtual
template<class CharT , class CharTraits >
virtual pos_type boost::interprocess::basic_bufferbuf< CharT, CharTraits >::seekoff ( off_type  off,
std::ios_base::seekdir  dir,
std::ios_base::openmode  mode = std::ios_base::in | std::ios_base::out 
)
inlineprotectedvirtual
template<class CharT , class CharTraits >
virtual pos_type boost::interprocess::basic_bufferbuf< CharT, CharTraits >::seekpos ( pos_type  pos,
std::ios_base::openmode  mode = std::ios_base::in | std::ios_base::out 
)
inlineprotectedvirtual
template<class CharT , class CharTraits >
virtual int_type boost::interprocess::basic_bufferbuf< CharT, CharTraits >::underflow ( )
inlineprotectedvirtual

The documentation for this class was generated from the following files: