JIO::JBufferedWriter Class Reference

Buffered binary output. More...

#include <JBufferedIO.hh>

Inheritance diagram for JIO::JBufferedWriter:

Public Member Functions
	JBufferedWriter (JWriter *__out, const int __size=1048576)
	Constructor.
	~JBufferedWriter ()
	Destructor.
virtual bool	getStatus () const override
	Status of writer.
virtual int	write (const char *zbuf, int n) override
	Write byte array.
void	flush ()
	Write internal data to output.
JWriter &	operator<< (const JSerialisable &object)
	Write serialisable data object.
JWriter &	operator<< (const bool value)
JWriter &	operator<< (const char value)
JWriter &	operator<< (const unsigned char value)
JWriter &	operator<< (const short value)
JWriter &	operator<< (const unsigned short value)
JWriter &	operator<< (const int value)
JWriter &	operator<< (const unsigned int value)
JWriter &	operator<< (const long int value)
JWriter &	operator<< (const unsigned long int value)
JWriter &	operator<< (const long long int value)
JWriter &	operator<< (const unsigned long long int value)
JWriter &	operator<< (const float value)
JWriter &	operator<< (const double value)
JWriter &	operator<< (const long double value)
JWriter &	operator<< (const JLANG::JObjectID &value)
JWriter &	operator<< (const JLANG::JStatus &value)
JWriter &	store (const JSerialisable &object)
	Write object.
template<class T >
JWriter &	store (const T &object)
	Write object.
	operator bool () const
	Type conversion operator.
bool	operator! () const
	Negated status of this object.

Protected Attributes
JLANG::JSinglePointer< JWriter >	out
char *	buffer
	internal buffer
int	size
	size of internal buffer
int	pos
	pointer to end of buffered data

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

Detailed Description

Buffered binary output.

This class implements the JWriter interface.

Definition at line 151 of file JBufferedIO.hh.

Constructor & Destructor Documentation

JBufferedWriter() [1/3]

JIO::JBufferedWriter::JBufferedWriter ( JWriter * __out, const int __size = 1048576 )

inline

Constructor.

Note that this object owns the writer pointed to.

Parameters

__out	pointer to writer
__size	size of internal buffer

Definition at line 162 of file JBufferedIO.hh.

                                                                :
      out(__out)
    {
      size   = std::max(__size, 1024);
      buffer = new char[size];
 
      pos = 0;
    }

~JBufferedWriter()

JIO::JBufferedWriter::~JBufferedWriter ( )

inline

Destructor.

Definition at line 175 of file JBufferedIO.hh.

    {
      flush();
 
      delete [] buffer;
    }

JBufferedWriter() [2/3]

JIO::JBufferedWriter::JBufferedWriter ( const JBufferedWriter & )

private

JBufferedWriter() [3/3]

JIO::JBufferedWriter::JBufferedWriter ( JBufferedWriter && )

private

Member Function Documentation

getStatus()

virtual bool JIO::JBufferedWriter::getStatus ( ) const

inlineoverridevirtual

Status of writer.

Returns

status of this writer

Implements JLANG::JAbstractObjectStatus.

Definition at line 188 of file JBufferedIO.hh.

    { 
      return (bool) *out;
    }

write()

virtual int JIO::JBufferedWriter::write ( const char * zbuf, int n )

inlineoverridevirtual

Write byte array.

Parameters

zbuf	pointer to byte array
n	number of bytes

Returns

number of bytes

Implements JLANG::JBinaryOutput.

Definition at line 201 of file JBufferedIO.hh.

    { 
      for (int i = 0; i != n; ) {
 
        int m = n - i;
 
        if (m > size - pos) {
 
          flush();
        
          if (m > size - pos) {
            m = size - pos;
          }
        }
 
        memcpy(buffer + pos, zbuf + i, m);
        
        i   += m;
        pos += m;
      }
 
      return n;
    }

flush()

void JIO::JBufferedWriter::flush ( )

inline

Write internal data to output.

Definition at line 229 of file JBufferedIO.hh.

    {
      pos -= out->write(buffer, pos); 
    }

operator=() [1/2]

JBufferedWriter & JIO::JBufferedWriter::operator= ( const JBufferedWriter & )

private

operator=() [2/2]

JBufferedWriter & JIO::JBufferedWriter::operator= ( JBufferedWriter && )

private

operator<<() [1/17]

JWriter & JIO::JWriter::operator<< ( const JSerialisable & object )

inlineinherited

Write serialisable data object.

Parameters

object

