Buffered binary output. More...

#include <JBufferedIO.hh>

Inheritance diagram for JIO::JBufferedWriter:

Public Member Functions
	JBufferedWriter (JWriter *__out, const int __size=1048576)
	Constructor. More...

	~JBufferedWriter ()
	Destructor. More...

virtual bool	getStatus () const
	Status of writer. More...

virtual int	write (const char *zbuf, int n)
	Write byte array. More...

void	flush ()
	Write internal data to output. More...

JWriter &	operator<< (const JSerialisable &object)
	Write serialisable data object. More...

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 &	store (const JSerialisable &object)
	Write object. More...

template<class T >
JWriter &	store (const T &object)
	Write object. More...

	operator bool () const
	Type conversion operator. More...

bool	operator! () const
	Negated status of this object. More...

Protected Attributes
JLANG::JSinglePointer< JWriter >	out

char *	buffer
	internal buffer More...

int	size
	size of internal buffer More...

int	pos
	pointer to end of buffered data More...

Detailed Description

Buffered binary output.

This class implements the JWriter interface.

Definition at line 138 of file JBufferedIO.hh.

Constructor & Destructor Documentation

◆ JBufferedWriter()

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 149 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 162 of file JBufferedIO.hh.

     {
       flush();
  
       delete [] buffer;
     }

Member Function Documentation

◆ getStatus()

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

inlinevirtual

Status of writer.

Returns: status of this writer

Implements JLANG::JAbstractObjectStatus.

Definition at line 175 of file JBufferedIO.hh.

     { 
       return (bool) *out;
     }

◆ write()

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

inlinevirtual

Write byte array.

Parameters

zbuf	pointer to byte array
n	number of bytes

Returns: number of bytes

Implements JLANG::JBinaryOutput.

Definition at line 188 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 216 of file JBufferedIO.hh.

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

◆ operator<<() [1/15]

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

inlineinherited

Write serialisable data object.

Parameters

object serialisable data object

Returns: JWriter

Definition at line 142 of file JSerialisable.hh.

     { 
       return object.write(*this); 
     }

◆ operator<<() [2/15]

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

inlineinherited

Definition at line 148 of file JSerialisable.hh.

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

◆ operator<<() [3/15]

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

inlineinherited

Definition at line 149 of file JSerialisable.hh.

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

◆ operator<<() [4/15]

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

inlineinherited

Definition at line 150 of file JSerialisable.hh.

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

◆ operator<<() [5/15]

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

inlineinherited

Definition at line 151 of file JSerialisable.hh.

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

◆ operator<<() [6/15]

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

inlineinherited

Definition at line 152 of file JSerialisable.hh.

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

◆ operator<<() [7/15]

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

inlineinherited

Definition at line 153 of file JSerialisable.hh.

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

◆ operator<<() [8/15]

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

inlineinherited

Definition at line 154 of file JSerialisable.hh.

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

◆ operator<<() [9/15]

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

inlineinherited

Definition at line 155 of file JSerialisable.hh.

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

◆ operator<<() [10/15]

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

inlineinherited

Definition at line 156 of file JSerialisable.hh.

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

◆ operator<<() [11/15]

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

inlineinherited

Definition at line 157 of file JSerialisable.hh.

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

◆ operator<<() [12/15]

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

inlineinherited

Definition at line 158 of file JSerialisable.hh.

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

◆ operator<<() [13/15]

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

inlineinherited

Definition at line 159 of file JSerialisable.hh.

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

◆ operator<<() [14/15]

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

inlineinherited

Definition at line 160 of file JSerialisable.hh.

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

◆ operator<<() [15/15]

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

inlineinherited

Definition at line 161 of file JSerialisable.hh.

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

◆ store() [1/2]

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

inlineinherited

Write object.

Parameters

object object

Returns: this writer

Definition at line 170 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 183 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 223 of file JBufferedIO.hh.

◆ buffer

char* JIO::JBufferedWriter::buffer

protected

internal buffer

Definition at line 225 of file JBufferedIO.hh.

◆ size

int JIO::JBufferedWriter::size

protected

size of internal buffer

Definition at line 226 of file JBufferedIO.hh.

◆ pos

int JIO::JBufferedWriter::pos

protected

pointer to end of buffered data

Definition at line 227 of file JBufferedIO.hh.

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

JBufferedIO.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JBufferedWriter()

◆ ~JBufferedWriter()

Member Function Documentation

◆ getStatus()

◆ write()

◆ flush()

◆ operator<<() [1/15]

◆ operator<<() [2/15]

◆ operator<<() [3/15]

◆ operator<<() [4/15]

◆ operator<<() [5/15]

◆ operator<<() [6/15]

◆ operator<<() [7/15]

◆ operator<<() [8/15]

◆ operator<<() [9/15]

◆ operator<<() [10/15]

◆ operator<<() [11/15]

◆ operator<<() [12/15]

◆ operator<<() [13/15]

◆ operator<<() [14/15]

◆ operator<<() [15/15]

◆ store() [1/2]

◆ store() [2/2]

◆ operator bool()

◆ operator!()

Member Data Documentation

◆ out

◆ buffer

◆ size

◆ pos