JLANG::JFileStreamBuffer Class Reference

Input and output file stream buffer. More...

#include <JFileStreamBuffer.hh>

Inheritance diagram for JLANG::JFileStreamBuffer:

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

Public Member Functions
	JFileStreamBuffer (const JAbstractFile &in, const JAbstractFile &out, const std::size_t size=65536, const std::size_t put_back=8)
	Constructor.
virtual int_type	underflow () override
	Check underflow.
bool	in_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of input.
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.

Protected Member Functions
int	flush ()
	Flush internal buffer.

Protected Attributes
JFile	in
std::size_t	memory
JFile	out

Detailed Description

Input and output file stream buffer.

Definition at line 235 of file JFileStreamBuffer.hh.

Member Typedef Documentation

int_type [1/2]

traits_type::int_type JLANG::JFileInputStreamBuffer::int_type

inherited

Definition at line 32 of file JFileStreamBuffer.hh.

int_type [2/2]

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

JFileStreamBuffer()

JLANG::JFileStreamBuffer::JFileStreamBuffer ( const JAbstractFile & in, const JAbstractFile & out, const std::size_t size = 65536, const std::size_t put_back = 8 )

inline

Constructor.

Parameters

in	input file
out	output file
size	size of internal buffer
put_back	number of put back characters

Definition at line 248 of file JFileStreamBuffer.hh.

                                                       :
      JFileInputStreamBuffer (in,  size, put_back),
      JFileOutputStreamBuffer(out, size)
    {}

Member Function Documentation

underflow()

virtual int_type JLANG::JFileInputStreamBuffer::underflow ( )

inlineoverridevirtualinherited

Check underflow.

This method reads as many bytes as possible.

Returns

first character if OK; else EOF

Definition at line 60 of file JFileStreamBuffer.hh.

    {   
      if (gptr() >= egptr()) {
 
        char* __begin = this->data();
 
        if (eback() == __begin) { 
          
          // push put back characters
 
          memmove(__begin, egptr() - memory, memory);
        
          __begin += memory;
        }
        
        const size_t len = in.read(__begin, this->size() - (__begin - this->data()));
        
        if (len != 0)
          setg(this->data(), __begin, __begin + len);
        else
          return traits_type::eof();
      }
        
      return *gptr();
    } 

in_avail()

bool JLANG::JFileInputStreamBuffer::in_avail ( JTimeval timeout = JTimeval::min() ) const

inlineinherited

Check availability of input.

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

Parameters

timeout

timeout

Returns

true if ready to read; else false

Definition at line 94 of file JFileStreamBuffer.hh.

    {
      return JFileDescriptorMask(in).in_avail(timeout);
    }

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

in

JFile JLANG::JFileInputStreamBuffer::in

protectedinherited

Definition at line 100 of file JFileStreamBuffer.hh.

memory

std::size_t JLANG::JFileInputStreamBuffer::memory

protectedinherited

Definition at line 101 of file JFileStreamBuffer.hh.

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:

• JFileStreamBuffer.hh