JLANG::JFileOutputStream Class Reference

Streaming of output. More...

#include <JFileStream.hh>

Inheritance diagram for JLANG::JFileOutputStream:

Public Member Functions
	JFileOutputStream (const JAbstractFile &file, const std::size_t size=65536)
	Constructor.

Protected Types
typedef traits_type::int_type	int_type
typedef std::streamsize	streamsize

Protected Member Functions
virtual int_type	overflow (int_type c) override
	Check overflow.
virtual int	sync () override
	Synchronise buffer.
bool	out_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of output.
int	flush ()
	Flush internal buffer.

Protected Attributes
JFile	out

Detailed Description

Streaming of output.

Definition at line 46 of file JFileStream.hh.

Member Typedef Documentation

int_type

traits_type::int_type JLANG::JFileOutputStreamBuffer::int_type

inherited

Definition at line 121 of file JFileStreamBuffer.hh.

streamsize

std::streamsize JLANG::JFileOutputStreamBuffer::streamsize

inherited

Definition at line 122 of file JFileStreamBuffer.hh.

Constructor & Destructor Documentation

JFileOutputStream()

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

inline

Constructor.

Parameters

file	file
size	size of internal buffer

Definition at line 57 of file JFileStream.hh.

                                                       :
      JFileOutputStreamBuffer(file, size),
      std::ostream(this)
    {}

Member Function Documentation

overflow()

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

inlineoverridevirtualinherited

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 ( )

inlineoverridevirtualinherited

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

inlineinherited

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 ( )

inlineprotectedinherited

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

Member Data Documentation

out

JFile JLANG::JFileOutputStreamBuffer::out

protectedinherited

Definition at line 221 of file JFileStreamBuffer.hh.

---

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

• JFileStream.hh