serialisable data object

Returns

JWriter

Definition at line 146 of file JSerialisable.hh.

    { 
      return object.write(*this); 
    }

operator<<() [2/17]

JWriter & JIO::JWriter::operator<< ( const bool value )

inlineinherited

Definition at line 152 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(bool));                   return *this; }

operator<<() [3/17]

JWriter & JIO::JWriter::operator<< ( const char value )

inlineinherited

Definition at line 153 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(char));                   return *this; } 

operator<<() [4/17]

JWriter & JIO::JWriter::operator<< ( const unsigned char value )

inlineinherited

Definition at line 154 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned char));          return *this; }

operator<<() [5/17]

JWriter & JIO::JWriter::operator<< ( const short value )

inlineinherited

Definition at line 155 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(short));                  return *this; }

operator<<() [6/17]

JWriter & JIO::JWriter::operator<< ( const unsigned short value )

inlineinherited

Definition at line 156 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned short));         return *this; }

operator<<() [7/17]

JWriter & JIO::JWriter::operator<< ( const int value )

inlineinherited

Definition at line 157 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(int));                    return *this; }

operator<<() [8/17]

JWriter & JIO::JWriter::operator<< ( const unsigned int value )

inlineinherited

Definition at line 158 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned int));           return *this; }

operator<<() [9/17]

JWriter & JIO::JWriter::operator<< ( const long int value )

inlineinherited

Definition at line 159 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(long int));               return *this; }

operator<<() [10/17]

JWriter & JIO::JWriter::operator<< ( const unsigned long int value )

inlineinherited

Definition at line 160 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned long int));      return *this; }

operator<<() [11/17]

JWriter & JIO::JWriter::operator<< ( const long long int value )

inlineinherited

Definition at line 161 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(long long int));          return *this; }

operator<<() [12/17]

JWriter & JIO::JWriter::operator<< ( const unsigned long long int value )

inlineinherited

Definition at line 162 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(unsigned long long int)); return *this; }

operator<<() [13/17]

JWriter & JIO::JWriter::operator<< ( const float value )

inlineinherited

Definition at line 163 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(float));                  return *this; }

operator<<() [14/17]

JWriter & JIO::JWriter::operator<< ( const double value )

inlineinherited

Definition at line 164 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(double));                 return *this; }

operator<<() [15/17]

JWriter & JIO::JWriter::operator<< ( const long double value )

inlineinherited

Definition at line 165 of file JSerialisable.hh.

{ write((const char*) &value, sizeof(long double));            return *this; }

operator<<() [16/17]

JWriter & JIO::JWriter::operator<< ( const JLANG::JObjectID & value )

inlineinherited

Definition at line 166 of file JSerialisable.hh.

{ return (*this) << value.getID(); }

operator<<() [17/17]

JWriter & JIO::JWriter::operator<< ( const JLANG::JStatus & value )

inlineinherited

Definition at line 167 of file JSerialisable.hh.

{ return (*this) << value.getStatus<JLANG::JStatus::status_type>(); }

store() [1/2]

JWriter & JIO::JWriter::store ( const JSerialisable & object )

inlineinherited

Write object.

Parameters

object

object

Returns

this writer

Definition at line 176 of file JSerialisable.hh.

    {
      return object.write(*this);
    }

store() [2/2]

template<class T >

JWriter & JIO::JWriter::store ( const T & object )

inlineinherited

Write object.

Parameters

object

object

Returns

this writer

Definition at line 189 of file JSerialisable.hh.

    {
      return *this << object;
    }

operator bool()

JLANG::JAbstractObjectStatus::operator bool ( ) const

inlineinherited

Type conversion operator.

Returns

status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

    {
      return this->getStatus();
    }

operator!()

bool JLANG::JAbstractObjectStatus::operator! ( ) const

inlineinherited

Negated status of this object.

Returns

negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

    {
      return !(this->getStatus());
    }

Member Data Documentation

out

JLANG::JSinglePointer<JWriter> JIO::JBufferedWriter::out

protected

Definition at line 236 of file JBufferedIO.hh.

buffer

char* JIO::JBufferedWriter::buffer

protected

internal buffer

Definition at line 238 of file JBufferedIO.hh.

size

int JIO::JBufferedWriter::size

protected

size of internal buffer

Definition at line 239 of file JBufferedIO.hh.

pos

int JIO::JBufferedWriter::pos

protected

pointer to end of buffered data

Definition at line 240 of file JBufferedIO.hh.

---

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

• JBufferedIO.hh