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

Detailed Description

Output file stream buffer.

Definition at line 108 of file JFileStreamBuffer.hh.

Member Typedef Documentation

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

Definition at line 115 of file JFileStreamBuffer.hh.

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

Definition at line 116 of file JFileStreamBuffer.hh.

Constructor & Destructor Documentation

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 125 of file JFileStreamBuffer.hh.

                                                             :
      out    (file)
    {
      // reserve one byte for overflow character

      resize(size);

      setp(this->data(), this->data() + this->size() - 1);
    }

virtual JLANG::JFileOutputStreamBuffer::~JFileOutputStreamBuffer ( )

inlinevirtual

Destructor.

Definition at line 140 of file JFileStreamBuffer.hh.

    {
      sync();
    }

Member Function Documentation

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 153 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;
    }

virtual int JLANG::JFileOutputStreamBuffer::sync ( )

inlineoverridevirtual

Synchronise buffer.

Definition at line 173 of file JFileStreamBuffer.hh.

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

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 189 of file JFileStreamBuffer.hh.

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

int JLANG::JFileOutputStreamBuffer::flush ( )

inlineprotected

Flush internal buffer.

Definition at line 198 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;
    }

Member Data Documentation

JFile JLANG::JFileOutputStreamBuffer::out

protected

Definition at line 215 of file JFileStreamBuffer.hh.

---

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

• JFileStreamBuffer.hh