JLANG::JFileOutputStreamBuffer Class Reference

Output file stream buffer. More...

#include <JFileStreamBuffer.hh>

Inheritance diagram for JLANG::JFileOutputStreamBuffer:

Public Types
typedef traits_type::int_type	int_type
typedef std::streamsize	streamsize

Public Member Functions
	JFileOutputStreamBuffer (const JAbstractFile &file, const std::size_t size=65536)
	Constructor. More...
virtual	~JFileOutputStreamBuffer ()
	Destructor. More...
virtual int_type	overflow (int_type c) override
	Check overflow. More...
virtual int	sync () override
	Synchronise buffer. More...
bool	out_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of output. More...

Protected Member Functions
int	flush ()
	Flush internal buffer. More...

Protected Attributes
JFile	out

Private Member Functions
	JFileOutputStreamBuffer (const JFileOutputStreamBuffer &)
	JFileOutputStreamBuffer (JFileOutputStreamBuffer &&)
JFileOutputStreamBuffer &	operator= (const JFileOutputStreamBuffer &)
JFileOutputStreamBuffer &	operator= (JFileOutputStreamBuffer &&)

Detailed Description

Output file stream buffer.

Definition at line 114 of file JFileStreamBuffer.hh.

Member Typedef Documentation

int_type

typedef traits_type::int_type JLANG::JFileOutputStreamBuffer::int_type

Definition at line 121 of file JFileStreamBuffer.hh.

streamsize

typedef std::streamsize JLANG::JFileOutputStreamBuffer::streamsize

Definition at line 122 of file JFileStreamBuffer.hh.

Constructor & Destructor Documentation

JFileOutputStreamBuffer() [1/3]

JLANG::JFileOutputStreamBuffer::JFileOutputStreamBuffer ( const JAbstractFile &  file, const std::size_t  size = 65536  )

inline

Constructor.

Parameters

file	file
size	size of internal buffer

Definition at line 131 of file JFileStreamBuffer.hh.

                                                             :
      out    (file)
    {
      // reserve one byte for overflow character
 
      resize(size);
 
      setp(this->data(), this->data() + this->size() - 1);
    }

~JFileOutputStreamBuffer()

virtual JLANG::JFileOutputStreamBuffer::~JFileOutputStreamBuffer ( )

inlinevirtual

Destructor.

Definition at line 146 of file JFileStreamBuffer.hh.

    {
      sync();
    }

JFileOutputStreamBuffer() [2/3]

JLANG::JFileOutputStreamBuffer::JFileOutputStreamBuffer ( const JFileOutputStreamBuffer &  )

private

JFileOutputStreamBuffer() [3/3]

JLANG::JFileOutputStreamBuffer::JFileOutputStreamBuffer ( JFileOutputStreamBuffer &&  )

private

Member Function Documentation

overflow()

virtual int_type JLANG::JFileOutputStreamBuffer::overflow ( int_type  c )

inlineoverridevirtual

Check overflow.

This method writes one byte if possible.

Parameters

c

character

Returns

c if OK; else EOF

Definition at line 159 of file JFileStreamBuffer.hh.

    {
      if (c != traits_type::eof()) {
 
        *pptr() = (char) c;
 
        pbump(1);
 
        if (flush() == traits_type::eof()) {
          return traits_type::eof();
        }
      }
 
      return c;
    }

sync()

virtual int JLANG::JFileOutputStreamBuffer::sync ( )

inlineoverridevirtual

Synchronise buffer.

Definition at line 179 of file JFileStreamBuffer.hh.

    {
      if (flush() == traits_type::eof())
        return -1;
      else
        return  0;
    }

out_avail()

bool JLANG::JFileOutputStreamBuffer::out_avail ( JTimeval  timeout = JTimeval::min() ) const

inline

Check availability of output.

This method returns true if at least one byte can be written without blocking.

Parameters

timeout

timeout

Returns

true if ready to write; else false

Definition at line 195 of file JFileStreamBuffer.hh.

    {
      return JFileDescriptorMask(out).out_avail(timeout);
    }

flush()

int JLANG::JFileOutputStreamBuffer::flush ( )

inlineprotected

Flush internal buffer.

Definition at line 204 of file JFileStreamBuffer.hh.

    {
      const int len = pptr() - pbase();
      
      if (len != 0) {
 
        if (out.write(this->data(), len) != len) {
          return traits_type::eof();
        }
 
        pbump(-len);
      }
 
      return len;
    }

operator=() [1/2]

JFileOutputStreamBuffer& JLANG::JFileOutputStreamBuffer::operator= ( const JFileOutputStreamBuffer &  )

private

operator=() [2/2]

JFileOutputStreamBuffer& JLANG::JFileOutputStreamBuffer::operator= ( JFileOutputStreamBuffer &&  )

private

Member Data Documentation

out

JFile JLANG::JFileOutputStreamBuffer::out

protected

Definition at line 221 of file JFileStreamBuffer.hh.

---

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

• JFileStreamBuffer.hh